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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.535.1

Browse Source
This commit is contained in:
speakeasybot
2025-04-19 00:12:04 +00:00
parent 7a950ea773
commit 763aa8e800
102 changed files with 1864 additions and 713 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -12,8 +12,11 @@ let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Photo;
## Values
| Name | Value |
| ------- | ------- |
| `Audio` | audio |
| `Video` | video |
| `Photo` | photo |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Audio` | audio |
| `Video` | video |
| `Photo` | photo |
| - | `Unrecognized<string>` |

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

@@ -13,7 +13,10 @@ let value: EnableCreditsMarkerGeneration =
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Disabled` | 0 |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `LibraryDefault` | -1 |
| `Disabled` | 0 |
| - | `Unrecognized<string>` |

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

@@ -12,8 +12,11 @@ let value: EpisodeSort = EpisodeSort.OldestFirst;
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `OldestFirst` | 0 |
| `NewestFirst` | 1 |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `LibraryDefault` | -1 |
| `OldestFirst` | 0 |
| `NewestFirst` | 1 |
| - | `Unrecognized<string>` |

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

@@ -12,8 +12,11 @@ let value: Filter = Filter.Available;
## Values
| Name | Value |
| ----------- | ----------- |
| `All` | all |
| `Available` | available |
| `Released` | released |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `All` | all |
| `Available` | available |
| `Released` | released |
| - | `Unrecognized<string>` |

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

@@ -12,8 +12,11 @@ let value: FlattenSeasons = FlattenSeasons.Show;
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Hide` | 0 |
| `Show` | 1 |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `LibraryDefault` | -1 |
| `Hide` | 0 |
| `Show` | 1 |
| - | `Unrecognized<string>` |

21
docs/sdk/models/operations/getactorslibraryqueryparamtype.md
View File

@@ -19,12 +19,15 @@ let value: GetActorsLibraryQueryParamType =
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| - | `Unrecognized<number>` |

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

@@ -12,11 +12,14 @@ let value: GetAllLibrariesType = GetAllLibrariesType.Movie;
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| - | `Unrecognized<string>` |

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

@@ -11,9 +11,12 @@ let value: GetAllMediaLibraryLibraryResponseType =
## Values
| Name | Value |
| ------------- | ------------- |
| `CoverPoster` | coverPoster |
| `Background` | background |
| `Snapshot` | snapshot |
| `ClearLogo` | clearLogo |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `CoverPoster` | coverPoster |
| `Background` | background |
| `Snapshot` | snapshot |
| `ClearLogo` | clearLogo |
| - | `Unrecognized<string>` |

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

@@ -13,11 +13,14 @@ let value: GetAllMediaLibraryLibraryType = GetAllMediaLibraryLibraryType.Movie;
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| - | `Unrecognized<string>` |

21
docs/sdk/models/operations/getallmedialibraryqueryparamtype.md
View File

@@ -19,12 +19,15 @@ let value: GetAllMediaLibraryQueryParamType =
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| - | `Unrecognized<number>` |

21
docs/sdk/models/operations/getcountrieslibraryqueryparamtype.md
View File

@@ -19,12 +19,15 @@ let value: GetCountriesLibraryQueryParamType =
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| - | `Unrecognized<number>` |

21
docs/sdk/models/operations/getgenreslibraryqueryparamtype.md
View File

@@ -19,12 +19,15 @@ let value: GetGenresLibraryQueryParamType =
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| - | `Unrecognized<number>` |

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

@@ -12,7 +12,7 @@ let value: GetLibraryDetailsRequest = {
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `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 |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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 |

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

@@ -11,9 +11,12 @@ let value: GetLibraryItemsLibraryResponse200Type =
## Values
| Name | Value |
| ------------- | ------------- |
| `CoverPoster` | coverPoster |
| `Background` | background |
| `Snapshot` | snapshot |
| `ClearLogo` | clearLogo |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `CoverPoster` | coverPoster |
| `Background` | background |
| `Snapshot` | snapshot |
| `ClearLogo` | clearLogo |
| - | `Unrecognized<string>` |

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

@@ -13,11 +13,14 @@ let value: GetLibraryItemsLibraryType = GetLibraryItemsLibraryType.Movie;
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| - | `Unrecognized<string>` |

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

@@ -18,12 +18,15 @@ let value: GetLibraryItemsQueryParamType = GetLibraryItemsQueryParamType.TvShow;
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| - | `Unrecognized<number>` |

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

@@ -19,12 +19,15 @@ let value: GetPlaylistContentsQueryParamType =
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| - | `Unrecognized<number>` |

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

@@ -11,9 +11,12 @@ let value: GetRecentlyAddedHubsResponseType =
## Values
| Name | Value |
| ------------- | ------------- |
| `CoverPoster` | coverPoster |
| `Background` | background |
| `Snapshot` | snapshot |
| `ClearLogo` | clearLogo |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `CoverPoster` | coverPoster |
| `Background` | background |
| `Snapshot` | snapshot |
| `ClearLogo` | clearLogo |
| - | `Unrecognized<string>` |

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

@@ -13,11 +13,14 @@ let value: GetRecentlyAddedHubsType = GetRecentlyAddedHubsType.Movie;
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| - | `Unrecognized<string>` |

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

@@ -13,7 +13,10 @@ let value: GetSearchAllLibrariesEnableCreditsMarkerGeneration =
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Disabled` | 0 |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `LibraryDefault` | -1 |
| `Disabled` | 0 |
| - | `Unrecognized<string>` |

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

@@ -13,8 +13,11 @@ let value: GetSearchAllLibrariesEpisodeSort =
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `OldestFirst` | 0 |
| `NewestFirst` | 1 |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `LibraryDefault` | -1 |
| `OldestFirst` | 0 |
| `NewestFirst` | 1 |
| - | `Unrecognized<string>` |

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

@@ -13,8 +13,11 @@ let value: GetSearchAllLibrariesFlattenSeasons =
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Hide` | 0 |
| `Show` | 1 |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `LibraryDefault` | -1 |
| `Hide` | 0 |
| `Show` | 1 |
| - | `Unrecognized<string>` |

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

@@ -11,9 +11,12 @@ let value: GetSearchAllLibrariesLibraryType =
## Values
| Name | Value |
| ------------- | ------------- |
| `CoverPoster` | coverPoster |
| `Background` | background |
| `Snapshot` | snapshot |
| `ClearLogo` | clearLogo |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `CoverPoster` | coverPoster |
| `Background` | background |
| `Snapshot` | snapshot |
| `ClearLogo` | clearLogo |
| - | `Unrecognized<string>` |

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

@@ -19,10 +19,13 @@ let value: GetSearchAllLibrariesShowOrdering =
## Values
| Name | Value |
| -------------- | -------------- |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `TvdbAired` | aired |
| `TvdbDvd` | dvd |
| `TvdbAbsolute` | absolute |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `TvdbAired` | aired |
| `TvdbDvd` | dvd |
| `TvdbAbsolute` | absolute |
| - | `Unrecognized<string>` |

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

@@ -13,11 +13,14 @@ let value: GetSearchAllLibrariesType = GetSearchAllLibrariesType.Movie;
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| - | `Unrecognized<string>` |

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

@@ -19,12 +19,15 @@ let value: GetSearchLibraryQueryParamType =
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| - | `Unrecognized<number>` |

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

@@ -13,7 +13,10 @@ let value: GetTokenDetailsAuthenticationResponseStatus =
## Values
| Name | Value |
| ---------- | ---------- |
| `Inactive` | Inactive |
| `Active` | Active |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Inactive` | Inactive |
| `Active` | Active |
| - | `Unrecognized<string>` |

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

@@ -13,7 +13,10 @@ let value: GetTokenDetailsAuthenticationStatus =
## Values
| Name | Value |
| ---------- | ---------- |
| `Inactive` | Inactive |
| `Active` | Active |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Inactive` | Inactive |
| `Active` | Active |
| - | `Unrecognized<string>` |

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

@@ -10,7 +10,10 @@ let value: GetTokenDetailsStatus = GetTokenDetailsStatus.Online;
## Values
| Name | Value |
| --------- | --------- |
| `Online` | online |
| `Offline` | offline |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Online` | online |
| `Offline` | offline |
| - | `Unrecognized<string>` |

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

@@ -19,12 +19,15 @@ let value: GetTopWatchedContentQueryParamType =
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| - | `Unrecognized<number>` |

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

@@ -1,6 +1,6 @@
# IncludeDetails
Whether or not to include details for a section (types, filters, and sorts).
Whether or not to include details for a section (types, filters, and sorts).
Only exists for backwards compatibility, media providers other than the server libraries have it on always.

27
docs/sdk/models/operations/level.md
View File

@@ -1,10 +1,10 @@
# Level
An integer log level to write to the PMS log with.
0: Error
1: Warning
2: Info
3: Debug
An integer log level to write to the PMS log with.
0: Error
1: Warning
2: Info
3: Debug
4: Verbose
@@ -18,10 +18,13 @@ let value: Level = Level.Two;
## Values
| Name | Value |
| ------- | ------- |
| `Zero` | 0 |
| `One` | 1 |
| `Two` | 2 |
| `Three` | 3 |
| `Four` | 4 |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Zero` | 0 |
| `One` | 1 |
| `Two` | 2 |
| `Three` | 3 |
| `Four` | 4 |
| - | `Unrecognized<number>` |

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

@@ -13,7 +13,10 @@ let value: Libtype = Libtype.Show;
## Values
| Name | Value |
| ------- | ------- |
| `Movie` | movie |
| `Show` | show |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Movie` | movie |
| `Show` | show |
| - | `Unrecognized<string>` |

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

@@ -14,8 +14,8 @@ let value: LogLineRequest = {
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `level` | [operations.Level](../../../sdk/models/operations/level.md) | :heavy_check_mark: | An integer log level to write to the PMS log with. <br/>0: Error <br/>1: Warning <br/>2: Info <br/>3: Debug <br/>4: Verbose<br/> | |
| `message` | *string* | :heavy_check_mark: | The text of the message to write to the log. | Test log message |
| `source` | *string* | :heavy_check_mark: | a string indicating the source of the message. | Postman |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `level` | [operations.Level](../../../sdk/models/operations/level.md) | :heavy_check_mark: | An integer log level to write to the PMS log with.<br/>0: Error<br/>1: Warning<br/>2: Info<br/>3: Debug<br/>4: Verbose<br/> | |
| `message` | *string* | :heavy_check_mark: | The text of the message to write to the log. | Test log message |
| `source` | *string* | :heavy_check_mark: | a string indicating the source of the message. | Postman |

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

@@ -12,7 +12,10 @@ let value: MailingListStatus = MailingListStatus.Active;
## Values
| Name | Value |
| -------------- | -------------- |
| `Active` | active |
| `Unsubscribed` | unsubscribed |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Active` | active |
| `Unsubscribed` | unsubscribed |
| - | `Unrecognized<string>` |

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

@@ -12,6 +12,8 @@ let value: PathParamTaskName = PathParamTaskName.RefreshPeriodicMetadata;
## Values
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| --------------------------- | --------------------------- |
| `BackupDatabase` | BackupDatabase |
@@ -27,4 +29,5 @@ let value: PathParamTaskName = PathParamTaskName.RefreshPeriodicMetadata;
| `RefreshLibraries` | RefreshLibraries |
| `RefreshLocalMedia` | RefreshLocalMedia |
| `RefreshPeriodicMetadata` | RefreshPeriodicMetadata |
| `UpgradeMediaAnalysis` | UpgradeMediaAnalysis |
| `UpgradeMediaAnalysis` | UpgradeMediaAnalysis |
| - | `Unrecognized<string>` |

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

@@ -12,8 +12,11 @@ let value: PlaylistType = PlaylistType.Video;
## Values
| Name | Value |
| ------- | ------- |
| `Audio` | audio |
| `Video` | video |
| `Photo` | photo |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Audio` | audio |
| `Video` | video |
| `Photo` | photo |
| - | `Unrecognized<string>` |

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

@@ -13,7 +13,10 @@ let value: PostUsersSignInDataAuthenticationResponseStatus =
## Values
| Name | Value |
| ---------- | ---------- |
| `Inactive` | Inactive |
| `Active` | Active |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Inactive` | Inactive |
| `Active` | Active |
| - | `Unrecognized<string>` |

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

@@ -13,7 +13,10 @@ let value: PostUsersSignInDataAuthenticationStatus =
## Values
| Name | Value |
| ---------- | ---------- |
| `Inactive` | Inactive |
| `Active` | Active |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Inactive` | Inactive |
| `Active` | Active |
| - | `Unrecognized<string>` |

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

@@ -13,7 +13,10 @@ let value: PostUsersSignInDataMailingListStatus =
## Values
| Name | Value |
| -------------- | -------------- |
| `Active` | active |
| `Unsubscribed` | unsubscribed |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Active` | active |
| `Unsubscribed` | unsubscribed |
| - | `Unrecognized<string>` |

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

@@ -10,6 +10,9 @@ let value: PostUsersSignInDataState = PostUsersSignInDataState.Ended;
## Values
| Name | Value |
| ------- | ------- |
| `Ended` | ended |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Ended` | ended |
| - | `Unrecognized<string>` |

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

@@ -10,7 +10,10 @@ let value: PostUsersSignInDataStatus = PostUsersSignInDataStatus.Online;
## Values
| Name | Value |
| --------- | --------- |
| `Online` | online |
| `Offline` | offline |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Online` | online |
| `Offline` | offline |
| - | `Unrecognized<string>` |

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

@@ -1,8 +1,8 @@
# QueryParamForce
Force overwriting of duplicate playlists.
By default, a playlist file uploaded with the same path will overwrite the existing playlist.
The `force` argument is used to disable overwriting.
Force overwriting of duplicate playlists.
By default, a playlist file uploaded with the same path will overwrite the existing playlist.
The `force` argument is used to disable overwriting.
If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.

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

@@ -12,7 +12,10 @@ let value: QueryParamSmart = QueryParamSmart.Zero;
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Zero` | 0 |
| `One` | 1 |
| - | `Unrecognized<number>` |

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

@@ -18,12 +18,15 @@ let value: QueryParamType = QueryParamType.TvShow;
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| - | `Unrecognized<number>` |

17
docs/sdk/models/operations/searchtypes.md
View File

@@ -10,10 +10,13 @@ let value: SearchTypes = SearchTypes.Tv;
## Values
| Name | Value |
| ------------- | ------------- |
| `Movies` | movies |
| `Music` | music |
| `OtherVideos` | otherVideos |
| `People` | people |
| `Tv` | tv |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Movies` | movies |
| `Music` | music |
| `OtherVideos` | otherVideos |
| `People` | people |
| `Tv` | tv |
| - | `Unrecognized<string>` |

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

@@ -18,10 +18,13 @@ let value: ShowOrdering = ShowOrdering.TvdbAbsolute;
## Values
| Name | Value |
| -------------- | -------------- |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `TvdbAired` | aired |
| `TvdbDvd` | dvd |
| `TvdbAbsolute` | absolute |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `TvdbAired` | aired |
| `TvdbDvd` | dvd |
| `TvdbAbsolute` | absolute |
| - | `Unrecognized<string>` |

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

@@ -12,8 +12,11 @@ let value: State = State.Playing;
## Values
| Name | Value |
| --------- | --------- |
| `Playing` | playing |
| `Paused` | paused |
| `Stopped` | stopped |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Playing` | playing |
| `Paused` | paused |
| `Stopped` | stopped |
| - | `Unrecognized<string>` |

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

@@ -12,6 +12,9 @@ let value: Status = Status.Accepted;
## Values
| Name | Value |
| ---------- | ---------- |
| `Accepted` | accepted |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Accepted` | accepted |
| - | `Unrecognized<string>` |

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

@@ -12,21 +12,24 @@ let value: Tag = Tag.RecentlyViewed;
## Values
| Name | Value |
| ---------------- | ---------------- |
| `Unwatched` | unwatched |
| `Newest` | newest |
| `RecentlyAdded` | recentlyAdded |
| `RecentlyViewed` | recentlyViewed |
| `OnDeck` | onDeck |
| `Collection` | collection |
| `Edition` | edition |
| `Year` | year |
| `Decade` | decade |
| `Director` | director |
| `ContentRating` | contentRating |
| `Rating` | rating |
| `Resolution` | resolution |
| `FirstCharacter` | firstCharacter |
| `Folder` | folder |
| `Albums` | albums |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Unwatched` | unwatched |
| `Newest` | newest |
| `RecentlyAdded` | recentlyAdded |
| `RecentlyViewed` | recentlyViewed |
| `OnDeck` | onDeck |
| `Collection` | collection |
| `Edition` | edition |
| `Year` | year |
| `Decade` | decade |
| `Director` | director |
| `ContentRating` | contentRating |
| `Rating` | rating |
| `Resolution` | resolution |
| `FirstCharacter` | firstCharacter |
| `Folder` | folder |
| `Albums` | albums |
| - | `Unrecognized<string>` |

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

@@ -12,6 +12,8 @@ let value: TaskName = TaskName.RefreshLocalMedia;
## Values
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| --------------------------- | --------------------------- |
| `BackupDatabase` | BackupDatabase |
@@ -27,4 +29,5 @@ let value: TaskName = TaskName.RefreshLocalMedia;
| `RefreshLibraries` | RefreshLibraries |
| `RefreshLocalMedia` | RefreshLocalMedia |
| `RefreshPeriodicMetadata` | RefreshPeriodicMetadata |
| `UpgradeMediaAnalysis` | UpgradeMediaAnalysis |
| `UpgradeMediaAnalysis` | UpgradeMediaAnalysis |
| - | `Unrecognized<string>` |

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

@@ -18,12 +18,15 @@ let value: Type = Type.TvShow;
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| - | `Unrecognized<number>` |

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

@@ -14,8 +14,8 @@ let value: UploadPlaylistRequest = {
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `path` | *string* | :heavy_check_mark: | absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server. <br/>If the `path` argument is a directory, that path will be scanned for playlist files to be processed. <br/>Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename. <br/>If the `path` argument is a file, that file will be used to create a new playlist, with the name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename.<br/> | /home/barkley/playlist.m3u |
| `force` | [operations.QueryParamForce](../../../sdk/models/operations/queryparamforce.md) | :heavy_check_mark: | Force overwriting of duplicate playlists. <br/>By default, a playlist file uploaded with the same path will overwrite the existing playlist. <br/>The `force` argument is used to disable overwriting. <br/>If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.<br/> | |
| `sectionID` | *number* | :heavy_check_mark: | Possibly the section ID to upload the playlist to, we are not certain. | 1 |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `path` | *string* | :heavy_check_mark: | absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server.<br/>If the `path` argument is a directory, that path will be scanned for playlist files to be processed.<br/>Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it.<br/>The GUID of each playlist is based on the filename.<br/>If the `path` argument is a file, that file will be used to create a new playlist, with the name based on the filename of the file that created it.<br/>The GUID of each playlist is based on the filename.<br/> | /home/barkley/playlist.m3u |
| `force` | [operations.QueryParamForce](../../../sdk/models/operations/queryparamforce.md) | :heavy_check_mark: | Force overwriting of duplicate playlists.<br/>By default, a playlist file uploaded with the same path will overwrite the existing playlist.<br/>The `force` argument is used to disable overwriting.<br/>If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.<br/> | |
| `sectionID` | *number* | :heavy_check_mark: | Possibly the section ID to upload the playlist to, we are not certain. | 1 |