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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.456.1

Browse Source
This commit is contained in:
speakeasybot
2024-12-20 16:02:41 +00:00
parent c10e011a68
commit 4e989e0de3
305 changed files with 12286 additions and 2514 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -111,7 +111,7 @@ let value: GetLibraryItemsMediaContainer = {
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
showOrdering: GetLibraryItemsShowOrdering.Dvd,
showOrdering: GetLibraryItemsShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236",

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

@@ -35,7 +35,7 @@ let value: GetLibraryItemsMetadata = {
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
showOrdering: GetLibraryItemsShowOrdering.Dvd,
showOrdering: GetLibraryItemsShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236",
@@ -250,7 +250,7 @@ let value: GetLibraryItemsMetadata = {
| `seasonCount` | *number* | :heavy_minus_sign: | N/A | 2022 |
| `tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `flattenSeasons` | [operations.GetLibraryItemsFlattenSeasons](../../../sdk/models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
| `showOrdering` | [operations.GetLibraryItemsShowOrdering](../../../sdk/models/operations/getlibraryitemsshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
| `showOrdering` | [operations.GetLibraryItemsShowOrdering](../../../sdk/models/operations/getlibraryitemsshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>tvdbAiring = TheTVDB (Aired),<br/>tvdbDvd = TheTVDB (DVD),<br/>tvdbAbsolute = TheTVDB (Absolute)).<br/> | tvdbDvd |
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |

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

@@ -24,4 +24,6 @@ let value: GetLibraryItemsQueryParamType = GetLibraryItemsQueryParamType.TvShow;
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

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

@@ -12,7 +12,7 @@ import {
} from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsRequest = {
tag: Tag.FirstCharacter,
tag: Tag.Folder,
includeGuids: IncludeGuids.Enable,
type: GetLibraryItemsQueryParamType.TvShow,
sectionKey: 9518,

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

@@ -115,7 +115,7 @@ let value: GetLibraryItemsResponse = {
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
showOrdering: GetLibraryItemsShowOrdering.Dvd,
showOrdering: GetLibraryItemsShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236",

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

@@ -111,7 +111,7 @@ let value: GetLibraryItemsResponseBody = {
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
showOrdering: GetLibraryItemsShowOrdering.Dvd,
showOrdering: GetLibraryItemsShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236",

28
docs/sdk/models/operations/getlibraryitemsshowordering.md
View File

@@ -1,11 +1,11 @@
# GetLibraryItemsShowOrdering
Setting that indicates the episode ordering for the show
None = Library default,
tmdbAiring = The Movie Database (Aired),
aired = TheTVDB (Aired),
dvd = TheTVDB (DVD),
absolute = TheTVDB (Absolute)).
Setting that indicates the episode ordering for the show
None = Library default,
tmdbAiring = The Movie Database (Aired),
tvdbAiring = TheTVDB (Aired),
tvdbDvd = TheTVDB (DVD),
tvdbAbsolute = TheTVDB (Absolute)).
## Example Usage
@@ -13,15 +13,15 @@ absolute = TheTVDB (Absolute)).
```typescript
import { GetLibraryItemsShowOrdering } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsShowOrdering = GetLibraryItemsShowOrdering.Dvd;
let value: GetLibraryItemsShowOrdering = GetLibraryItemsShowOrdering.TvdbDvd;
```
## Values
| Name | Value |
| ------------ | ------------ |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `Aired` | aired |
| `Dvd` | dvd |
| `Absolute` | absolute |
| Name | Value |
| -------------- | -------------- |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `TvdbAiring` | tvdbAiring |
| `TvdbDvd` | tvdbDvd |
| `TvdbAbsolute` | tvdbAbsolute |

5
docs/sdk/models/operations/getmetadatabyratingkeymetadata.md
View File

@@ -185,6 +185,11 @@ let value: GetMetaDataByRatingKeyMetadata = {
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `grandparentTitle` | *string* | :heavy_minus_sign: | The name of the album artist for the track when audio, and the name of the TV show for the episode when video. | |
| `parentTitle` | *string* | :heavy_minus_sign: | The name of the album for the track when audio, and the name of the season for the episode when TV show. | |
| `originalTitle` | *string* | :heavy_minus_sign: | The orginal untranslated name of the media item when non-english. | |
| `index` | *number* | :heavy_minus_sign: | The index starting from 0 of this media item in the MetaData array. | |
| `parentIndex` | *number* | :heavy_minus_sign: | The parent index starting from 0 of this media item in the parent MetaData array. | |
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 |
| `summary` | *string* | :heavy_minus_sign: | N/A | Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job. |
| `rating` | *number* | :heavy_minus_sign: | N/A | 8.2 |

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

@@ -1,19 +0,0 @@
# GetPinGlobals
## Example Usage
```typescript
import { GetPinGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetPinGlobals = {};
```
## Fields
| 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 |

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

@@ -5,7 +5,13 @@
```typescript
import { GetPinRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetPinRequest = {};
let value: GetPinRequest = {
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
clientName: "Plex for Roku",
deviceNickname: "Roku 3",
clientVersion: "2.4.1",
platform: "Roku",
};
```
## Fields
@@ -13,7 +19,7 @@ let value: GetPinRequest = {};
| 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 |
| `clientID` | *string* | :heavy_check_mark: | 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 |

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

@@ -25,4 +25,6 @@ let value: GetPlaylistContentsQueryParamType =
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

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

@@ -91,7 +91,7 @@ let value: GetRecentlyAddedMediaContainer = {
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: FlattenSeasons.True,
showOrdering: ShowOrdering.Dvd,
showOrdering: ShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236",

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

@@ -35,7 +35,7 @@ let value: GetRecentlyAddedMetadata = {
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: FlattenSeasons.True,
showOrdering: ShowOrdering.Dvd,
showOrdering: ShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236",
@@ -250,7 +250,7 @@ let value: GetRecentlyAddedMetadata = {
| `seasonCount` | *number* | :heavy_minus_sign: | N/A | 2022 |
| `tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `flattenSeasons` | [operations.FlattenSeasons](../../../sdk/models/operations/flattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
| `showOrdering` | [operations.ShowOrdering](../../../sdk/models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
| `showOrdering` | [operations.ShowOrdering](../../../sdk/models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>tvdbAiring = TheTVDB (Aired),<br/>tvdbDvd = TheTVDB (DVD),<br/>tvdbAbsolute = TheTVDB (Absolute)).<br/> | tvdbDvd |
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |

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

@@ -98,7 +98,7 @@ let value: GetRecentlyAddedResponse = {
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: FlattenSeasons.True,
showOrdering: ShowOrdering.Dvd,
showOrdering: ShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236",

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

@@ -94,7 +94,7 @@ let value: GetRecentlyAddedResponseBody = {
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: FlattenSeasons.True,
showOrdering: ShowOrdering.Dvd,
showOrdering: ShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236",

15
docs/sdk/models/operations/getsearchalllibrariesglobals.md
View File

@@ -1,15 +0,0 @@
# GetSearchAllLibrariesGlobals
## Example Usage
```typescript
import { GetSearchAllLibrariesGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetSearchAllLibrariesGlobals = {};
```
## Fields
| 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 |

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

@@ -40,7 +40,7 @@ let value: GetSearchAllLibrariesMediaContainer = {
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.True,
showOrdering: GetSearchAllLibrariesShowOrdering.Dvd,
showOrdering: GetSearchAllLibrariesShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236",

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

@@ -35,7 +35,7 @@ let value: GetSearchAllLibrariesMetadata = {
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.True,
showOrdering: GetSearchAllLibrariesShowOrdering.Dvd,
showOrdering: GetSearchAllLibrariesShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236",
@@ -250,7 +250,7 @@ let value: GetSearchAllLibrariesMetadata = {
| `seasonCount` | *number* | :heavy_minus_sign: | N/A | 2022 |
| `tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `flattenSeasons` | [operations.GetSearchAllLibrariesFlattenSeasons](../../../sdk/models/operations/getsearchalllibrariesflattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
| `showOrdering` | [operations.GetSearchAllLibrariesShowOrdering](../../../sdk/models/operations/getsearchalllibrariesshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
| `showOrdering` | [operations.GetSearchAllLibrariesShowOrdering](../../../sdk/models/operations/getsearchalllibrariesshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>tvdbAiring = TheTVDB (Aired),<br/>tvdbDvd = TheTVDB (DVD),<br/>tvdbAbsolute = TheTVDB (Absolute)).<br/> | tvdbDvd |
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |

3
docs/sdk/models/operations/getsearchalllibrariesrequest.md
View File

@@ -12,6 +12,7 @@ import {
let value: GetSearchAllLibrariesRequest = {
query: "<value>",
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
searchTypes: [
SearchTypes.OtherVideos,
],
@@ -25,7 +26,7 @@ let value: GetSearchAllLibrariesRequest = {
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `query` | *string* | :heavy_check_mark: | The search query term. | |
| `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 |
| `clientID` | *string* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `limit` | *number* | :heavy_minus_sign: | Limit the number of results returned. | |
| `searchTypes` | [operations.SearchTypes](../../../sdk/models/operations/searchtypes.md)[] | :heavy_minus_sign: | A comma-separated list of search types to include. Valid values are: movies, music, otherVideos, people, tv.<br/> | movies,music,otherVideos,people,tv |
| `includeCollections` | [operations.QueryParamIncludeCollections](../../../sdk/models/operations/queryparamincludecollections.md) | :heavy_minus_sign: | Whether to include collections in the search results. | 1 |

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

@@ -47,7 +47,7 @@ let value: GetSearchAllLibrariesResponse = {
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.True,
showOrdering: GetSearchAllLibrariesShowOrdering.Dvd,
showOrdering: GetSearchAllLibrariesShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236",

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

@@ -43,7 +43,7 @@ let value: GetSearchAllLibrariesResponseBody = {
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.True,
showOrdering: GetSearchAllLibrariesShowOrdering.Dvd,
showOrdering: GetSearchAllLibrariesShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236",

28
docs/sdk/models/operations/getsearchalllibrariesshowordering.md
View File

@@ -1,11 +1,11 @@
# GetSearchAllLibrariesShowOrdering
Setting that indicates the episode ordering for the show
None = Library default,
tmdbAiring = The Movie Database (Aired),
aired = TheTVDB (Aired),
dvd = TheTVDB (DVD),
absolute = TheTVDB (Absolute)).
Setting that indicates the episode ordering for the show
None = Library default,
tmdbAiring = The Movie Database (Aired),
tvdbAiring = TheTVDB (Aired),
tvdbDvd = TheTVDB (DVD),
tvdbAbsolute = TheTVDB (Absolute)).
## Example Usage
@@ -14,15 +14,15 @@ absolute = TheTVDB (Absolute)).
import { GetSearchAllLibrariesShowOrdering } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetSearchAllLibrariesShowOrdering =
GetSearchAllLibrariesShowOrdering.Dvd;
GetSearchAllLibrariesShowOrdering.TvdbDvd;
```
## Values
| Name | Value |
| ------------ | ------------ |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `Aired` | aired |
| `Dvd` | dvd |
| `Absolute` | absolute |
| Name | Value |
| -------------- | -------------- |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `TvdbAiring` | tvdbAiring |
| `TvdbDvd` | tvdbDvd |
| `TvdbAbsolute` | tvdbAbsolute |

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

@@ -25,4 +25,6 @@ let value: GetSearchLibraryQueryParamType =
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

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

@@ -1,15 +0,0 @@
# GetServerResourcesGlobals
## Example Usage
```typescript
import { GetServerResourcesGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetServerResourcesGlobals = {};
```
## Fields
| 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 |

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

@@ -9,6 +9,7 @@ let value: GetServerResourcesRequest = {
includeHttps: IncludeHttps.Enable,
includeRelay: IncludeRelay.Enable,
includeIPv6: IncludeIPv6.Enable,
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
};
```
@@ -19,4 +20,4 @@ let value: GetServerResourcesRequest = {
| `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 |
| `clientID` | *string* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |

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

@@ -1,19 +0,0 @@
# GetTokenByPinIdGlobals
## Example Usage
```typescript
import { GetTokenByPinIdGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetTokenByPinIdGlobals = {};
```
## Fields
| 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 |

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

@@ -7,6 +7,11 @@ import { GetTokenByPinIdRequest } from "@lukehagar/plexjs/sdk/models/operations"
let value: GetTokenByPinIdRequest = {
pinID: 396506,
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
clientName: "Plex for Roku",
deviceNickname: "Roku 3",
clientVersion: "2.4.1",
platform: "Roku",
};
```
@@ -15,7 +20,7 @@ let value: GetTokenByPinIdRequest = {
| 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 |
| `clientID` | *string* | :heavy_check_mark: | 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 |

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

@@ -25,4 +25,6 @@ let value: GetTopWatchedContentQueryParamType =
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

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

@@ -1,19 +0,0 @@
# PostUsersSignInDataGlobals
## Example Usage
```typescript
import { PostUsersSignInDataGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: PostUsersSignInDataGlobals = {};
```
## Fields
| 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 |

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

@@ -6,6 +6,11 @@
import { PostUsersSignInDataRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: PostUsersSignInDataRequest = {
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
clientName: "Plex for Roku",
deviceNickname: "Roku 3",
clientVersion: "2.4.1",
platform: "Roku",
requestBody: {
login: "username@email.com",
password: "password123",
@@ -18,7 +23,7 @@ let value: PostUsersSignInDataRequest = {
| 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 |
| `clientID` | *string* | :heavy_check_mark: | 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 |

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

@@ -24,4 +24,6 @@ let value: QueryParamType = QueryParamType.TvShow;
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

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

@@ -37,7 +37,7 @@ let value: SearchResult = {
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.True,
showOrdering: GetSearchAllLibrariesShowOrdering.Dvd,
showOrdering: GetSearchAllLibrariesShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236",

28
docs/sdk/models/operations/showordering.md
View File

@@ -1,11 +1,11 @@
# ShowOrdering
Setting that indicates the episode ordering for the show
None = Library default,
tmdbAiring = The Movie Database (Aired),
aired = TheTVDB (Aired),
dvd = TheTVDB (DVD),
absolute = TheTVDB (Absolute)).
Setting that indicates the episode ordering for the show
None = Library default,
tmdbAiring = The Movie Database (Aired),
tvdbAiring = TheTVDB (Aired),
tvdbDvd = TheTVDB (DVD),
tvdbAbsolute = TheTVDB (Absolute)).
## Example Usage
@@ -13,15 +13,15 @@ absolute = TheTVDB (Absolute)).
```typescript
import { ShowOrdering } from "@lukehagar/plexjs/sdk/models/operations";
let value: ShowOrdering = ShowOrdering.Dvd;
let value: ShowOrdering = ShowOrdering.TvdbDvd;
```
## Values
| Name | Value |
| ------------ | ------------ |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `Aired` | aired |
| `Dvd` | dvd |
| `Absolute` | absolute |
| Name | Value |
| -------------- | -------------- |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `TvdbAiring` | tvdbAiring |
| `TvdbDvd` | tvdbDvd |
| `TvdbAbsolute` | tvdbAbsolute |

5
docs/sdk/models/operations/tag.md
View File

@@ -7,7 +7,7 @@ A key representing a specific tag within the section.
```typescript
import { Tag } from "@lukehagar/plexjs/sdk/models/operations";
let value: Tag = Tag.Unwatched;
let value: Tag = Tag.Newest;
```
## Values
@@ -32,4 +32,5 @@ let value: Tag = Tag.Unwatched;
| `Rating` | rating |
| `Resolution` | resolution |
| `FirstCharacter` | firstCharacter |
| `Folder` | folder |
| `Folder` | folder |
| `Albums` | albums |

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

@@ -24,4 +24,6 @@ let value: Type = Type.TvShow;
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |