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.474.0

Browse Source
This commit is contained in:
speakeasybot
2025-01-24 00:11:07 +00:00
parent b03cc6a609
commit cdcdc0ca8e
126 changed files with 1770 additions and 1173 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/sdk/models/operations/enablecreditsmarkergeneration.md Normal file
View File

@@ -0,0 +1,19 @@
# EnableCreditsMarkerGeneration
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
## Example Usage
```typescript
import { EnableCreditsMarkerGeneration } from "@lukehagar/plexjs/sdk/models/operations";
let value: EnableCreditsMarkerGeneration =
EnableCreditsMarkerGeneration.LibraryDefault;
```
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Disabled` | 0 |

19
docs/sdk/models/operations/episodesort.md Normal file
View File

@@ -0,0 +1,19 @@
# EpisodeSort
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
## Example Usage
```typescript
import { EpisodeSort } from "@lukehagar/plexjs/sdk/models/operations";
let value: EpisodeSort = EpisodeSort.OldestFirst;
```
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `OldestFirst` | 0 |
| `NewestFirst` | 1 |

13
docs/sdk/models/operations/flattenseasons.md
View File

@@ -1,16 +1,19 @@
# FlattenSeasons
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
## Example Usage
```typescript
import { FlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
let value: FlattenSeasons = FlattenSeasons.True;
let value: FlattenSeasons = FlattenSeasons.Show;
```
## Values
| Name | Value |
| ------- | ------- |
| `False` | 0 |
| `True` | 1 |
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Hide` | 0 |
| `Show` | 1 |

8
docs/sdk/models/operations/friend.md
View File

@@ -11,12 +11,8 @@ let value: Friend = {
home: true,
id: 0,
restricted: false,
sharedServers: [
{},
],
sharedSources: [
{},
],
sharedServers: [],
sharedSources: [],
status: Status.Accepted,
thumb: "https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578",
title: "username123",

19
docs/sdk/models/operations/getlibraryitemsenablecreditsmarkergeneration.md Normal file
View File

@@ -0,0 +1,19 @@
# GetLibraryItemsEnableCreditsMarkerGeneration
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
## Example Usage
```typescript
import { GetLibraryItemsEnableCreditsMarkerGeneration } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsEnableCreditsMarkerGeneration =
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault;
```
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Disabled` | 0 |

19
docs/sdk/models/operations/getlibraryitemsepisodesort.md Normal file
View File

@@ -0,0 +1,19 @@
# GetLibraryItemsEpisodeSort
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
## Example Usage
```typescript
import { GetLibraryItemsEpisodeSort } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsEpisodeSort = GetLibraryItemsEpisodeSort.OldestFirst;
```
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `OldestFirst` | 0 |
| `NewestFirst` | 1 |

13
docs/sdk/models/operations/getlibraryitemsflattenseasons.md
View File

@@ -1,16 +1,19 @@
# GetLibraryItemsFlattenSeasons
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
## Example Usage
```typescript
import { GetLibraryItemsFlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsFlattenSeasons = GetLibraryItemsFlattenSeasons.True;
let value: GetLibraryItemsFlattenSeasons = GetLibraryItemsFlattenSeasons.Show;
```
## Values
| Name | Value |
| ------- | ------- |
| `False` | 0 |
| `True` | 1 |
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Hide` | 0 |
| `Show` | 1 |

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

@@ -9,6 +9,8 @@ The Meta object is only included in the response if the `includeMeta` parameter
import {
GetLibraryItemsActiveDirection,
GetLibraryItemsDefaultDirection,
GetLibraryItemsEnableCreditsMarkerGeneration,
GetLibraryItemsEpisodeSort,
GetLibraryItemsFlattenSeasons,
GetLibraryItemsHasThumbnail,
GetLibraryItemsLibraryActiveDirection,
@@ -110,7 +112,10 @@ let value: GetLibraryItemsMediaContainer = {
year: 2022,
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetLibraryItemsShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",

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

@@ -4,6 +4,8 @@
```typescript
import {
GetLibraryItemsEnableCreditsMarkerGeneration,
GetLibraryItemsEpisodeSort,
GetLibraryItemsFlattenSeasons,
GetLibraryItemsHasThumbnail,
GetLibraryItemsLibraryResponse200Type,
@@ -34,7 +36,10 @@ let value: GetLibraryItemsMetadata = {
year: 2022,
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetLibraryItemsShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
@@ -249,7 +254,9 @@ let value: GetLibraryItemsMetadata = {
| `year` | *number* | :heavy_minus_sign: | N/A | 2022 |
| `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 |
| `flattenSeasons` | [operations.GetLibraryItemsFlattenSeasons](../../../sdk/models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
| `episodeSort` | [operations.GetLibraryItemsEpisodeSort](../../../sdk/models/operations/getlibraryitemsepisodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
| `enableCreditsMarkerGeneration` | [operations.GetLibraryItemsEnableCreditsMarkerGeneration](../../../sdk/models/operations/getlibraryitemsenablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -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/>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 |

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

@@ -6,6 +6,8 @@
import {
GetLibraryItemsActiveDirection,
GetLibraryItemsDefaultDirection,
GetLibraryItemsEnableCreditsMarkerGeneration,
GetLibraryItemsEpisodeSort,
GetLibraryItemsFlattenSeasons,
GetLibraryItemsHasThumbnail,
GetLibraryItemsLibraryActiveDirection,
@@ -114,7 +116,10 @@ let value: GetLibraryItemsResponse = {
year: 2022,
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetLibraryItemsShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",

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

@@ -8,6 +8,8 @@ The contents of the library by section and tag
import {
GetLibraryItemsActiveDirection,
GetLibraryItemsDefaultDirection,
GetLibraryItemsEnableCreditsMarkerGeneration,
GetLibraryItemsEpisodeSort,
GetLibraryItemsFlattenSeasons,
GetLibraryItemsHasThumbnail,
GetLibraryItemsLibraryActiveDirection,
@@ -110,7 +112,10 @@ let value: GetLibraryItemsResponseBody = {
year: 2022,
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetLibraryItemsShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",

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

@@ -6,7 +6,7 @@
import { GetMetadataChildrenRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMetadataChildrenRequest = {
ratingKey: 1716.30,
ratingKey: 1716.29,
};
```

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

@@ -6,7 +6,7 @@
import { GetPlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetPlaylistRequest = {
playlistID: 672.50,
playlistID: 672.49,
};
```

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

@@ -4,6 +4,8 @@
```typescript
import {
EnableCreditsMarkerGeneration,
EpisodeSort,
FlattenSeasons,
GetRecentlyAddedActiveDirection,
GetRecentlyAddedDefaultDirection,
@@ -90,7 +92,10 @@ let value: GetRecentlyAddedMediaContainer = {
year: 2022,
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: FlattenSeasons.True,
flattenSeasons: FlattenSeasons.Show,
episodeSort: EpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
EnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: ShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",

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

@@ -4,6 +4,8 @@
```typescript
import {
EnableCreditsMarkerGeneration,
EpisodeSort,
FlattenSeasons,
GetRecentlyAddedHubsResponseType,
GetRecentlyAddedHubsType,
@@ -34,7 +36,9 @@ let value: GetRecentlyAddedMetadata = {
year: 2022,
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: FlattenSeasons.True,
flattenSeasons: FlattenSeasons.Show,
episodeSort: EpisodeSort.OldestFirst,
enableCreditsMarkerGeneration: EnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: ShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
@@ -249,7 +253,9 @@ let value: GetRecentlyAddedMetadata = {
| `year` | *number* | :heavy_minus_sign: | N/A | 2022 |
| `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 |
| `flattenSeasons` | [operations.FlattenSeasons](../../../sdk/models/operations/flattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
| `episodeSort` | [operations.EpisodeSort](../../../sdk/models/operations/episodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
| `enableCreditsMarkerGeneration` | [operations.EnableCreditsMarkerGeneration](../../../sdk/models/operations/enablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -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/>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 |

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

@@ -4,6 +4,8 @@
```typescript
import {
EnableCreditsMarkerGeneration,
EpisodeSort,
FlattenSeasons,
GetRecentlyAddedActiveDirection,
GetRecentlyAddedDefaultDirection,
@@ -97,7 +99,10 @@ let value: GetRecentlyAddedResponse = {
year: 2022,
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: FlattenSeasons.True,
flattenSeasons: FlattenSeasons.Show,
episodeSort: EpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
EnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: ShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",

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

@@ -6,6 +6,8 @@ A successful response with recently added content.
```typescript
import {
EnableCreditsMarkerGeneration,
EpisodeSort,
FlattenSeasons,
GetRecentlyAddedActiveDirection,
GetRecentlyAddedDefaultDirection,
@@ -93,7 +95,10 @@ let value: GetRecentlyAddedResponseBody = {
year: 2022,
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: FlattenSeasons.True,
flattenSeasons: FlattenSeasons.Show,
episodeSort: EpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
EnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: ShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",

19
docs/sdk/models/operations/getsearchalllibrariesenablecreditsmarkergeneration.md Normal file
View File

@@ -0,0 +1,19 @@
# GetSearchAllLibrariesEnableCreditsMarkerGeneration
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
## Example Usage
```typescript
import { GetSearchAllLibrariesEnableCreditsMarkerGeneration } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetSearchAllLibrariesEnableCreditsMarkerGeneration =
GetSearchAllLibrariesEnableCreditsMarkerGeneration.LibraryDefault;
```
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Disabled` | 0 |

20
docs/sdk/models/operations/getsearchalllibrariesepisodesort.md Normal file
View File

@@ -0,0 +1,20 @@
# GetSearchAllLibrariesEpisodeSort
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
## Example Usage
```typescript
import { GetSearchAllLibrariesEpisodeSort } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetSearchAllLibrariesEpisodeSort =
GetSearchAllLibrariesEpisodeSort.OldestFirst;
```
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `OldestFirst` | 0 |
| `NewestFirst` | 1 |

13
docs/sdk/models/operations/getsearchalllibrariesflattenseasons.md
View File

@@ -1,17 +1,20 @@
# GetSearchAllLibrariesFlattenSeasons
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
## Example Usage
```typescript
import { GetSearchAllLibrariesFlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetSearchAllLibrariesFlattenSeasons =
GetSearchAllLibrariesFlattenSeasons.True;
GetSearchAllLibrariesFlattenSeasons.Show;
```
## Values
| Name | Value |
| ------- | ------- |
| `False` | 0 |
| `True` | 1 |
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Hide` | 0 |
| `Show` | 1 |

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

@@ -4,6 +4,8 @@
```typescript
import {
GetSearchAllLibrariesEnableCreditsMarkerGeneration,
GetSearchAllLibrariesEpisodeSort,
GetSearchAllLibrariesFlattenSeasons,
GetSearchAllLibrariesHasThumbnail,
GetSearchAllLibrariesLibraryType,
@@ -39,7 +41,10 @@ let value: GetSearchAllLibrariesMediaContainer = {
year: 2022,
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.True,
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.Show,
episodeSort: GetSearchAllLibrariesEpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
GetSearchAllLibrariesEnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetSearchAllLibrariesShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",

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

@@ -4,6 +4,8 @@
```typescript
import {
GetSearchAllLibrariesEnableCreditsMarkerGeneration,
GetSearchAllLibrariesEpisodeSort,
GetSearchAllLibrariesFlattenSeasons,
GetSearchAllLibrariesHasThumbnail,
GetSearchAllLibrariesLibraryType,
@@ -34,7 +36,10 @@ let value: GetSearchAllLibrariesMetadata = {
year: 2022,
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.True,
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.Show,
episodeSort: GetSearchAllLibrariesEpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
GetSearchAllLibrariesEnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetSearchAllLibrariesShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
@@ -249,7 +254,9 @@ let value: GetSearchAllLibrariesMetadata = {
| `year` | *number* | :heavy_minus_sign: | N/A | 2022 |
| `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 |
| `flattenSeasons` | [operations.GetSearchAllLibrariesFlattenSeasons](../../../sdk/models/operations/getsearchalllibrariesflattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
| `episodeSort` | [operations.GetSearchAllLibrariesEpisodeSort](../../../sdk/models/operations/getsearchalllibrariesepisodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
| `enableCreditsMarkerGeneration` | [operations.GetSearchAllLibrariesEnableCreditsMarkerGeneration](../../../sdk/models/operations/getsearchalllibrariesenablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -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/>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 |

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

@@ -4,6 +4,8 @@
```typescript
import {
GetSearchAllLibrariesEnableCreditsMarkerGeneration,
GetSearchAllLibrariesEpisodeSort,
GetSearchAllLibrariesFlattenSeasons,
GetSearchAllLibrariesHasThumbnail,
GetSearchAllLibrariesLibraryType,
@@ -22,7 +24,7 @@ let value: GetSearchAllLibrariesResponse = {
}),
object: {
mediaContainer: {
size: 8558.03,
size: 8558.04,
searchResult: [
{
score: 117.14,
@@ -46,7 +48,10 @@ let value: GetSearchAllLibrariesResponse = {
year: 2022,
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.True,
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.Show,
episodeSort: GetSearchAllLibrariesEpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
GetSearchAllLibrariesEnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetSearchAllLibrariesShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",

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

@@ -6,6 +6,8 @@ The libraries available on the Server
```typescript
import {
GetSearchAllLibrariesEnableCreditsMarkerGeneration,
GetSearchAllLibrariesEpisodeSort,
GetSearchAllLibrariesFlattenSeasons,
GetSearchAllLibrariesHasThumbnail,
GetSearchAllLibrariesLibraryType,
@@ -42,7 +44,10 @@ let value: GetSearchAllLibrariesResponseBody = {
year: 2022,
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.True,
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.Show,
episodeSort: GetSearchAllLibrariesEpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
GetSearchAllLibrariesEnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetSearchAllLibrariesShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",

8
docs/sdk/models/operations/getuserfriendsresponse.md
View File

@@ -18,12 +18,8 @@ let value: GetUserFriendsResponse = {
home: true,
id: 0,
restricted: false,
sharedServers: [
{},
],
sharedSources: [
{},
],
sharedServers: [],
sharedSources: [],
status: Status.Accepted,
thumb: "https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578",
title: "username123",

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

@@ -4,6 +4,8 @@
```typescript
import {
GetSearchAllLibrariesEnableCreditsMarkerGeneration,
GetSearchAllLibrariesEpisodeSort,
GetSearchAllLibrariesFlattenSeasons,
GetSearchAllLibrariesHasThumbnail,
GetSearchAllLibrariesLibraryType,
@@ -36,7 +38,10 @@ let value: SearchResult = {
year: 2022,
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.True,
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.Show,
episodeSort: GetSearchAllLibrariesEpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
GetSearchAllLibrariesEnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetSearchAllLibrariesShowOrdering.TvdbDvd,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",

2
docs/sdks/authentication/README.md
View File

@@ -262,6 +262,7 @@ async function run() {
requestBody: {
login: "username@email.com",
password: "password123",
rememberMe: false,
verificationCode: "123456",
},
});
@@ -295,6 +296,7 @@ async function run() {
requestBody: {
login: "username@email.com",
password: "password123",
rememberMe: false,
verificationCode: "123456",
},
});

6
docs/sdks/library/README.md
View File

@@ -342,13 +342,14 @@ Each type in the library comes with a set of filters and sorts, aiding in buildi
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { IncludeDetails } from "@lukehagar/plexjs/sdk/models/operations";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.library.getLibraryDetails(9518);
const result = await plexAPI.library.getLibraryDetails(9518, IncludeDetails.Zero);
// Handle the result
console.log(result);
@@ -364,6 +365,7 @@ The standalone function version of this method:
```typescript
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
import { libraryGetLibraryDetails } from "@lukehagar/plexjs/funcs/libraryGetLibraryDetails.js";
import { IncludeDetails } from "@lukehagar/plexjs/sdk/models/operations";
// Use `PlexAPICore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
@@ -372,7 +374,7 @@ const plexAPI = new PlexAPICore({
});
async function run() {
const res = await libraryGetLibraryDetails(plexAPI, 9518);
const res = await libraryGetLibraryDetails(plexAPI, 9518, IncludeDetails.Zero);
if (!res.ok) {
throw res.error;

4
docs/sdks/playlists/README.md
View File

@@ -43,7 +43,7 @@ async function run() {
title: "<value>",
type: CreatePlaylistQueryParamType.Photo,
smart: Smart.One,
uri: "https://inborn-brochure.biz",
uri: "https://hoarse-testing.info/",
});
// Handle the result
@@ -73,7 +73,7 @@ async function run() {
title: "<value>",
type: CreatePlaylistQueryParamType.Photo,
smart: Smart.One,
uri: "https://inborn-brochure.biz",
uri: "https://hoarse-testing.info/",
});
if (!res.ok) {

2
docs/sdks/plex/README.md
View File

@@ -400,6 +400,7 @@ const plexAPI = new PlexAPI();
async function run() {
const result = await plexAPI.plex.getPin({
strong: false,
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
clientName: "Plex for Roku",
deviceNickname: "Roku 3",
@@ -428,6 +429,7 @@ const plexAPI = new PlexAPICore();
async function run() {
const res = await plexGetPin(plexAPI, {
strong: false,
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
clientName: "Plex for Roku",
deviceNickname: "Roku 3",