LukeParke/plexjs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexjs.git synced 2025-12-06 04:20:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.665.0

Browse Source
This commit is contained in:
speakeasybot
2025-12-01 01:50:09 +00:00
parent 956c980d8b
commit 4f27055ae6
1985 changed files with 24972 additions and 34528 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2649
.speakeasy/gen.lock
View File

File diff suppressed because one or more lines are too long

6
.speakeasy/gen.yaml
View File

@@ -25,7 +25,7 @@ generation:
generateNewTests: true
skipResponseBodyAssertions: false
typescript:
version: 0.44.0
version: 0.44.1
acceptHeaderEnum: true
additionalDependencies:
dependencies: {}
@@ -40,7 +40,7 @@ typescript:
constFieldsAlwaysOptional: true
defaultErrorName: SDKError
enableCustomCodeRegions: false
enableMCPServer: true
enableMCPServer: false
enableReactQuery: false
enumFormat: enum
exportZodModelNamespace: false
@@ -48,7 +48,7 @@ typescript:
flatteningOrder: body-first
formStringArrayEncodeMode: encoded-string
forwardCompatibleEnumsByDefault: true
forwardCompatibleUnionsByDefault: "tagged-only"
forwardCompatibleUnionsByDefault: tagged-only
generateExamples: true
imports:
option: openapi

45
.speakeasy/tests.arazzo.yaml
View File

@@ -7894,7 +7894,7 @@ workflows:
parameters:
- name: X-Plex-Client-Identifier
in: header
value: 3381b62b-9ab7-4e37-827b-203e9809eb58
value: abc123
- name: X-Plex-Product
in: header
value: Plex for Roku
@@ -7907,6 +7907,24 @@ workflows:
- name: X-Plex-Platform
in: header
value: Roku
- name: accepts
in: header
value: application/xml
- name: X-Plex-Platform-Version
in: header
value: 4.3 build 1057
- name: X-Plex-Model
in: header
value: 4200X
- name: X-Plex-Device-Vendor
in: header
value: Roku
- name: X-Plex-Device-Name
in: header
value: Living Room TV
- name: X-Plex-Marketplace
in: header
value: googlePlay
requestBody:
contentType: application/x-www-form-urlencoded
payload:
@@ -7919,7 +7937,7 @@ workflows:
- condition: $response.header.Content-Type == application/json
- context: $response.body
condition: |
{"adsConsent": null, "adsConsentReminderAt": 1556281940, "adsConsentSetAt": 1556281940, "anonymous": false, "authToken": "CxoUzBTSV5hsxjTpFKaf", "backupCodesCreated": false, "confirmed": false, "country": "US", "email": "username@email.com", "emailOnlyAuth": false, "experimentalFeatures": false, "friendlyName": "friendlyUsername", "entitlements": ["[]"], "guest": false, "hasPassword": true, "home": false, "homeAdmin": false, "homeSize": 1, "id": 13692262, "joinedAt": 1556281940, "locale": "ru", "mailingListActive": false, "mailingListStatus": "active", "maxHomeSize": 15, "profile": {"autoSelectAudio": true, "defaultAudioLanguage": "ja", "defaultSubtitleLanguage": "en", "autoSelectSubtitle": 1, "defaultSubtitleAccessibility": 1, "defaultSubtitleForced": 1, "watchedIndicator": 1, "mediaReviewsVisibility": 1}, "protected": false, "rememberExpiresAt": 1556281940, "restricted": false, "scrobbleTypes": "<value>", "services": [], "subscription": {"active": true, "subscribedAt": "2021-04-12T18:21:12Z", "status": "Inactive"}, "subscriptionDescription": "<value>", "subscriptions": [{"active": true, "subscribedAt": "2021-04-12T18:21:12Z", "status": "Inactive"}], "thumb": "https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101", "title": "UsernameTitle", "twoFactorEnabled": false, "username": "Username", "uuid": "dae343c1f45beb4f", "attributionPartner": null, "pastSubscriptions": [], "trials": []}
{"adsConsentReminderAt":1556281940,"adsConsentSetAt":1556281940,"anonymous":false,"authToken":"CxoUzBTSV5hsxjTpFKaf","backupCodesCreated":false,"confirmed":false,"country":"US","email":"username@email.com","emailOnlyAuth":false,"experimentalFeatures":false,"friendlyName":"friendlyUsername","entitlements":[],"guest":false,"hasPassword":true,"home":false,"homeAdmin":false,"homeSize":1,"id":13692262,"joinedAt":1556281940,"mailingListActive":false,"mailingListStatus":"active","maxHomeSize":15,"profile":{"autoSelectAudio":true,"defaultAudioLanguage":"ja","defaultAudioAccessibility":0,"defaultAudioLanguages":null,"defaultSubtitleLanguage":"en","defaultSubtitleLanguages":null,"autoSelectSubtitle":1,"defaultSubtitleAccessibility":1,"defaultSubtitleForced":1,"watchedIndicator":1,"mediaReviewsVisibility":1,"mediaReviewsLanguages":null},"protected":false,"rememberExpiresAt":1556281940,"restricted":false,"services":[],"subscription":{"active":true,"subscribedAt":"2021-04-12T18:21:12Z","status":"Inactive"},"subscriptions":[{"active":true,"subscribedAt":"2021-04-12T18:21:12Z","status":"Inactive"}],"thumb":"https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101","title":"UsernameTitle","twoFactorEnabled":false,"username":"Username","uuid":"dae343c1f45beb4f","attributionPartner":null,"pastSubscriptions":[],"trials":[]}
type: simple
x-speakeasy-test-group: Authentication
x-speakeasy-test-rebuild: true
@@ -7930,7 +7948,7 @@ workflows:
parameters:
- name: X-Plex-Client-Identifier
in: header
value: 3381b62b-9ab7-4e37-827b-203e9809eb58
value: abc123
- name: X-Plex-Product
in: header
value: Plex for Roku
@@ -7939,7 +7957,7 @@ workflows:
value: Roku 3
- name: X-Plex-Device-Name
in: header
value: Chrome
value: Living Room TV
- name: X-Plex-Version
in: header
value: 2.4.1
@@ -7952,8 +7970,22 @@ workflows:
- name: X-Plex-Platform-Version
in: header
value: 4.3 build 1057
- name: accepts
in: header
value: application/xml
- name: X-Plex-Device-Vendor
in: header
value: Roku
- name: X-Plex-Marketplace
in: header
value: googlePlay
successCriteria:
- condition: $statusCode == 200
- condition: $response.header.Content-Type == application/json
- context: $response.body
condition: |
{"MediaContainer":{"friendlyName":"myPlex","identifier":"com.plexapp.plugins.myplex","machineIdentifier":"3dff4c4da3b1229a649aa574a9e2b419a684a20e","totalSize":30,"size":30,"User":[{"id":22526914,"title":"Plex User","username":"zgfuc7krcqfimrmb9lsl5j","email":"zgfuc7krcqfimrmb9lsl5j@protonmail.com","recommendationsPlaylistId":"","thumb":"https://plex.tv/users/3346028014e93acd/avatar?c=1731605021","protected":1,"home":1,"allowTuners":1,"allowSync":1,"allowCameraUpload":1,"allowChannels":1,"allowSubtitleAdmin":1,"filterAll":"","filterMovies":"","filterMusic":"","filterPhotos":"","filterTelevision":"","restricted":1,"Server":[{"id":907759180,"serverId":9999999,"machineIdentifier":"fbb8aa6be6e0c997c6268bc2b4431c8807f70a3","name":"ConnectedUserFlix","lastSeenAt":1556281940,"numLibraries":16,"allLibraries":1,"owned":1,"pending":1}]}]}}
type: simple
x-speakeasy-test-group: Users
x-speakeasy-test-rebuild: true
- workflowId: get-server-resources
@@ -7972,7 +8004,10 @@ workflows:
value: 1
- name: X-Plex-Client-Identifier
in: header
value: 3381b62b-9ab7-4e37-827b-203e9809eb58
value: abc123
- name: accepts
in: header
value: application/xml
successCriteria:
- condition: $statusCode == 200
- condition: $response.header.Content-Type == application/json

4
.speakeasy/workflow.lock
View File

@@ -13,7 +13,7 @@ sources:
sourceBlobDigest: sha256:993bfb796a3833b0a3b813ad12469ca34db94f23c2d15ae988a26b4d1ed80fbe
tags:
- latest
- speakeasy-sdk-regen-1764548057
- speakeasy-sdk-regen-1764553715
- 1.1.1
targets:
plexjs:
@@ -22,7 +22,7 @@ targets:
sourceRevisionDigest: sha256:ace004a3b232e8ab9ca3d89f2da8e40470236e6d997073a16c3f8872d67a7383
sourceBlobDigest: sha256:993bfb796a3833b0a3b813ad12469ca34db94f23c2d15ae988a26b4d1ed80fbe
codeSamplesNamespace: code-samples-typescript-plexjs
codeSamplesRevisionDigest: sha256:c53f6ae11c517b30d265b87a938e710393ce8921f2f8f5e04f73419faf2ae2f0
codeSamplesRevisionDigest: sha256:8e6f77ee0be9e54c36682ee6244983f9a69ce9a05a6a251f64df3f5fbd5bc08a
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest

4
FUNCTIONS.md
View File

@@ -21,8 +21,8 @@ specific category of applications.
```typescript
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
import { transcoderStartTranscodeSession } from "@lukehagar/plexjs/funcs/transcoderStartTranscodeSession.js";
import { Extension, StartTranscodeSessionLocation, StartTranscodeSessionProtocol } from "@lukehagar/plexjs/sdk/models/operations";
import { Accepts, AdvancedSubtitles, BoolInt, TranscodeType } from "@lukehagar/plexjs/sdk/models/shared";
import { Extension, StartTranscodeSessionLocation, StartTranscodeSessionProtocol } from "@lukehagar/plexjs/models/operations";
import { Accepts, AdvancedSubtitles, BoolInt, TranscodeType } from "@lukehagar/plexjs/models/shared";
// Use `PlexAPICore` for best tree-shaking performance.
// You can create one instance of it to use across an application.

57
README.md
View File

@@ -76,13 +76,13 @@ import {
Extension,
StartTranscodeSessionLocation,
StartTranscodeSessionProtocol,
} from "@lukehagar/plexjs/sdk/models/operations";
} from "@lukehagar/plexjs/models/operations";
import {
Accepts,
AdvancedSubtitles,
BoolInt,
TranscodeType,
} from "@lukehagar/plexjs/sdk/models/shared";
} from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({
accepts: Accepts.ApplicationXml,
@@ -487,7 +487,7 @@ run();
<!-- Start Error Handling [errors] -->
## Error Handling
[`PlexAPIError`](./src/sdk/models/errors/plexapierror.ts) is the base class for all HTTP error responses. It has the following properties:
[`PlexAPIError`](./src/models/errors/plexapierror.ts) is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
@@ -501,8 +501,8 @@ run();
### Example
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import * as errors from "@lukehagar/plexjs/sdk/models/errors";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
import * as errors from "@lukehagar/plexjs/models/errors";
import { Accepts } from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({
accepts: Accepts.ApplicationXml,
@@ -535,7 +535,6 @@ async function run() {
// Depending on the method different errors may be thrown
if (error instanceof errors.GetTokenDetailsBadRequestError) {
console.log(error.data$.errors); // GetTokenDetailsBadRequestError[]
console.log(error.data$.rawResponse); // Response
}
}
}
@@ -547,29 +546,29 @@ run();
### Error Classes
**Primary error:**
* [`PlexAPIError`](./src/sdk/models/errors/plexapierror.ts): The base class for HTTP error responses.
* [`PlexAPIError`](./src/models/errors/plexapierror.ts): The base class for HTTP error responses.
<details><summary>Less common errors (13)</summary>
<br />
**Network errors:**
* [`ConnectionError`](./src/sdk/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
* [`RequestTimeoutError`](./src/sdk/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
* [`RequestAbortedError`](./src/sdk/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
* [`InvalidRequestError`](./src/sdk/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
* [`UnexpectedClientError`](./src/sdk/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
**Inherit from [`PlexAPIError`](./src/sdk/models/errors/plexapierror.ts)**:
* [`GetTokenDetailsBadRequestError`](./src/sdk/models/errors/gettokendetailsbadrequesterror.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 241 methods.*
* [`PostUsersSignInDataBadRequestError`](./src/sdk/models/errors/postuserssignindatabadrequesterror.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 241 methods.*
* [`GetUsersBadRequestError`](./src/sdk/models/errors/getusersbadrequesterror.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 241 methods.*
* [`GetTokenDetailsUnauthorizedError`](./src/sdk/models/errors/gettokendetailsunauthorizederror.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 241 methods.*
* [`PostUsersSignInDataUnauthorizedError`](./src/sdk/models/errors/postuserssignindataunauthorizederror.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 241 methods.*
* [`GetUsersUnauthorizedError`](./src/sdk/models/errors/getusersunauthorizederror.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 241 methods.*
* [`GetServerResourcesUnauthorizedError`](./src/sdk/models/errors/getserverresourcesunauthorizederror.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 241 methods.*
* [`ResponseValidationError`](./src/sdk/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
**Inherit from [`PlexAPIError`](./src/models/errors/plexapierror.ts)**:
* [`GetTokenDetailsBadRequestError`](./src/models/errors/gettokendetailsbadrequesterror.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 241 methods.*
* [`PostUsersSignInDataBadRequestError`](./src/models/errors/postuserssignindatabadrequesterror.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 241 methods.*
* [`GetUsersBadRequestError`](./src/models/errors/getusersbadrequesterror.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 241 methods.*
* [`GetTokenDetailsUnauthorizedError`](./src/models/errors/gettokendetailsunauthorizederror.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 241 methods.*
* [`PostUsersSignInDataUnauthorizedError`](./src/models/errors/postuserssignindataunauthorizederror.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 241 methods.*
* [`GetUsersUnauthorizedError`](./src/models/errors/getusersunauthorizederror.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 241 methods.*
* [`GetServerResourcesUnauthorizedError`](./src/models/errors/getserverresourcesunauthorizederror.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 241 methods.*
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
</details>
@@ -604,7 +603,7 @@ If the selected server has variables, you may override its default values throug
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
import { Accepts } from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({
serverIdx: 0,
@@ -640,7 +639,7 @@ run();
The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
import { Accepts } from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({
serverURL: "https://http://localhost:32400",
@@ -673,7 +672,7 @@ run();
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
import { Accepts } from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({
accepts: Accepts.ApplicationXml,
@@ -766,7 +765,7 @@ This SDK supports the following security scheme globally:
To authenticate with the API the `token` parameter must be set when initializing the SDK client instance. For example:
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
import { Accepts } from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({
token: "<YOUR_API_KEY_HERE>",
@@ -1083,9 +1082,7 @@ const plexAPI = new PlexAPI({
});
async function run() {
const result = await plexAPI.log.writeLog(await openAsBlob("example.file"));
console.log(result);
await plexAPI.log.writeLog(await openAsBlob("example.file"));
}
run();
@@ -1101,7 +1098,7 @@ Some of the endpoints in this SDK support retries. If you use the SDK without a
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
import { Accepts } from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({
accepts: Accepts.ApplicationXml,
@@ -1142,7 +1139,7 @@ run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
import { Accepts } from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({
retryConfig: {

10
RELEASES.md
View File

@@ -1449,3 +1449,13 @@ Based on:
- [typescript v0.44.0] .
### Releases
- [NPM v0.44.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.44.0 - .
## 2025-12-01 01:48:15
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.665.0 (2.767.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.44.1] .
### Releases
- [NPM v0.44.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.44.1 - .

4
USAGE.md
View File

@@ -5,13 +5,13 @@ import {
Extension,
StartTranscodeSessionLocation,
StartTranscodeSessionProtocol,
} from "@lukehagar/plexjs/sdk/models/operations";
} from "@lukehagar/plexjs/models/operations";
import {
Accepts,
AdvancedSubtitles,
BoolInt,
TranscodeType,
} from "@lukehagar/plexjs/sdk/models/shared";
} from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({
accepts: Accepts.ApplicationXml,

784
codeSamples.yaml
View File

File diff suppressed because it is too large Load Diff

17
docs/models/errors/getserverresourcesunauthorizederror.md Normal file
View File

@@ -0,0 +1,17 @@
# GetServerResourcesUnauthorizedError
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetServerResourcesUnauthorizedError } from "@lukehagar/plexjs/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `errors` | [operations.GetServerResourcesError](../../models/operations/getserverresourceserror.md)[] | :heavy_minus_sign: | N/A |

17
docs/models/errors/gettokendetailsbadrequesterror.md Normal file
View File

@@ -0,0 +1,17 @@
# GetTokenDetailsBadRequestError
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { GetTokenDetailsBadRequestError } from "@lukehagar/plexjs/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `errors` | [operations.GetTokenDetailsBadRequestError](../../models/operations/gettokendetailsbadrequesterror.md)[] | :heavy_minus_sign: | N/A |

17
docs/models/errors/gettokendetailsunauthorizederror.md Normal file
View File

@@ -0,0 +1,17 @@
# GetTokenDetailsUnauthorizedError
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetTokenDetailsUnauthorizedError } from "@lukehagar/plexjs/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `errors` | [operations.GetTokenDetailsUnauthorizedError](../../models/operations/gettokendetailsunauthorizederror.md)[] | :heavy_minus_sign: | N/A |

17
docs/models/errors/getusersbadrequesterror.md Normal file
View File

@@ -0,0 +1,17 @@
# GetUsersBadRequestError
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { GetUsersBadRequestError } from "@lukehagar/plexjs/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `errors` | [operations.GetUsersBadRequestError](../../models/operations/getusersbadrequesterror.md)[] | :heavy_minus_sign: | N/A |

17
docs/models/errors/getusersunauthorizederror.md Normal file
View File

@@ -0,0 +1,17 @@
# GetUsersUnauthorizedError
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetUsersUnauthorizedError } from "@lukehagar/plexjs/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `errors` | [operations.GetUsersUnauthorizedError](../../models/operations/getusersunauthorizederror.md)[] | :heavy_minus_sign: | N/A |

17
docs/models/errors/postuserssignindatabadrequesterror.md Normal file
View File

@@ -0,0 +1,17 @@
# PostUsersSignInDataBadRequestError
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { PostUsersSignInDataBadRequestError } from "@lukehagar/plexjs/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `errors` | [operations.PostUsersSignInDataBadRequestError](../../models/operations/postuserssignindatabadrequesterror.md)[] | :heavy_minus_sign: | N/A |

17
docs/models/errors/postuserssignindataunauthorizederror.md Normal file
View File

@@ -0,0 +1,17 @@
# PostUsersSignInDataUnauthorizedError
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { PostUsersSignInDataUnauthorizedError } from "@lukehagar/plexjs/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `errors` | [operations.PostUsersSignInDataUnauthorizedError](../../models/operations/postuserssignindataunauthorizederror.md)[] | :heavy_minus_sign: | N/A |

2
docs/sdk/models/operations/account.md → docs/models/operations/account.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { Account } from "@lukehagar/plexjs/sdk/models/operations";
import { Account } from "@lukehagar/plexjs/models/operations";
let value: Account = {};
```

2
docs/sdk/models/operations/action.md → docs/models/operations/action.md
View File

@@ -5,7 +5,7 @@ The action to perform for this item on this optimizer queue
## Example Usage
```typescript
import { Action } from "@lukehagar/plexjs/sdk/models/operations";
import { Action } from "@lukehagar/plexjs/models/operations";
let value: Action = Action.Enable;
```

2
docs/sdk/models/operations/activity.md → docs/models/operations/activity.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { Activity } from "@lukehagar/plexjs/sdk/models/operations";
import { Activity } from "@lukehagar/plexjs/models/operations";
let value: Activity = {};
```

4
docs/sdk/models/operations/addcollectionitemsglobals.md → docs/models/operations/addcollectionitemsglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddCollectionItemsGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { AddCollectionItemsGlobals } from "@lukehagar/plexjs/models/operations";
let value: AddCollectionItemsGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: AddCollectionItemsGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/addcollectionitemsrequest.md → docs/models/operations/addcollectionitemsrequest.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddCollectionItemsRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { AddCollectionItemsRequest } from "@lukehagar/plexjs/models/operations";
let value: AddCollectionItemsRequest = {
collectionId: 705686,
@@ -15,7 +15,7 @@ let value: AddCollectionItemsRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/adddeviceglobals.md → docs/models/operations/adddeviceglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddDeviceGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { AddDeviceGlobals } from "@lukehagar/plexjs/models/operations";
let value: AddDeviceGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: AddDeviceGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/adddevicerequest.md → docs/models/operations/adddevicerequest.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddDeviceRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { AddDeviceRequest } from "@lukehagar/plexjs/models/operations";
let value: AddDeviceRequest = {
uri: "http://10.0.0.5",
@@ -14,7 +14,7 @@ let value: AddDeviceRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

19
docs/models/operations/adddevicetodvrdvr.md Normal file
View File

@@ -0,0 +1,19 @@
# AddDeviceToDVRDVR
## Example Usage
```typescript
import { AddDeviceToDVRDVR } from "@lukehagar/plexjs/models/operations";
let value: AddDeviceToDVRDVR = {};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
| `device` | [shared.Device](../../models/shared/device.md)[] | :heavy_minus_sign: | N/A |
| `key` | *string* | :heavy_minus_sign: | N/A |
| `language` | *string* | :heavy_minus_sign: | N/A |
| `lineup` | *string* | :heavy_minus_sign: | N/A |
| `uuid` | *string* | :heavy_minus_sign: | N/A |

4
docs/sdk/models/operations/adddevicetodvrglobals.md → docs/models/operations/adddevicetodvrglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddDeviceToDVRGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { AddDeviceToDVRGlobals } from "@lukehagar/plexjs/models/operations";
let value: AddDeviceToDVRGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: AddDeviceToDVRGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

8
docs/sdk/models/operations/adddevicetodvrmediacontainer.md → docs/models/operations/adddevicetodvrmediacontainer.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddDeviceToDVRMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
import { AddDeviceToDVRMediaContainer } from "@lukehagar/plexjs/models/operations";
let value: AddDeviceToDVRMediaContainer = {};
```
@@ -11,6 +11,6 @@ let value: AddDeviceToDVRMediaContainer = {};
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.AddDeviceToDVRMediaContainerMediaContainer](../../../sdk/models/operations/adddevicetodvrmediacontainermediacontainer.md) | :heavy_minus_sign: | N/A |
| `dvr` | [operations.AddDeviceToDVRDVR](../../../sdk/models/operations/adddevicetodvrdvr.md)[] | :heavy_minus_sign: | N/A |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `mediaContainer` | [operations.AddDeviceToDVRMediaContainerMediaContainer](../../models/operations/adddevicetodvrmediacontainermediacontainer.md) | :heavy_minus_sign: | N/A |
| `dvr` | [operations.AddDeviceToDVRDVR](../../models/operations/adddevicetodvrdvr.md)[] | :heavy_minus_sign: | N/A |

2
docs/sdk/models/operations/adddevicetodvrmediacontainermediacontainer.md → docs/models/operations/adddevicetodvrmediacontainermediacontainer.md
View File

@@ -8,7 +8,7 @@ The container often "hoists" common attributes from its children. For example, i
## Example Usage
```typescript
import { AddDeviceToDVRMediaContainerMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
import { AddDeviceToDVRMediaContainerMediaContainer } from "@lukehagar/plexjs/models/operations";
let value: AddDeviceToDVRMediaContainerMediaContainer = {};
```

4
docs/sdk/models/operations/adddevicetodvrrequest.md → docs/models/operations/adddevicetodvrrequest.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddDeviceToDVRRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { AddDeviceToDVRRequest } from "@lukehagar/plexjs/models/operations";
let value: AddDeviceToDVRRequest = {
dvrId: 595771,
@@ -15,7 +15,7 @@ let value: AddDeviceToDVRRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

27
docs/models/operations/adddevicetodvrresponse.md Normal file
View File

@@ -0,0 +1,27 @@
# AddDeviceToDVRResponse
## Example Usage
```typescript
import { AddDeviceToDVRResponse } from "@lukehagar/plexjs/models/operations";
let value: AddDeviceToDVRResponse = {
headers: {
"key": [
"<value 1>",
],
"key1": [
"<value 1>",
"<value 2>",
],
},
result: {},
};
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `headers` | Record<string, *string*[]> | :heavy_check_mark: | N/A |
| `result` | [operations.AddDeviceToDVRResponseBody](../../models/operations/adddevicetodvrresponsebody.md) | :heavy_check_mark: | N/A |

17
docs/models/operations/adddevicetodvrresponsebody.md Normal file
View File

@@ -0,0 +1,17 @@
# AddDeviceToDVRResponseBody
OK
## Example Usage
```typescript
import { AddDeviceToDVRResponseBody } from "@lukehagar/plexjs/models/operations";
let value: AddDeviceToDVRResponseBody = {};
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.AddDeviceToDVRMediaContainer](../../models/operations/adddevicetodvrmediacontainer.md) | :heavy_minus_sign: | N/A |

4
docs/sdk/models/operations/adddownloadqueueitemsglobals.md → docs/models/operations/adddownloadqueueitemsglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddDownloadQueueItemsGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { AddDownloadQueueItemsGlobals } from "@lukehagar/plexjs/models/operations";
let value: AddDownloadQueueItemsGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: AddDownloadQueueItemsGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/adddownloadqueueitemsmediacontainer.md → docs/models/operations/adddownloadqueueitemsmediacontainer.md
View File

@@ -8,7 +8,7 @@ The container often "hoists" common attributes from its children. For example, i
## Example Usage
```typescript
import { AddDownloadQueueItemsMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
import { AddDownloadQueueItemsMediaContainer } from "@lukehagar/plexjs/models/operations";
let value: AddDownloadQueueItemsMediaContainer = {};
```
@@ -21,4 +21,4 @@ let value: AddDownloadQueueItemsMediaContainer = {};
| `offset` | *number* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
| `size` | *number* | :heavy_minus_sign: | N/A |
| `totalSize` | *number* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
| `addedQueueItems` | [operations.AddedQueueItem](../../../sdk/models/operations/addedqueueitem.md)[] | :heavy_minus_sign: | N/A |
| `addedQueueItems` | [operations.AddedQueueItem](../../models/operations/addedqueueitem.md)[] | :heavy_minus_sign: | N/A |

28
docs/sdk/models/operations/adddownloadqueueitemsrequest.md → docs/models/operations/adddownloadqueueitemsrequest.md
View File

@@ -3,8 +3,8 @@
## Example Usage
```typescript
import { AddDownloadQueueItemsRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { AdvancedSubtitles, BoolInt, LocationParameter, ProtocolParameter, Subtitles } from "@lukehagar/plexjs/sdk/models/shared";
import { AddDownloadQueueItemsRequest } from "@lukehagar/plexjs/models/operations";
import { AdvancedSubtitles, BoolInt, LocationParameter, ProtocolParameter, Subtitles } from "@lukehagar/plexjs/models/shared";
let value: AddDownloadQueueItemsRequest = {
queueId: 44894,
@@ -45,7 +45,7 @@ let value: AddDownloadQueueItemsRequest = {
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
@@ -58,17 +58,17 @@ let value: AddDownloadQueueItemsRequest = {
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `queueId` | *number* | :heavy_check_mark: | The queue id | |
| `keys` | *string*[] | :heavy_check_mark: | Keys to add | [<br/>"/library/metadata/3",<br/>"/library/metadata/6"<br/>] |
| `advancedSubtitles` | [shared.AdvancedSubtitles](../../../sdk/models/shared/advancedsubtitles.md) | :heavy_minus_sign: | Indicates how incompatible advanced subtitles (such as ass/ssa) should be included: * 'burn' - Burn incompatible advanced text subtitles into the video stream * 'text' - Transcode incompatible advanced text subtitles to a compatible text format, even if some markup is lost<br/> | burn |
| `advancedSubtitles` | [shared.AdvancedSubtitles](../../models/shared/advancedsubtitles.md) | :heavy_minus_sign: | Indicates how incompatible advanced subtitles (such as ass/ssa) should be included: * 'burn' - Burn incompatible advanced text subtitles into the video stream * 'text' - Transcode incompatible advanced text subtitles to a compatible text format, even if some markup is lost<br/> | burn |
| `audioBoost` | *number* | :heavy_minus_sign: | Percentage of original audio loudness to use when transcoding (100 is equivalent to original volume, 50 is half, 200 is double, etc) | 50 |
| `audioChannelCount` | *number* | :heavy_minus_sign: | Target video number of audio channels. | 5 |
| `autoAdjustQuality` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports ABR. | 1 |
| `autoAdjustSubtitle` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates if the server should adjust subtitles based on Voice Activity Data. | 1 |
| `directPlay` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports direct playing the indicated content. | 1 |
| `directStream` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports direct streaming the video of the indicated content. | 1 |
| `directStreamAudio` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports direct streaming the audio of the indicated content. | 1 |
| `disableResolutionRotation` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates if resolution should be adjusted for orientation. | 1 |
| `hasMDE` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Ignore client profiles when determining if direct play is possible. Only has an effect when directPlay=1 and both mediaIndex and partIndex are specified and neither are -1 | 1 |
| `location` | [shared.LocationParameter](../../../sdk/models/shared/locationparameter.md) | :heavy_minus_sign: | Network type of the client, can be used to help determine target bitrate. | wan |
| `autoAdjustQuality` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports ABR. | 1 |
| `autoAdjustSubtitle` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Indicates if the server should adjust subtitles based on Voice Activity Data. | 1 |
| `directPlay` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports direct playing the indicated content. | 1 |
| `directStream` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports direct streaming the video of the indicated content. | 1 |
| `directStreamAudio` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports direct streaming the audio of the indicated content. | 1 |
| `disableResolutionRotation` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Indicates if resolution should be adjusted for orientation. | 1 |
| `hasMDE` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Ignore client profiles when determining if direct play is possible. Only has an effect when directPlay=1 and both mediaIndex and partIndex are specified and neither are -1 | 1 |
| `location` | [shared.LocationParameter](../../models/shared/locationparameter.md) | :heavy_minus_sign: | Network type of the client, can be used to help determine target bitrate. | wan |
| `mediaBufferSize` | *number* | :heavy_minus_sign: | Buffer size used in playback (in KB). Clients should specify a lower bound if not known exactly. This value could make the difference between transcoding and direct play on bandwidth constrained networks. | 102400 |
| `mediaIndex` | *number* | :heavy_minus_sign: | Index of the media to transcode. -1 or not specified indicates let the server choose. | 0 |
| `musicBitrate` | *number* | :heavy_minus_sign: | Target bitrate for audio only files (in kbps, used to transcode). | 5000 |
@@ -77,10 +77,10 @@ let value: AddDownloadQueueItemsRequest = {
| `path` | *string* | :heavy_minus_sign: | Internal PMS path of the media to transcode. | /library/metadata/151671 |
| `peakBitrate` | *number* | :heavy_minus_sign: | Maximum bitrate (in kbps) to use in ABR. | 12000 |
| `photoResolution` | *string* | :heavy_minus_sign: | Target photo resolution. | 1080x1080 |
| `protocol` | [shared.ProtocolParameter](../../../sdk/models/shared/protocolparameter.md) | :heavy_minus_sign: | Indicates the network streaming protocol to be used for the transcode session: * 'http' - include the file in the http response such as MKV streaming * 'hls' - hls stream (RFC 8216) * 'dash' - dash stream (ISO/IEC 23009-1:2022)<br/> | dash |
| `protocol` | [shared.ProtocolParameter](../../models/shared/protocolparameter.md) | :heavy_minus_sign: | Indicates the network streaming protocol to be used for the transcode session: * 'http' - include the file in the http response such as MKV streaming * 'hls' - hls stream (RFC 8216) * 'dash' - dash stream (ISO/IEC 23009-1:2022)<br/> | dash |
| `secondsPerSegment` | *number* | :heavy_minus_sign: | Number of seconds to include in each transcoded segment | 5 |
| `subtitleSize` | *number* | :heavy_minus_sign: | Percentage of original subtitle size to use when burning subtitles (100 is equivalent to original size, 50 is half, ect) | 50 |
| `subtitles` | [shared.Subtitles](../../../sdk/models/shared/subtitles.md) | :heavy_minus_sign: | Indicates how subtitles should be included: * 'auto' - Compute the appropriate subtitle setting automatically * 'burn' - Burn the selected subtitle; auto if no selected subtitle * 'none' - Ignore all subtitle streams * 'sidecar' - The selected subtitle should be provided as a sidecar * 'embedded' - The selected subtitle should be provided as an embedded stream * 'segmented' - The selected subtitle should be provided as a segmented stream<br/> | Burn |
| `subtitles` | [shared.Subtitles](../../models/shared/subtitles.md) | :heavy_minus_sign: | Indicates how subtitles should be included: * 'auto' - Compute the appropriate subtitle setting automatically * 'burn' - Burn the selected subtitle; auto if no selected subtitle * 'none' - Ignore all subtitle streams * 'sidecar' - The selected subtitle should be provided as a sidecar * 'embedded' - The selected subtitle should be provided as an embedded stream * 'segmented' - The selected subtitle should be provided as a segmented stream<br/> | Burn |
| `videoBitrate` | *number* | :heavy_minus_sign: | Target video bitrate (in kbps). | 12000 |
| `videoQuality` | *number* | :heavy_minus_sign: | Target photo quality. | 50 |
| `videoResolution` | *string* | :heavy_minus_sign: | Target maximum video resolution. | 1080x1080 |

17
docs/models/operations/adddownloadqueueitemsresponse.md Normal file
View File

@@ -0,0 +1,17 @@
# AddDownloadQueueItemsResponse
OK
## Example Usage
```typescript
import { AddDownloadQueueItemsResponse } from "@lukehagar/plexjs/models/operations";
let value: AddDownloadQueueItemsResponse = {};
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.AddDownloadQueueItemsMediaContainer](../../models/operations/adddownloadqueueitemsmediacontainer.md) | :heavy_minus_sign: | N/A |

2
docs/sdk/models/operations/addedqueueitem.md → docs/models/operations/addedqueueitem.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddedQueueItem } from "@lukehagar/plexjs/sdk/models/operations";
import { AddedQueueItem } from "@lukehagar/plexjs/models/operations";
let value: AddedQueueItem = {};
```

4
docs/sdk/models/operations/addextrasglobals.md → docs/models/operations/addextrasglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddExtrasGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { AddExtrasGlobals } from "@lukehagar/plexjs/models/operations";
let value: AddExtrasGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: AddExtrasGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/addextrasrequest.md → docs/models/operations/addextrasrequest.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddExtrasRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { AddExtrasRequest } from "@lukehagar/plexjs/models/operations";
let value: AddExtrasRequest = {
ids: "<value>",
@@ -15,7 +15,7 @@ let value: AddExtrasRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

19
docs/models/operations/addlineupdvr.md Normal file
View File

@@ -0,0 +1,19 @@
# AddLineupDVR
## Example Usage
```typescript
import { AddLineupDVR } from "@lukehagar/plexjs/models/operations";
let value: AddLineupDVR = {};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
| `device` | [shared.Device](../../models/shared/device.md)[] | :heavy_minus_sign: | N/A |
| `key` | *string* | :heavy_minus_sign: | N/A |
| `language` | *string* | :heavy_minus_sign: | N/A |
| `lineup` | *string* | :heavy_minus_sign: | N/A |
| `uuid` | *string* | :heavy_minus_sign: | N/A |

4
docs/sdk/models/operations/addlineupglobals.md → docs/models/operations/addlineupglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddLineupGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { AddLineupGlobals } from "@lukehagar/plexjs/models/operations";
let value: AddLineupGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: AddLineupGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

16
docs/models/operations/addlineupmediacontainer.md Normal file
View File

@@ -0,0 +1,16 @@
# AddLineupMediaContainer
## Example Usage
```typescript
import { AddLineupMediaContainer } from "@lukehagar/plexjs/models/operations";
let value: AddLineupMediaContainer = {};
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.AddLineupMediaContainerMediaContainer](../../models/operations/addlineupmediacontainermediacontainer.md) | :heavy_minus_sign: | N/A |
| `dvr` | [operations.AddLineupDVR](../../models/operations/addlineupdvr.md)[] | :heavy_minus_sign: | N/A |

2
docs/sdk/models/operations/addlineupmediacontainermediacontainer.md → docs/models/operations/addlineupmediacontainermediacontainer.md
View File

@@ -8,7 +8,7 @@ The container often "hoists" common attributes from its children. For example, i
## Example Usage
```typescript
import { AddLineupMediaContainerMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
import { AddLineupMediaContainerMediaContainer } from "@lukehagar/plexjs/models/operations";
let value: AddLineupMediaContainerMediaContainer = {};
```

4
docs/sdk/models/operations/addlineuprequest.md → docs/models/operations/addlineuprequest.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddLineupRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { AddLineupRequest } from "@lukehagar/plexjs/models/operations";
let value: AddLineupRequest = {
dvrId: 950730,
@@ -15,7 +15,7 @@ let value: AddLineupRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

27
docs/models/operations/addlineupresponse.md Normal file
View File

@@ -0,0 +1,27 @@
# AddLineupResponse
## Example Usage
```typescript
import { AddLineupResponse } from "@lukehagar/plexjs/models/operations";
let value: AddLineupResponse = {
headers: {
"key": [
"<value 1>",
],
"key1": [
"<value 1>",
"<value 2>",
],
},
result: {},
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `headers` | Record<string, *string*[]> | :heavy_check_mark: | N/A |
| `result` | [operations.AddLineupResponseBody](../../models/operations/addlineupresponsebody.md) | :heavy_check_mark: | N/A |

17
docs/models/operations/addlineupresponsebody.md Normal file
View File

@@ -0,0 +1,17 @@
# AddLineupResponseBody
OK
## Example Usage
```typescript
import { AddLineupResponseBody } from "@lukehagar/plexjs/models/operations";
let value: AddLineupResponseBody = {};
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.AddLineupMediaContainer](../../models/operations/addlineupmediacontainer.md) | :heavy_minus_sign: | N/A |

4
docs/sdk/models/operations/addplaylistitemsglobals.md → docs/models/operations/addplaylistitemsglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddPlaylistItemsGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { AddPlaylistItemsGlobals } from "@lukehagar/plexjs/models/operations";
let value: AddPlaylistItemsGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: AddPlaylistItemsGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/addplaylistitemsrequest.md → docs/models/operations/addplaylistitemsrequest.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddPlaylistItemsRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { AddPlaylistItemsRequest } from "@lukehagar/plexjs/models/operations";
let value: AddPlaylistItemsRequest = {
playlistId: 174404,
@@ -14,7 +14,7 @@ let value: AddPlaylistItemsRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/addproviderglobals.md → docs/models/operations/addproviderglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddProviderGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { AddProviderGlobals } from "@lukehagar/plexjs/models/operations";
let value: AddProviderGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: AddProviderGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/addproviderrequest.md → docs/models/operations/addproviderrequest.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddProviderRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { AddProviderRequest } from "@lukehagar/plexjs/models/operations";
let value: AddProviderRequest = {
url: "https://bright-unique.biz/",
@@ -14,7 +14,7 @@ let value: AddProviderRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/addsectionglobals.md → docs/models/operations/addsectionglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddSectionGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { AddSectionGlobals } from "@lukehagar/plexjs/models/operations";
let value: AddSectionGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: AddSectionGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

2
docs/sdk/models/operations/addsectionprefs.md → docs/models/operations/addsectionprefs.md
View File

@@ -5,7 +5,7 @@ The preferences for this section
## Example Usage
```typescript
import { AddSectionPrefs } from "@lukehagar/plexjs/sdk/models/operations";
import { AddSectionPrefs } from "@lukehagar/plexjs/models/operations";
let value: AddSectionPrefs = {};
```

48
docs/models/operations/addsectionrequest.md Normal file
View File

@@ -0,0 +1,48 @@
# AddSectionRequest
## Example Usage
```typescript
import { AddSectionRequest } from "@lukehagar/plexjs/models/operations";
import { BoolInt } from "@lukehagar/plexjs/models/shared";
let value: AddSectionRequest = {
name: "<value>",
type: 583726,
agent: "<value>",
language: "<value>",
locations: [
"O:\fatboy\\Media\\Ripped\\Music",
"O:\fatboy\\Media\\My Music",
],
prefs: {},
relative: BoolInt.True,
importFromiTunes: BoolInt.True,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `name` | *string* | :heavy_check_mark: | The name of the new section | |
| `type` | *number* | :heavy_check_mark: | The type of library section | |
| `scanner` | *string* | :heavy_minus_sign: | The scanner this section should use | |
| `agent` | *string* | :heavy_check_mark: | The agent this section should use for metadata | |
| `metadataAgentProviderGroupId` | *string* | :heavy_minus_sign: | The agent group id for this section | |
| `language` | *string* | :heavy_check_mark: | The language of this section | |
| `locations` | *string*[] | :heavy_minus_sign: | The locations on disk to add to this section | [<br/>"O:\\fatboy\\Media\\Ripped\\Music",<br/>"O:\\fatboy\\Media\\My Music"<br/>] |
| `prefs` | [operations.AddSectionPrefs](../../models/operations/addsectionprefs.md) | :heavy_minus_sign: | The preferences for this section | {<br/>"collectionMode": 2,<br/>"hidden": 0<br/>} |
| `relative` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | If set, paths are relative to `Media Upload` path | 1 |
| `importFromiTunes` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | If set, import media from iTunes. | 1 |

4
docs/sdk/models/operations/addsubtitlesglobals.md → docs/models/operations/addsubtitlesglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddSubtitlesGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { AddSubtitlesGlobals } from "@lukehagar/plexjs/models/operations";
let value: AddSubtitlesGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: AddSubtitlesGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

10
docs/sdk/models/operations/addsubtitlesrequest.md → docs/models/operations/addsubtitlesrequest.md
View File

@@ -3,8 +3,8 @@
## Example Usage
```typescript
import { AddSubtitlesRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
import { AddSubtitlesRequest } from "@lukehagar/plexjs/models/operations";
import { BoolInt } from "@lukehagar/plexjs/models/shared";
let value: AddSubtitlesRequest = {
ids: "<value>",
@@ -17,7 +17,7 @@ let value: AddSubtitlesRequest = {
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
@@ -34,5 +34,5 @@ let value: AddSubtitlesRequest = {
| `mediaItemID` | *number* | :heavy_minus_sign: | N/A | |
| `url` | *string* | :heavy_minus_sign: | The URL of the subtitle. If not provided, the contents of the subtitle must be in the post body | |
| `format` | *string* | :heavy_minus_sign: | N/A | |
| `forced` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | N/A | 1 |
| `hearingImpaired` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | N/A | 1 |
| `forced` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | N/A | 1 |
| `hearingImpaired` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | N/A | 1 |

4
docs/sdk/models/operations/addtoplayqueueglobals.md → docs/models/operations/addtoplayqueueglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AddToPlayQueueGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { AddToPlayQueueGlobals } from "@lukehagar/plexjs/models/operations";
let value: AddToPlayQueueGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: AddToPlayQueueGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

8
docs/sdk/models/operations/addtoplayqueuerequest.md → docs/models/operations/addtoplayqueuerequest.md
View File

@@ -3,8 +3,8 @@
## Example Usage
```typescript
import { AddToPlayQueueRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
import { AddToPlayQueueRequest } from "@lukehagar/plexjs/models/operations";
import { BoolInt } from "@lukehagar/plexjs/models/shared";
let value: AddToPlayQueueRequest = {
playQueueId: 354193,
@@ -16,7 +16,7 @@ let value: AddToPlayQueueRequest = {
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
@@ -30,4 +30,4 @@ let value: AddToPlayQueueRequest = {
| `playQueueId` | *number* | :heavy_check_mark: | The ID of the play queue. | |
| `uri` | *string* | :heavy_minus_sign: | The content URI for what we're adding to the queue. | |
| `playlistID` | *string* | :heavy_minus_sign: | The ID of the playlist to add to the playQueue. | |
| `next` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Play this item next (defaults to 0 - queueing at the end of manually queued items). | 1 |
| `next` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Play this item next (defaults to 0 - queueing at the end of manually queued items). | 1 |

23
docs/models/operations/advancedsubtitles.md Normal file
View File

@@ -0,0 +1,23 @@
# AdvancedSubtitles
## Example Usage
```typescript
import { AdvancedSubtitles } from "@lukehagar/plexjs/models/operations";
let value: AdvancedSubtitles = AdvancedSubtitles.Auto;
```
## Values
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Auto` | auto |
| `Burn` | burn |
| `None` | none |
| `Sidecar` | sidecar |
| `Embedded` | embedded |
| `Segmented` | segmented |
| - | `Unrecognized<string>` |

21
docs/models/operations/alllibraries.md Normal file
View File

@@ -0,0 +1,21 @@
# AllLibraries
Indicates if the user has access to all libraries.
## Example Usage
```typescript
import { AllLibraries } from "@lukehagar/plexjs/models/operations";
let value: AllLibraries = AllLibraries.Enable;
```
## Values
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Disable` | 0 |
| `Enable` | 1 |
| - | `Unrecognized<number>` |

21
docs/models/operations/allowcameraupload.md Normal file
View File

@@ -0,0 +1,21 @@
# AllowCameraUpload
Indicates if the user is allowed to upload from a camera.
## Example Usage
```typescript
import { AllowCameraUpload } from "@lukehagar/plexjs/models/operations";
let value: AllowCameraUpload = AllowCameraUpload.Enable;
```
## Values
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Disable` | 0 |
| `Enable` | 1 |
| - | `Unrecognized<number>` |

21
docs/models/operations/allowchannels.md Normal file
View File

@@ -0,0 +1,21 @@
# AllowChannels
Indicates if the user has access to channels.
## Example Usage
```typescript
import { AllowChannels } from "@lukehagar/plexjs/models/operations";
let value: AllowChannels = AllowChannels.Enable;
```
## Values
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Disable` | 0 |
| `Enable` | 1 |
| - | `Unrecognized<number>` |

21
docs/models/operations/allowsubtitleadmin.md Normal file
View File

@@ -0,0 +1,21 @@
# AllowSubtitleAdmin
Indicates if the user can manage subtitles.
## Example Usage
```typescript
import { AllowSubtitleAdmin } from "@lukehagar/plexjs/models/operations";
let value: AllowSubtitleAdmin = AllowSubtitleAdmin.Enable;
```
## Values
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Disable` | 0 |
| `Enable` | 1 |
| - | `Unrecognized<number>` |

21
docs/models/operations/allowsync.md Normal file
View File

@@ -0,0 +1,21 @@
# AllowSync
Indicates if the user is allowed to sync media.
## Example Usage
```typescript
import { AllowSync } from "@lukehagar/plexjs/models/operations";
let value: AllowSync = AllowSync.Enable;
```
## Values
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Disable` | 0 |
| `Enable` | 1 |
| - | `Unrecognized<number>` |

21
docs/models/operations/allowtuners.md Normal file
View File

@@ -0,0 +1,21 @@
# AllowTuners
Indicates if the user is allowed to use tuners.
## Example Usage
```typescript
import { AllowTuners } from "@lukehagar/plexjs/models/operations";
let value: AllowTuners = AllowTuners.Enable;
```
## Values
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Disable` | 0 |
| `Enable` | 1 |
| - | `Unrecognized<number>` |

4
docs/sdk/models/operations/analyzemetadataglobals.md → docs/models/operations/analyzemetadataglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AnalyzeMetadataGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { AnalyzeMetadataGlobals } from "@lukehagar/plexjs/models/operations";
let value: AnalyzeMetadataGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: AnalyzeMetadataGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/analyzemetadatarequest.md → docs/models/operations/analyzemetadatarequest.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AnalyzeMetadataRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { AnalyzeMetadataRequest } from "@lukehagar/plexjs/models/operations";
let value: AnalyzeMetadataRequest = {
ids: "<value>",
@@ -14,7 +14,7 @@ let value: AnalyzeMetadataRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/applyupdatesglobals.md → docs/models/operations/applyupdatesglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ApplyUpdatesGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { ApplyUpdatesGlobals } from "@lukehagar/plexjs/models/operations";
let value: ApplyUpdatesGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: ApplyUpdatesGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

10
docs/sdk/models/operations/applyupdatesrequest.md → docs/models/operations/applyupdatesrequest.md
View File

@@ -3,8 +3,8 @@
## Example Usage
```typescript
import { ApplyUpdatesRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
import { ApplyUpdatesRequest } from "@lukehagar/plexjs/models/operations";
import { BoolInt } from "@lukehagar/plexjs/models/shared";
let value: ApplyUpdatesRequest = {
tonight: BoolInt.True,
@@ -16,7 +16,7 @@ let value: ApplyUpdatesRequest = {
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
@@ -27,5 +27,5 @@ let value: ApplyUpdatesRequest = {
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `tonight` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install immediately. | 1 |
| `skip` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The <Release> entry for this version will have the `state` set to `skipped`. | 1 |
| `tonight` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install immediately. | 1 |
| `skip` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The <Release> entry for this version will have the `state` set to `skipped`. | 1 |

4
docs/sdk/models/operations/autocompleteglobals.md → docs/models/operations/autocompleteglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AutocompleteGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { AutocompleteGlobals } from "@lukehagar/plexjs/models/operations";
let value: AutocompleteGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: AutocompleteGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

8
docs/sdk/models/operations/autocompleterequest.md → docs/models/operations/autocompleterequest.md
View File

@@ -3,8 +3,8 @@
## Example Usage
```typescript
import { AutocompleteRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { MediaType } from "@lukehagar/plexjs/sdk/models/shared";
import { AutocompleteRequest } from "@lukehagar/plexjs/models/operations";
import { MediaType } from "@lukehagar/plexjs/models/shared";
let value: AutocompleteRequest = {
sectionId: 594987,
@@ -20,7 +20,7 @@ let value: AutocompleteRequest = {
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
@@ -34,4 +34,4 @@ let value: AutocompleteRequest = {
| `sectionId` | *number* | :heavy_check_mark: | Section identifier | |
| `type` | *number* | :heavy_minus_sign: | Item type | |
| `fieldQuery` | *string* | :heavy_minus_sign: | The "field" stands in for any field, the value is a partial string for matching | |
| `mediaQuery` | [shared.MediaQuery](../../../sdk/models/shared/mediaquery.md) | :heavy_minus_sign: | A querystring-based filtering language used to select subsets of media. Can be provided as an object with typed properties for type safety, or as a string for complex queries with operators and boolean logic.<br/><br/>The query supports:<br/>- Fields: integer, boolean, tag, string, date, language<br/>- Operators: =, !=, ==, !==, <=, >=, >>=, <<= (varies by field type)<br/>- Boolean operators: & (AND), , (OR), push/pop (parentheses), or=1 (explicit OR)<br/>- Sorting: sort parameter with :desc, :nullsLast modifiers<br/>- Grouping: group parameter<br/>- Limits: limit parameter<br/><br/>Examples:<br/>- Object format: `{type: 4, sourceType: 2, title: "24"}` → `type=4&sourceType=2&title=24`<br/>- String format: `type=4&sourceType=2&title==24` - type = 4 AND sourceType = 2 AND title = "24"<br/>- Complex: `push=1&index=1&or=1&rating=2&pop=1&duration=10` - (index = 1 OR rating = 2) AND duration = 10<br/><br/>See [API Info section](#section/API-Info/Media-Queries) for detailed information on building media queries.<br/> | {<br/>"type": 4,<br/>"sourceType": 2,<br/>"sort": "duration:desc,index"<br/>} |
| `mediaQuery` | [shared.MediaQuery](../../models/shared/mediaquery.md) | :heavy_minus_sign: | A querystring-based filtering language used to select subsets of media. Can be provided as an object with typed properties for type safety, or as a string for complex queries with operators and boolean logic.<br/><br/>The query supports:<br/>- Fields: integer, boolean, tag, string, date, language<br/>- Operators: =, !=, ==, !==, <=, >=, >>=, <<= (varies by field type)<br/>- Boolean operators: & (AND), , (OR), push/pop (parentheses), or=1 (explicit OR)<br/>- Sorting: sort parameter with :desc, :nullsLast modifiers<br/>- Grouping: group parameter<br/>- Limits: limit parameter<br/><br/>Examples:<br/>- Object format: `{type: 4, sourceType: 2, title: "24"}` → `type=4&sourceType=2&title=24`<br/>- String format: `type=4&sourceType=2&title==24` - type = 4 AND sourceType = 2 AND title = "24"<br/>- Complex: `push=1&index=1&or=1&rating=2&pop=1&duration=10` - (index = 1 OR rating = 2) AND duration = 10<br/><br/>See [API Info section](#section/API-Info/Media-Queries) for detailed information on building media queries.<br/> | {<br/>"type": 4,<br/>"sourceType": 2,<br/>"sort": "duration:desc,index"<br/>} |

227
docs/models/operations/autocompleteresponse.md Normal file
View File

@@ -0,0 +1,227 @@
# AutocompleteResponse
## Example Usage
```typescript
import { AutocompleteResponse } from "@lukehagar/plexjs/models/operations";
let value: AutocompleteResponse = {
headers: {
"key": [
"<value 1>",
],
"key1": [
"<value 1>",
],
"key2": [
"<value 1>",
"<value 2>",
],
},
result: {
mediaContainer: {
metadata: [
{
title: "<value>",
type: "<value>",
addedAt: 29550,
art: "/library/metadata/58683/art/1703239236",
autotag: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
thumb:
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
},
],
chapterSource: "media",
childCount: 1,
country: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
thumb:
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
},
],
director: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
thumb:
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
},
],
genre: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
thumb:
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
},
],
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
guid: "plex://movie/5d7768ba96b655001fdc0408",
guids: [
{
id:
"{\"imdbExample\":{\"summary\":\"IMDB example\",\"value\":\"imdb://tt13015952\"},\"tmdbExample\":{\"summary\":\"TMDB example\",\"value\":\"tmdb://2434012\"},\"tvdbExample\":{\"summary\":\"TVDB example\",\"value\":\"tvdb://7945991\"}}",
},
],
key: "<key>",
lastViewedAt: 1556281940,
media: [
{
aspectRatio: 2.35,
audioChannels: 2,
audioCodec: "aac",
audioProfile: "lc",
bitrate: 5612,
container: "mov",
duration: 150192,
has64bitOffsets: false,
hasVoiceActivity: true,
height: 544,
id: 1,
optimizedForStreaming: false,
part: [
{
accessible: true,
audioProfile: "lc",
container: "mov",
duration: 150192,
exists: true,
file: "/home/schuyler/Videos/Trailers/Cloud Atlas (2012).mov",
has64bitOffsets: false,
id: 1,
indexes: "sd",
key: "/library/parts/1/1531779263/file.mov",
optimizedForStreaming: false,
size: 105355654,
stream: [
{
default: true,
audioChannelLayout: "5.1(side)",
channels: 6,
bitDepth: 10,
doviblCompatID: 1,
doviblPresent: true,
dovielPresent: false,
doviLevel: 6,
doviPresent: true,
doviProfile: 8,
dovirpuPresent: true,
doviVersion: "1.0",
bitrate: 24743,
canAutoSync: false,
chromaLocation: "topleft",
chromaSubsampling: "4:2:0",
codedHeight: 1608,
codedWidth: 3840,
closedCaptions: true,
codec: "hevc",
colorPrimaries: "bt2020",
colorRange: "tv",
colorSpace: "bt2020nc",
colorTrc: "smpte2084",
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
frameRate: 23.976,
hasScalingMatrix: false,
height: 1602,
id: 1002625,
index: 0,
key: "/library/streams/216389",
language: "English",
languageCode: "eng",
languageTag: "en",
format: "srt",
headerCompression: true,
level: 150,
original: true,
profile: "main 10",
refFrames: 1,
samplingRate: 48000,
scanType: "progressive",
embeddedInVideo: "progressive",
selected: true,
forced: true,
hearingImpaired: true,
dub: true,
title: "SDH",
streamIdentifier: 1,
width: 3840,
},
],
videoProfile: "main",
},
],
videoCodec: "h264",
videoFrameRate: "24p",
videoProfile: "main",
videoResolution: "720",
width: 1280,
},
],
originallyAvailableAt: new Date("2022-12-14"),
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
ratingArray: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
thumb:
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
},
],
role: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
thumb:
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
},
],
theme: "/library/metadata/1/theme/1705636920",
thumb: "/library/metadata/58683/thumb/1703239236",
writer: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
thumb:
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
},
],
},
],
},
},
};
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `headers` | Record<string, *string*[]> | :heavy_check_mark: | N/A |
| `result` | [shared.MediaContainerWithMetadata](../../models/shared/mediacontainerwithmetadata.md) | :heavy_check_mark: | N/A |

2
docs/sdk/models/operations/bandwidth.md → docs/models/operations/bandwidth.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { Bandwidth } from "@lukehagar/plexjs/sdk/models/operations";
import { Bandwidth } from "@lukehagar/plexjs/models/operations";
let value: Bandwidth = {};
```

17
docs/models/operations/bandwidths.md Normal file
View File

@@ -0,0 +1,17 @@
# Bandwidths
A list of media times and bandwidths when trascoding is using with auto adjustment of bandwidth
## Example Usage
```typescript
import { Bandwidths } from "@lukehagar/plexjs/models/operations";
let value: Bandwidths = {};
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `bandwidth` | [operations.Bandwidth](../../models/operations/bandwidth.md)[] | :heavy_minus_sign: | N/A |

19
docs/models/operations/billing.md Normal file
View File

@@ -0,0 +1,19 @@
# Billing
## Example Usage
```typescript
import { Billing } from "@lukehagar/plexjs/models/operations";
let value: Billing = {
internalPaymentMethod: {},
paymentMethodId: 575569,
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `internalPaymentMethod` | [operations.InternalPaymentMethod](../../models/operations/internalpaymentmethod.md) | :heavy_check_mark: | N/A |
| `paymentMethodId` | *number* | :heavy_check_mark: | N/A |

15
docs/models/operations/butlertasks.md Normal file
View File

@@ -0,0 +1,15 @@
# ButlerTasks
## Example Usage
```typescript
import { ButlerTasks } from "@lukehagar/plexjs/models/operations";
let value: ButlerTasks = {};
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `butlerTask` | [operations.GetTasksButlerTask](../../models/operations/gettasksbutlertask.md)[] | :heavy_minus_sign: | N/A |

4
docs/sdk/models/operations/cancelactivityglobals.md → docs/models/operations/cancelactivityglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { CancelActivityGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { CancelActivityGlobals } from "@lukehagar/plexjs/models/operations";
let value: CancelActivityGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: CancelActivityGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/cancelactivityrequest.md → docs/models/operations/cancelactivityrequest.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { CancelActivityRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { CancelActivityRequest } from "@lukehagar/plexjs/models/operations";
let value: CancelActivityRequest = {
activityId: "d6199ba1-fb5e-4cae-bf17-1a5369c1cf1e",
@@ -14,7 +14,7 @@ let value: CancelActivityRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/cancelgrabglobals.md → docs/models/operations/cancelgrabglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { CancelGrabGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { CancelGrabGlobals } from "@lukehagar/plexjs/models/operations";
let value: CancelGrabGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: CancelGrabGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/cancelgrabrequest.md → docs/models/operations/cancelgrabrequest.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { CancelGrabRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { CancelGrabRequest } from "@lukehagar/plexjs/models/operations";
let value: CancelGrabRequest = {
operationId: "<id>",
@@ -14,7 +14,7 @@ let value: CancelGrabRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/cancelrefreshglobals.md → docs/models/operations/cancelrefreshglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { CancelRefreshGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { CancelRefreshGlobals } from "@lukehagar/plexjs/models/operations";
let value: CancelRefreshGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: CancelRefreshGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/cancelrefreshrequest.md → docs/models/operations/cancelrefreshrequest.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { CancelRefreshRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { CancelRefreshRequest } from "@lukehagar/plexjs/models/operations";
let value: CancelRefreshRequest = {
sectionId: 569134,
@@ -14,7 +14,7 @@ let value: CancelRefreshRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

2
docs/sdk/models/operations/channelmappingbykey.md → docs/models/operations/channelmappingbykey.md
View File

@@ -5,7 +5,7 @@ The mapping of changes, passed as a map of device channel to lineup key.
## Example Usage
```typescript
import { ChannelMappingByKey } from "@lukehagar/plexjs/sdk/models/operations";
import { ChannelMappingByKey } from "@lukehagar/plexjs/models/operations";
let value: ChannelMappingByKey = {};
```

4
docs/sdk/models/operations/checkupdatesglobals.md → docs/models/operations/checkupdatesglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { CheckUpdatesGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { CheckUpdatesGlobals } from "@lukehagar/plexjs/models/operations";
let value: CheckUpdatesGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: CheckUpdatesGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

8
docs/sdk/models/operations/checkupdatesrequest.md → docs/models/operations/checkupdatesrequest.md
View File

@@ -3,8 +3,8 @@
## Example Usage
```typescript
import { CheckUpdatesRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
import { CheckUpdatesRequest } from "@lukehagar/plexjs/models/operations";
import { BoolInt } from "@lukehagar/plexjs/models/shared";
let value: CheckUpdatesRequest = {
download: BoolInt.True,
@@ -15,7 +15,7 @@ let value: CheckUpdatesRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
@@ -26,4 +26,4 @@ let value: CheckUpdatesRequest = {
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `download` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |
| `download` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |

2
docs/sdk/models/operations/chromasubsampling.md → docs/models/operations/chromasubsampling.md
View File

@@ -10,7 +10,7 @@ Defaults to 3 (444)
## Example Usage
```typescript
import { ChromaSubsampling } from "@lukehagar/plexjs/sdk/models/operations";
import { ChromaSubsampling } from "@lukehagar/plexjs/models/operations";
let value: ChromaSubsampling = ChromaSubsampling.Two;
```

4
docs/sdk/models/operations/clearplaylistitemsglobals.md → docs/models/operations/clearplaylistitemsglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ClearPlaylistItemsGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { ClearPlaylistItemsGlobals } from "@lukehagar/plexjs/models/operations";
let value: ClearPlaylistItemsGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: ClearPlaylistItemsGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/clearplaylistitemsrequest.md → docs/models/operations/clearplaylistitemsrequest.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ClearPlaylistItemsRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { ClearPlaylistItemsRequest } from "@lukehagar/plexjs/models/operations";
let value: ClearPlaylistItemsRequest = {
playlistId: 236302,
@@ -14,7 +14,7 @@ let value: ClearPlaylistItemsRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/clearplayqueueglobals.md → docs/models/operations/clearplayqueueglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ClearPlayQueueGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { ClearPlayQueueGlobals } from "@lukehagar/plexjs/models/operations";
let value: ClearPlayQueueGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: ClearPlayQueueGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/clearplayqueuerequest.md → docs/models/operations/clearplayqueuerequest.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ClearPlayQueueRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { ClearPlayQueueRequest } from "@lukehagar/plexjs/models/operations";
let value: ClearPlayQueueRequest = {
playQueueId: 442842,
@@ -14,7 +14,7 @@ let value: ClearPlayQueueRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

2
docs/sdk/models/operations/computechannelmapchannelmapping.md → docs/models/operations/computechannelmapchannelmapping.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ComputeChannelMapChannelMapping } from "@lukehagar/plexjs/sdk/models/operations";
import { ComputeChannelMapChannelMapping } from "@lukehagar/plexjs/models/operations";
let value: ComputeChannelMapChannelMapping = {};
```

4
docs/sdk/models/operations/computechannelmapglobals.md → docs/models/operations/computechannelmapglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ComputeChannelMapGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { ComputeChannelMapGlobals } from "@lukehagar/plexjs/models/operations";
let value: ComputeChannelMapGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: ComputeChannelMapGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/computechannelmapmediacontainer.md → docs/models/operations/computechannelmapmediacontainer.md
View File

@@ -8,7 +8,7 @@ The container often "hoists" common attributes from its children. For example, i
## Example Usage
```typescript
import { ComputeChannelMapMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
import { ComputeChannelMapMediaContainer } from "@lukehagar/plexjs/models/operations";
let value: ComputeChannelMapMediaContainer = {};
```
@@ -21,4 +21,4 @@ let value: ComputeChannelMapMediaContainer = {};
| `offset` | *number* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
| `size` | *number* | :heavy_minus_sign: | N/A |
| `totalSize` | *number* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
| `channelMapping` | [operations.ComputeChannelMapChannelMapping](../../../sdk/models/operations/computechannelmapchannelmapping.md)[] | :heavy_minus_sign: | N/A |
| `channelMapping` | [operations.ComputeChannelMapChannelMapping](../../models/operations/computechannelmapchannelmapping.md)[] | :heavy_minus_sign: | N/A |

4
docs/sdk/models/operations/computechannelmaprequest.md → docs/models/operations/computechannelmaprequest.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ComputeChannelMapRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { ComputeChannelMapRequest } from "@lukehagar/plexjs/models/operations";
let value: ComputeChannelMapRequest = {
deviceQueryParameter: "<value>",
@@ -15,7 +15,7 @@ let value: ComputeChannelMapRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

19
docs/models/operations/computechannelmapresponse.md Normal file
View File

@@ -0,0 +1,19 @@
# ComputeChannelMapResponse
## Example Usage
```typescript
import { ComputeChannelMapResponse } from "@lukehagar/plexjs/models/operations";
let value: ComputeChannelMapResponse = {
headers: {},
result: {},
};
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `headers` | Record<string, *string*[]> | :heavy_check_mark: | N/A |
| `result` | [operations.ComputeChannelMapResponseBody](../../models/operations/computechannelmapresponsebody.md) | :heavy_check_mark: | N/A |

17
docs/models/operations/computechannelmapresponsebody.md Normal file
View File

@@ -0,0 +1,17 @@
# ComputeChannelMapResponseBody
OK
## Example Usage
```typescript
import { ComputeChannelMapResponseBody } from "@lukehagar/plexjs/models/operations";
let value: ComputeChannelMapResponseBody = {};
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.ComputeChannelMapMediaContainer](../../models/operations/computechannelmapmediacontainer.md) | :heavy_minus_sign: | N/A |

2
docs/sdk/models/operations/connection.md → docs/models/operations/connection.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { Connection } from "@lukehagar/plexjs/sdk/models/operations";
import { Connection } from "@lukehagar/plexjs/models/operations";
let value: Connection = {};
```

4
docs/sdk/models/operations/connectwebsocketglobals.md → docs/models/operations/connectwebsocketglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ConnectWebSocketGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { ConnectWebSocketGlobals } from "@lukehagar/plexjs/models/operations";
let value: ConnectWebSocketGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: ConnectWebSocketGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/connectwebsocketrequest.md → docs/models/operations/connectwebsocketrequest.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ConnectWebSocketRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { ConnectWebSocketRequest } from "@lukehagar/plexjs/models/operations";
let value: ConnectWebSocketRequest = {};
```
@@ -12,7 +12,7 @@ let value: ConnectWebSocketRequest = {};
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

4
docs/sdk/models/operations/createcollectionglobals.md → docs/models/operations/createcollectionglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { CreateCollectionGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { CreateCollectionGlobals } from "@lukehagar/plexjs/models/operations";
let value: CreateCollectionGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: CreateCollectionGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

8
docs/sdk/models/operations/createcollectionrequest.md → docs/models/operations/createcollectionrequest.md
View File

@@ -3,8 +3,8 @@
## Example Usage
```typescript
import { CreateCollectionRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { MediaType } from "@lukehagar/plexjs/sdk/models/shared";
import { CreateCollectionRequest } from "@lukehagar/plexjs/models/operations";
import { MediaType } from "@lukehagar/plexjs/models/shared";
let value: CreateCollectionRequest = {
sectionId: "<id>",
@@ -16,7 +16,7 @@ let value: CreateCollectionRequest = {
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
@@ -31,4 +31,4 @@ let value: CreateCollectionRequest = {
| `title` | *string* | :heavy_minus_sign: | The title to filter by or assign | |
| `smart` | *boolean* | :heavy_minus_sign: | Whether this is a smart collection/playlist | |
| `uri` | *string* | :heavy_minus_sign: | The URI for processing the smart collection. Required for a smart collection | |
| `type` | [shared.MediaType](../../../sdk/models/shared/mediatype.md) | :heavy_minus_sign: | The type of media to retrieve or filter by.<br/><br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>5 = artist<br/>6 = album<br/>7 = track<br/>8 = photo_album<br/>9 = photo<br/><br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `type` | [shared.MediaType](../../models/shared/mediatype.md) | :heavy_minus_sign: | The type of media to retrieve or filter by.<br/><br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>5 = artist<br/>6 = album<br/>7 = track<br/>8 = photo_album<br/>9 = photo<br/><br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

4
docs/sdk/models/operations/createcustomhubglobals.md → docs/models/operations/createcustomhubglobals.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { CreateCustomHubGlobals } from "@lukehagar/plexjs/sdk/models/operations";
import { CreateCustomHubGlobals } from "@lukehagar/plexjs/models/operations";
let value: CreateCustomHubGlobals = {
clientIdentifier: "abc123",
@@ -23,7 +23,7 @@ let value: CreateCustomHubGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |

12
docs/sdk/models/operations/createcustomhubrequest.md → docs/models/operations/createcustomhubrequest.md
View File

@@ -3,8 +3,8 @@
## Example Usage
```typescript
import { CreateCustomHubRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
import { CreateCustomHubRequest } from "@lukehagar/plexjs/models/operations";
import { BoolInt } from "@lukehagar/plexjs/models/shared";
let value: CreateCustomHubRequest = {
sectionId: 94028,
@@ -19,7 +19,7 @@ let value: CreateCustomHubRequest = {
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
@@ -32,6 +32,6 @@ let value: CreateCustomHubRequest = {
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `sectionId` | *number* | :heavy_check_mark: | The section ID for the hubs to reorder | |
| `metadataItemId` | *number* | :heavy_check_mark: | The metadata item on which to base this hub. This must currently be a collection | |
| `promotedToRecommended` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Whether this hub should be displayed in recommended | 1 |
| `promotedToOwnHome` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Whether this hub should be displayed in admin's home | 1 |
| `promotedToSharedHome` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Whether this hub should be displayed in shared user's home | 1 |
| `promotedToRecommended` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Whether this hub should be displayed in recommended | 1 |
| `promotedToOwnHome` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Whether this hub should be displayed in admin's home | 1 |
| `promotedToSharedHome` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Whether this hub should be displayed in shared user's home | 1 |

Some files were not shown because too many files have changed in this diff Show More