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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6

Browse Source
This commit is contained in:
speakeasybot
2024-10-02 02:30:07 +00:00
parent 2492807c65
commit 1cfbd17f28
135 changed files with 2545 additions and 1686 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/sdk/models/operations/getbannerimagerequest.md
View File

@@ -24,4 +24,4 @@ let value: GetBannerImageRequest = {
| `height` | *number* | :heavy_check_mark: | N/A | 396 |
| `minSize` | *number* | :heavy_check_mark: | N/A | 1 |
| `upscale` | *number* | :heavy_check_mark: | N/A | 1 |
| `xPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

4
docs/sdk/models/operations/getlibrarydetailsrequest.md
View File

@@ -14,5 +14,5 @@ let value: GetLibraryDetailsRequest = {
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `includeDetails` | [operations.IncludeDetails](../../../sdk/models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
| `includeDetails` | [operations.IncludeDetails](../../../sdk/models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |

4
docs/sdk/models/operations/getlibraryitemsrequest.md
View File

@@ -12,10 +12,10 @@ import {
} from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsRequest = {
sectionKey: 9518,
tag: Tag.FirstCharacter,
includeGuids: IncludeGuids.Enable,
type: GetLibraryItemsQueryParamType.TvShow,
sectionKey: 9518,
includeMeta: GetLibraryItemsQueryParamIncludeMeta.Enable,
xPlexContainerStart: 0,
xPlexContainerSize: 50,
@@ -26,10 +26,10 @@ let value: GetLibraryItemsRequest = {
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `tag` | [operations.Tag](../../../sdk/models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
| `includeGuids` | [operations.IncludeGuids](../../../sdk/models/operations/includeguids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `type` | [operations.GetLibraryItemsQueryParamType](../../../sdk/models/operations/getlibraryitemsqueryparamtype.md) | :heavy_minus_sign: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `includeMeta` | [operations.GetLibraryItemsQueryParamIncludeMeta](../../../sdk/models/operations/getlibraryitemsqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `xPlexContainerStart` | *number* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `xPlexContainerSize` | *number* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |

6
docs/sdk/models/operations/getmediaprovidersrequest.md
View File

@@ -12,6 +12,6 @@ let value: GetMediaProvidersRequest = {
## Fields
| Field | Type | Required | Description | Example |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `xPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| Field | Type | Required | Description | Example |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

2
docs/sdk/models/operations/getmetadatachildrenmediacontainer.md
View File

@@ -50,7 +50,7 @@ let value: GetMetadataChildrenMediaContainer = {
parentKey: "/library/metadata/30072",
parentTitle: "Reacher",
summary:
"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.",
"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge.",
index: 2,
parentIndex: 1,
viewCount: 11,

4
docs/sdk/models/operations/getmetadatachildrenmetadata.md
View File

@@ -17,7 +17,7 @@ let value: GetMetadataChildrenMetadata = {
parentKey: "/library/metadata/30072",
parentTitle: "Reacher",
summary:
"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.",
"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge.",
index: 2,
parentIndex: 1,
viewCount: 11,
@@ -51,7 +51,7 @@ let value: GetMetadataChildrenMetadata = {
| `title` | *string* | :heavy_minus_sign: | N/A | Season 2 |
| `parentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072 |
| `parentTitle` | *string* | :heavy_minus_sign: | N/A | Reacher |
| `summary` | *string* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge. |
| `summary` | *string* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge. |
| `index` | *number* | :heavy_minus_sign: | N/A | 2 |
| `parentIndex` | *number* | :heavy_minus_sign: | N/A | 1 |
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 11 |

2
docs/sdk/models/operations/getmetadatachildrenresponse.md
View File

@@ -57,7 +57,7 @@ let value: GetMetadataChildrenResponse = {
parentKey: "/library/metadata/30072",
parentTitle: "Reacher",
summary:
"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.",
"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge.",
index: 2,
parentIndex: 1,
viewCount: 11,

2
docs/sdk/models/operations/getmetadatachildrenresponsebody.md
View File

@@ -53,7 +53,7 @@ let value: GetMetadataChildrenResponseBody = {
parentKey: "/library/metadata/30072",
parentTitle: "Reacher",
summary:
"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.",
"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge.",
index: 2,
parentIndex: 1,
viewCount: 11,

14
docs/sdk/models/operations/getpinglobals.md
View File

@@ -10,10 +10,10 @@ let value: GetPinGlobals = {};
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) | Plex Web |
| `deviceName` | *string* | :heavy_minus_sign: | The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) | Linux |
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) | 4.133.0 |
| `clientPlatform` | *string* | :heavy_minus_sign: | The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) | Chrome |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client application. | Roku |

16
docs/sdk/models/operations/getpinrequest.md
View File

@@ -10,11 +10,11 @@ let value: GetPinRequest = {};
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `strong` | *boolean* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) | Plex Web |
| `deviceName` | *string* | :heavy_minus_sign: | The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) | Linux |
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) | 4.133.0 |
| `clientPlatform` | *string* | :heavy_minus_sign: | The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) | Chrome |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `strong` | *boolean* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client application. | Roku |

6
docs/sdk/models/operations/getrefreshlibrarymetadatarequest.md
View File

@@ -6,8 +6,8 @@
import { Force, GetRefreshLibraryMetadataRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetRefreshLibraryMetadataRequest = {
sectionKey: 9518,
force: Force.One,
sectionKey: 9518,
};
```
@@ -15,5 +15,5 @@ let value: GetRefreshLibraryMetadataRequest = {
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `force` | [operations.Force](../../../sdk/models/operations/force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |
| `force` | [operations.Force](../../../sdk/models/operations/force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |

6
docs/sdk/models/operations/getserverresourcesglobals.md
View File

@@ -10,6 +10,6 @@ let value: GetServerResourcesGlobals = {};
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |

12
docs/sdk/models/operations/getserverresourcesrequest.md
View File

@@ -14,9 +14,9 @@ let value: GetServerResourcesRequest = {
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `includeHttps` | [operations.IncludeHttps](../../../sdk/models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `includeRelay` | [operations.IncludeRelay](../../../sdk/models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `includeIPv6` | [operations.IncludeIPv6](../../../sdk/models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `includeHttps` | [operations.IncludeHttps](../../../sdk/models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `includeRelay` | [operations.IncludeRelay](../../../sdk/models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `includeIPv6` | [operations.IncludeIPv6](../../../sdk/models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |

2
docs/sdk/models/operations/getthumbimagerequest.md
View File

@@ -24,4 +24,4 @@ let value: GetThumbImageRequest = {
| `height` | *number* | :heavy_check_mark: | N/A | 396 |
| `minSize` | *number* | :heavy_check_mark: | N/A | 1 |
| `upscale` | *number* | :heavy_check_mark: | N/A | 1 |
| `xPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

14
docs/sdk/models/operations/gettokenbypinidglobals.md
View File

@@ -10,10 +10,10 @@ let value: GetTokenByPinIdGlobals = {};
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) | Plex Web |
| `deviceName` | *string* | :heavy_minus_sign: | The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) | Linux |
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) | 4.133.0 |
| `clientPlatform` | *string* | :heavy_minus_sign: | The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) | Chrome |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client application. | Roku |

16
docs/sdk/models/operations/gettokenbypinidrequest.md
View File

@@ -12,11 +12,11 @@ let value: GetTokenByPinIdRequest = {
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pinID` | *number* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) | Plex Web |
| `deviceName` | *string* | :heavy_minus_sign: | The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) | Linux |
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) | 4.133.0 |
| `clientPlatform` | *string* | :heavy_minus_sign: | The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) | Chrome |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `pinID` | *number* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client application. | Roku |

6
docs/sdk/models/operations/gettopwatchedcontentrequest.md
View File

@@ -6,8 +6,8 @@
import { GetTopWatchedContentQueryParamType, GetTopWatchedContentRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetTopWatchedContentRequest = {
type: GetTopWatchedContentQueryParamType.TvShow,
includeGuids: 1,
type: GetTopWatchedContentQueryParamType.TvShow,
};
```
@@ -15,5 +15,5 @@ let value: GetTopWatchedContentRequest = {
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | [operations.GetTopWatchedContentQueryParamType](../../../sdk/models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `includeGuids` | *number* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `includeGuids` | *number* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `type` | [operations.GetTopWatchedContentQueryParamType](../../../sdk/models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

2
docs/sdk/models/operations/getwatchlistrequest.md
View File

@@ -25,4 +25,4 @@ let value: GetWatchListRequest = {
| `includeExternalMedia` | [operations.IncludeExternalMedia](../../../sdk/models/operations/includeexternalmedia.md) | :heavy_minus_sign: | include external media in the results<br/> | |
| `xPlexContainerStart` | *number* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `xPlexContainerSize` | *number* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
| `xPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

14
docs/sdk/models/operations/postuserssignindataglobals.md
View File

@@ -10,10 +10,10 @@ let value: PostUsersSignInDataGlobals = {};
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) | Plex Web |
| `deviceName` | *string* | :heavy_minus_sign: | The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) | Linux |
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) | 4.133.0 |
| `clientPlatform` | *string* | :heavy_minus_sign: | The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) | Chrome |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client application. | Roku |

16
docs/sdk/models/operations/postuserssignindatarequest.md
View File

@@ -16,11 +16,11 @@ let value: PostUsersSignInDataRequest = {
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) | Plex Web |
| `deviceName` | *string* | :heavy_minus_sign: | The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) | Linux |
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) | 4.133.0 |
| `clientPlatform` | *string* | :heavy_minus_sign: | The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) | Chrome |
| `requestBody` | [operations.PostUsersSignInDataRequestBody](../../../sdk/models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client application. | Roku |
| `requestBody` | [operations.PostUsersSignInDataRequestBody](../../../sdk/models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | |