mirror of
https://github.com/LukeHagar/plexcsharp.git
synced 2025-12-06 04:20:46 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.401.2
This commit is contained in:
speakeasybot
9
docs/Models/Requests/Action.md
Normal file
9
docs/Models/Requests/Action.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Action
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||
| `Id` | *string* | :heavy_check_mark: | N/A | addToContinueWatching |
|
||||
| `Key` | *string* | :heavy_check_mark: | N/A | /actions/addToContinueWatching |
|
||||
12
docs/Models/Requests/ActiveDirection.md
Normal file
12
docs/Models/Requests/ActiveDirection.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# ActiveDirection
|
||||
|
||||
The direction of the sort. Can be either `asc` or `desc`.
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `Ascending` | asc |
|
||||
| `Descending` | desc |
|
||||
8
docs/Models/Requests/Collection.md
Normal file
8
docs/Models/Requests/Collection.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Collection
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `Tag` | *string* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||
12
docs/Models/Requests/DefaultDirection.md
Normal file
12
docs/Models/Requests/DefaultDirection.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# DefaultDirection
|
||||
|
||||
The direction of the sort. Can be either `asc` or `desc`.
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `Ascending` | asc |
|
||||
| `Descending` | desc |
|
||||
@@ -3,8 +3,12 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `Key` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `Type` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `Directory` | List<[GetMediaProvidersDirectory](../../Models/Requests/GetMediaProvidersDirectory.md)> | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `Key` | *string* | :heavy_minus_sign: | N/A | |
|
||||
| `Type` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `Flavor` | *string* | :heavy_minus_sign: | N/A | global |
|
||||
| `ScrobbleKey` | *string* | :heavy_minus_sign: | N/A | /:/scrobble/new |
|
||||
| `UnscrobbleKey` | *string* | :heavy_minus_sign: | N/A | /:/unscrobble/new |
|
||||
| `Directory` | List<[GetMediaProvidersDirectory](../../Models/Requests/GetMediaProvidersDirectory.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `Action` | List<[Action](../../Models/Requests/Action.md)> | :heavy_minus_sign: | N/A | |
|
||||
9
docs/Models/Requests/FlattenSeasons.md
Normal file
9
docs/Models/Requests/FlattenSeasons.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# FlattenSeasons
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `False` | 0 |
|
||||
| `True` | 1 |
|
||||
10
docs/Models/Requests/GetLibraryItemsImage.md
Normal file
10
docs/Models/Requests/GetLibraryItemsImage.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryItemsImage
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `Alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
|
||||
| `Type` | [GetLibraryItemsLibraryResponseType](../../Models/Requests/GetLibraryItemsLibraryResponseType.md) | :heavy_check_mark: | N/A | background |
|
||||
| `Url` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||
11
docs/Models/Requests/GetLibraryItemsLibraryResponseType.md
Normal file
11
docs/Models/Requests/GetLibraryItemsLibraryResponseType.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetLibraryItemsLibraryResponseType
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
14
docs/Models/Requests/GetLibraryItemsLibraryType.md
Normal file
14
docs/Models/Requests/GetLibraryItemsLibraryType.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# GetLibraryItemsLibraryType
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||
| `Type` | *string* | :heavy_check_mark: | N/A | show |
|
||||
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
|
||||
| `Filter` | List<[GetLibraryItemsFilter](../../Models/Requests/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `Sort` | List<[GetLibraryItemsSort](../../Models/Requests/GetLibraryItemsSort.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `Field` | List<[GetLibraryItemsField](../../Models/Requests/GetLibraryItemsField.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -5,17 +5,19 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `Id` | *int* | :heavy_minus_sign: | N/A | 119534 |
|
||||
| `Duration` | *int* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `Bitrate` | *int* | :heavy_minus_sign: | N/A | 25025 |
|
||||
| `Width` | *int* | :heavy_minus_sign: | N/A | 3840 |
|
||||
| `Height` | *int* | :heavy_minus_sign: | N/A | 2072 |
|
||||
| `AspectRatio` | *double* | :heavy_minus_sign: | N/A | 1.85 |
|
||||
| `AudioChannels` | *int* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `AudioCodec` | *string* | :heavy_minus_sign: | N/A | eac3 |
|
||||
| `VideoCodec` | *string* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `VideoResolution` | *string* | :heavy_minus_sign: | N/A | 4k |
|
||||
| `Container` | *string* | :heavy_minus_sign: | N/A | mkv |
|
||||
| `VideoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `VideoProfile` | *string* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `Part` | List<[GetLibraryItemsPart](../../Models/Requests/GetLibraryItemsPart.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `Id` | *int* | :heavy_check_mark: | N/A | 119534 |
|
||||
| `Duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `Bitrate` | *int* | :heavy_check_mark: | N/A | 25025 |
|
||||
| `Width` | *int* | :heavy_check_mark: | N/A | 3840 |
|
||||
| `Height` | *int* | :heavy_check_mark: | N/A | 2072 |
|
||||
| `AspectRatio` | *double* | :heavy_check_mark: | N/A | 1.85 |
|
||||
| `AudioProfile` | *string* | :heavy_minus_sign: | N/A | dts |
|
||||
| `AudioChannels` | *int* | :heavy_check_mark: | N/A | 6 |
|
||||
| `AudioCodec` | *string* | :heavy_check_mark: | N/A | eac3 |
|
||||
| `VideoCodec` | *string* | :heavy_check_mark: | N/A | hevc |
|
||||
| `VideoResolution` | *string* | :heavy_check_mark: | N/A | 4k |
|
||||
| `Container` | *string* | :heavy_check_mark: | N/A | mkv |
|
||||
| `VideoFrameRate` | *string* | :heavy_check_mark: | N/A | 24p |
|
||||
| `VideoProfile` | *string* | :heavy_check_mark: | N/A | main 10 |
|
||||
| `HasVoiceActivity` | *bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `Part` | List<[GetLibraryItemsPart](../../Models/Requests/GetLibraryItemsPart.md)> | :heavy_check_mark: | N/A | |
|
||||
@@ -6,7 +6,11 @@
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `Size` | *int* | :heavy_check_mark: | N/A | 70 |
|
||||
| `TotalSize` | *int* | :heavy_check_mark: | N/A | 170 |
|
||||
| `Offset` | *int* | :heavy_check_mark: | N/A | 0 |
|
||||
| `Content` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | true |
|
||||
| `Nocache` | *bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `Art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `Identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
||||
| `LibrarySectionID` | [LibrarySectionID](../../Models/Requests/LibrarySectionID.md) | :heavy_check_mark: | N/A | |
|
||||
@@ -20,5 +24,5 @@
|
||||
| `ViewGroup` | *string* | :heavy_check_mark: | N/A | movie |
|
||||
| `ViewMode` | *int* | :heavy_minus_sign: | N/A | 65592 |
|
||||
| `MixedParents` | *bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `Metadata` | List<[GetLibraryItemsMetadata](../../Models/Requests/GetLibraryItemsMetadata.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `Metadata` | List<[GetLibraryItemsMetadata](../../Models/Requests/GetLibraryItemsMetadata.md)> | :heavy_check_mark: | N/A | |
|
||||
| `Meta` | [Meta](../../Models/Requests/Meta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||
@@ -5,24 +5,30 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `RatingKey` | *string* | :heavy_check_mark: | N/A | 58683 |
|
||||
| `RatingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
|
||||
| `Key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 |
|
||||
| `Guid` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `Studio` | *string* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||
| `Type` | *string* | :heavy_check_mark: | N/A | movie |
|
||||
| `SkipChildren` | *bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `Type` | [GetLibraryItemsType](../../Models/Requests/GetLibraryItemsType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
||||
| `Title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||
| `Slug` | *string* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||
| `ContentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `Summary` | *string* | :heavy_minus_sign: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
||||
| `Summary` | *string* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
||||
| `Rating` | *double* | :heavy_minus_sign: | N/A | 7.6 |
|
||||
| `AudienceRating` | *double* | :heavy_minus_sign: | N/A | 9.2 |
|
||||
| `Year` | *int* | :heavy_check_mark: | N/A | 2022 |
|
||||
| `Year` | *int* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `SeasonCount` | *int* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `Tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||
| `FlattenSeasons` | [FlattenSeasons](../../Models/Requests/FlattenSeasons.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `ShowOrdering` | [ShowOrdering](../../Models/Requests/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 |
|
||||
| `Thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||
| `Art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `Duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `Banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||
| `Duration` | *int* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `OriginallyAvailableAt` | [LocalDate](https://nodatime.org/3.1.x/api/NodaTime.LocalDate.html) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
||||
| `AddedAt` | *int* | :heavy_minus_sign: | N/A | 1680457607 |
|
||||
| `UpdatedAt` | *int* | :heavy_minus_sign: | N/A | 1703239236 |
|
||||
| `AddedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `UpdatedAt` | *long* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `AudienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `ChapterSource` | *string* | :heavy_minus_sign: | N/A | media |
|
||||
| `PrimaryExtraKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||
@@ -32,15 +38,19 @@
|
||||
| `GrandparentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `GrandparentTitle` | *string* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `GrandparentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `GrandparentSlug` | *string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `GrandparentArt` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||
| `GrandparentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| `Media` | List<[GetLibraryItemsMedia](../../Models/Requests/GetLibraryItemsMedia.md)> | :heavy_check_mark: | N/A | |
|
||||
| `Media` | List<[GetLibraryItemsMedia](../../Models/Requests/GetLibraryItemsMedia.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
||||
| `Genre` | List<[GetLibraryItemsGenre](../../Models/Requests/GetLibraryItemsGenre.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `Country` | List<[GetLibraryItemsCountry](../../Models/Requests/GetLibraryItemsCountry.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `Director` | List<[GetLibraryItemsDirector](../../Models/Requests/GetLibraryItemsDirector.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `Writer` | List<[GetLibraryItemsWriter](../../Models/Requests/GetLibraryItemsWriter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `Collection` | List<[Collection](../../Models/Requests/Collection.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `Role` | List<[GetLibraryItemsRole](../../Models/Requests/GetLibraryItemsRole.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `MediaGuid` | List<[MediaGuid](../../Models/Requests/MediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||
| `UltraBlurColors` | [UltraBlurColors](../../Models/Requests/UltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Image` | List<[GetLibraryItemsImage](../../Models/Requests/GetLibraryItemsImage.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `TitleSort` | *string* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `ViewCount` | *int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `LastViewedAt` | *int* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||
@@ -54,7 +64,7 @@
|
||||
| `ChildCount` | *int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `HasPremiumExtras` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `HasPremiumPrimaryExtra` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `ParentRatingKey` | *string* | :heavy_minus_sign: | N/A | 66 |
|
||||
| `ParentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
||||
| `ParentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `ParentStudio` | *string* | :heavy_minus_sign: | N/A | UCP |
|
||||
| `ParentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
|
||||
@@ -5,10 +5,13 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `Id` | *int* | :heavy_minus_sign: | N/A | 119542 |
|
||||
| `Key` | *string* | :heavy_minus_sign: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `Duration` | *int* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `File` | *string* | :heavy_minus_sign: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `Size` | *long* | :heavy_minus_sign: | N/A | 36158371307 |
|
||||
| `Container` | *string* | :heavy_minus_sign: | N/A | mkv |
|
||||
| `VideoProfile` | *string* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `Id` | *int* | :heavy_check_mark: | N/A | 119542 |
|
||||
| `Key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `Duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `File` | *string* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `Size` | *long* | :heavy_check_mark: | N/A | 36158371307 |
|
||||
| `Container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
||||
| `AudioProfile` | *string* | :heavy_minus_sign: | N/A | dts |
|
||||
| `VideoProfile` | *string* | :heavy_check_mark: | N/A | main 10 |
|
||||
| `Indexes` | *string* | :heavy_minus_sign: | N/A | sd |
|
||||
| `HasThumbnail` | [HasThumbnail](../../Models/Requests/HasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
@@ -7,8 +7,8 @@
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `Tag` | [Tag](../../Models/Requests/Tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||
| `Type` | [Models.Requests.Type](../../Models/Requests/Type.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `IncludeGuids` | [IncludeGuids](../../Models/Requests/IncludeGuids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
| `IncludeMeta` | [IncludeMeta](../../Models/Requests/IncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||
| `Type` | [Models.Requests.Type](../../Models/Requests/Type.md) | :heavy_minus_sign: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `XPlexContainerStart` | *int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
||||
| `XPlexContainerSize` | *int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
||||
@@ -3,11 +3,13 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `Default` | *string* | :heavy_minus_sign: | N/A | asc |
|
||||
| `DefaultDirection` | *string* | :heavy_check_mark: | N/A | asc |
|
||||
| `DescKey` | *string* | :heavy_minus_sign: | N/A | titleSort:desc |
|
||||
| `FirstCharacterKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
||||
| `Key` | *string* | :heavy_check_mark: | N/A | titleSort |
|
||||
| `Title` | *string* | :heavy_check_mark: | N/A | Title |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| `Default` | *string* | :heavy_minus_sign: | N/A | asc |
|
||||
| `Active` | *bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `ActiveDirection` | [ActiveDirection](../../Models/Requests/ActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||
| `DefaultDirection` | [DefaultDirection](../../Models/Requests/DefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||
| `DescKey` | *string* | :heavy_minus_sign: | N/A | titleSort:desc |
|
||||
| `FirstCharacterKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
||||
| `Key` | *string* | :heavy_check_mark: | N/A | titleSort |
|
||||
| `Title` | *string* | :heavy_check_mark: | N/A | Title |
|
||||
@@ -1,14 +1,14 @@
|
||||
# GetLibraryItemsType
|
||||
|
||||
The type of media content
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||
| `Type` | *string* | :heavy_check_mark: | N/A | show |
|
||||
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
|
||||
| `Filter` | List<[GetLibraryItemsFilter](../../Models/Requests/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `Sort` | List<[GetLibraryItemsSort](../../Models/Requests/GetLibraryItemsSort.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `Field` | List<[GetLibraryItemsField](../../Models/Requests/GetLibraryItemsField.md)> | :heavy_minus_sign: | N/A | |
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
@@ -14,6 +14,6 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `Show` | 2 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
@@ -46,4 +46,5 @@ Logged in user details
|
||||
| `Title` | *string* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
|
||||
| `TwoFactorEnabled` | *bool* | :heavy_minus_sign: | If two-factor authentication is enabled | |
|
||||
| `Username` | *string* | :heavy_check_mark: | The account username | Username |
|
||||
| `Uuid` | *string* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
|
||||
| `Uuid` | *string* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
|
||||
| `AttributionPartner` | *string* | :heavy_check_mark: | N/A | <nil> |
|
||||
@@ -14,6 +14,6 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `Show` | 2 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
9
docs/Models/Requests/HasThumbnail.md
Normal file
9
docs/Models/Requests/HasThumbnail.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# HasThumbnail
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `False` | 0 |
|
||||
| `True` | 1 |
|
||||
@@ -6,7 +6,7 @@ The Meta object is only included in the response if the `includeMeta` parameter
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `Type` | List<[GetLibraryItemsType](../../Models/Requests/GetLibraryItemsType.md)> | :heavy_minus_sign: | N/A |
|
||||
| `FieldType` | List<[GetLibraryItemsFieldType](../../Models/Requests/GetLibraryItemsFieldType.md)> | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `Type` | List<[GetLibraryItemsLibraryType](../../Models/Requests/GetLibraryItemsLibraryType.md)> | :heavy_minus_sign: | N/A |
|
||||
| `FieldType` | List<[GetLibraryItemsFieldType](../../Models/Requests/GetLibraryItemsFieldType.md)> | :heavy_minus_sign: | N/A |
|
||||
@@ -47,5 +47,6 @@ Returns the user account data with a valid auth token
|
||||
| `TwoFactorEnabled` | *bool* | :heavy_minus_sign: | If two-factor authentication is enabled | |
|
||||
| `Username` | *string* | :heavy_check_mark: | The account username | Username |
|
||||
| `Uuid` | *string* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
|
||||
| `AttributionPartner` | *string* | :heavy_check_mark: | N/A | <nil> |
|
||||
| `PastSubscriptions` | List<[PastSubscription](../../Models/Requests/PastSubscription.md)> | :heavy_check_mark: | N/A | |
|
||||
| `Trials` | List<[Trials](../../Models/Requests/Trials.md)> | :heavy_check_mark: | N/A | |
|
||||
@@ -14,6 +14,6 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `Show` | 2 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
20
docs/Models/Requests/ShowOrdering.md
Normal file
20
docs/Models/Requests/ShowOrdering.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# 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)).
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `None` | None |
|
||||
| `TmdbAiring` | tmdbAiring |
|
||||
| `Aired` | aired |
|
||||
| `Dvd` | dvd |
|
||||
| `Absolute` | absolute |
|
||||
@@ -14,6 +14,6 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `Show` | 2 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
11
docs/Models/Requests/UltraBlurColors.md
Normal file
11
docs/Models/Requests/UltraBlurColors.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# UltraBlurColors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `TopLeft` | *string* | :heavy_check_mark: | N/A | 11333b |
|
||||
| `TopRight` | *string* | :heavy_check_mark: | N/A | 0a232d |
|
||||
| `BottomRight` | *string* | :heavy_check_mark: | N/A | 73958 |
|
||||
| `BottomLeft` | *string* | :heavy_check_mark: | N/A | 1f5066 |
|
||||
Reference in New Issue
Block a user