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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.513.4

Browse Source
This commit is contained in:
speakeasybot
2025-03-10 00:10:34 +00:00
parent a229d5202b
commit c7cf202674
113 changed files with 2016 additions and 3320 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/Models/Errors/GetOnDeckBadRequest.md
View File

@@ -1,11 +0,0 @@
# GetOnDeckBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `errors` | array<[Errors\GetOnDeckErrors](../../Models/Errors/GetOnDeckErrors.md)> | :heavy_minus_sign: | N/A |
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

10
docs/Models/Errors/GetOnDeckErrors.md
View File

@@ -1,10 +0,0 @@
# GetOnDeckErrors
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |

10
docs/Models/Errors/GetOnDeckLibraryErrors.md
View File

@@ -1,10 +0,0 @@
# GetOnDeckLibraryErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |

11
docs/Models/Errors/GetOnDeckUnauthorized.md
View File

@@ -1,11 +0,0 @@
# GetOnDeckUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `errors` | array<[Errors\GetOnDeckLibraryErrors](../../Models/Errors/GetOnDeckLibraryErrors.md)> | :heavy_minus_sign: | N/A |
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

6
docs/Models/Operations/Collection.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *?string* | :heavy_minus_sign: | N/A | Working NL Subs |
| Field | Type | Required | Description | Example |
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| `tag` | *string* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |

10
docs/Models/Operations/Country.md
View File

@@ -1,8 +1,12 @@
# Country
The filter query string for country media items.
## Fields
| Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `tag` | *?string* | :heavy_minus_sign: | N/A | United States of America |
| Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 259 |
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
| `filter` | *?string* | :heavy_minus_sign: | N/A | country=19 |

6
docs/Models/Operations/Director.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *?string* | :heavy_minus_sign: | N/A | James Cameron |
| Field | Type | Required | Description | Example |
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
| `tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |

10
docs/Models/Operations/Genre.md
View File

@@ -1,8 +1,12 @@
# Genre
The filter query string for similar items.
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *?string* | :heavy_minus_sign: | N/A | Adventure |
| Field | Type | Required | Description | Example |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 259 |
| `filter` | *string* | :heavy_check_mark: | N/A | genre=19 |
| `tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |

6
docs/Models/Operations/GetAllMediaLibraryGenre.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
| Field | Type | Required | Description | Example |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |

8
docs/Models/Operations/GetAllMediaLibraryGuids.md Normal file
View File

@@ -0,0 +1,8 @@
# GetAllMediaLibraryGuids
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `id` | *?string* | :heavy_minus_sign: | The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337<br/> | tvdb://2337 |

42
docs/Models/Operations/GetAllMediaLibraryMedia.md
View File

@@ -3,24 +3,24 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `hasVoiceActivity` | *bool* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
| `part` | array<[Operations\GetAllMediaLibraryPart](../../Models/Operations/GetAllMediaLibraryPart.md)> | :heavy_check_mark: | An array of parts for this media item. | |
| `duration` | *?int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `width` | *?int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `height` | *?int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `aspectRatio` | *?float* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `audioChannels` | *?int* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `displayOffset` | *?int* | :heavy_minus_sign: | N/A | 50 |
| `audioCodec` | *?string* | :heavy_minus_sign: | Audio codec used. | eac3 |
| `videoCodec` | *?string* | :heavy_minus_sign: | Video codec used. | hevc |
| `videoResolution` | *?string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `container` | *?string* | :heavy_minus_sign: | File container type. | mkv |
| `videoFrameRate` | *?string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `videoProfile` | *?string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `audioProfile` | *?string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `optimizedForStreaming` | [Operations\One\|bool\|null](../../Models/Operations/GetAllMediaLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `duration` | *?int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `width` | *?int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `height` | *?int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `aspectRatio` | *?float* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `audioChannels` | *?int* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `displayOffset` | *?int* | :heavy_minus_sign: | N/A | 50 |
| `audioCodec` | *?string* | :heavy_minus_sign: | Audio codec used. | eac3 |
| `videoCodec` | *?string* | :heavy_minus_sign: | Video codec used. | hevc |
| `videoResolution` | *?string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `container` | *?string* | :heavy_minus_sign: | File container type. | mkv |
| `videoFrameRate` | *?string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `videoProfile` | *?string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `hasVoiceActivity` | *?bool* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
| `audioProfile` | *?string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `optimizedForStreaming` | [Operations\OptimizedForStreaming1\|bool\|null](../../Models/Operations/GetAllMediaLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| `part` | array<[Operations\GetAllMediaLibraryPart](../../Models/Operations/GetAllMediaLibraryPart.md)> | :heavy_minus_sign: | An array of parts for this media item. | |

4
docs/Models/Operations/GetAllMediaLibraryMetadata.md
View File

@@ -18,7 +18,6 @@ Unknown
| `summary` | *string* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
| `rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
| `audienceRating` | *float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `year` | *int* | :heavy_check_mark: | The release year of the media item. | 2022 |
| `tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
| `thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
| `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
@@ -31,6 +30,7 @@ Unknown
| `addedAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `studio` | *?string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `contentRating` | *?string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
| `year` | *?int* | :heavy_minus_sign: | The release year of the media item. | 2022 |
| `leafCount` | *?int* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `viewedLeafCount` | *?int* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
| `updatedAt` | *?int* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
@@ -70,5 +70,5 @@ Unknown
| `director` | array<[Operations\GetAllMediaLibraryDirector](../../Models/Operations/GetAllMediaLibraryDirector.md)> | :heavy_minus_sign: | N/A | |
| `writer` | array<[Operations\GetAllMediaLibraryWriter](../../Models/Operations/GetAllMediaLibraryWriter.md)> | :heavy_minus_sign: | N/A | |
| `role` | array<[Operations\GetAllMediaLibraryRole](../../Models/Operations/GetAllMediaLibraryRole.md)> | :heavy_minus_sign: | N/A | |
| `guids` | array<[Operations\Guids](../../Models/Operations/Guids.md)> | :heavy_minus_sign: | N/A | |
| `guids` | array<[Operations\GetAllMediaLibraryGuids](../../Models/Operations/GetAllMediaLibraryGuids.md)> | :heavy_minus_sign: | N/A | |
| `collection` | array<[Operations\GetAllMediaLibraryCollection](../../Models/Operations/GetAllMediaLibraryCollection.md)> | :heavy_minus_sign: | N/A | |

6
docs/Models/Operations/GetAllMediaLibraryOptimizedForStreaming.md
View File

@@ -5,13 +5,13 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
## Supported Types
### `Operations\One`
### `Operations\OptimizedForStreaming1`
```php
/**
* @var Operations\One
* @var Operations\OptimizedForStreaming1
*/
Operations\One $value = /* values here */
Operations\OptimizedForStreaming1 $value = /* values here */
```
### `bool`

6
docs/Models/Operations/GetAllMediaLibraryRole.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `tag` | *string* | :heavy_check_mark: | The name of the actor for this role | Danny Boyle |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
| `tag` | *string* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |

8
docs/Models/Operations/GetAllMediaLibraryStream.md
View File

@@ -9,13 +9,13 @@
| `streamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
| `language` | *string* | :heavy_check_mark: | Language of the stream. | English |
| `languageTag` | *string* | :heavy_check_mark: | Language tag (e.g., en). | en |
| `languageCode` | *string* | :heavy_check_mark: | ISO language code. | eng |
| `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `language` | *?string* | :heavy_minus_sign: | Language of the stream. | English |
| `languageTag` | *?string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
| `languageCode` | *?string* | :heavy_minus_sign: | ISO language code. | eng |
| `headerCompression` | *?bool* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
| `doviblCompatID` | *?int* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
| `doviblPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
@@ -30,6 +30,7 @@
| `chromaSubsampling` | *?string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
| `codedHeight` | *?int* | :heavy_minus_sign: | Coded video height. | 1608 |
| `codedWidth` | *?int* | :heavy_minus_sign: | Coded video width. | 3840 |
| `closedCaptions` | *?bool* | :heavy_minus_sign: | N/A | true |
| `colorPrimaries` | *?string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
| `colorRange` | *?string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
| `colorSpace` | *?string* | :heavy_minus_sign: | Color space. | bt2020nc |
@@ -41,6 +42,7 @@
| `hasScalingMatrix` | *?bool* | :heavy_minus_sign: | N/A | false |
| `profile` | *?string* | :heavy_minus_sign: | Video profile. | main 10 |
| `scanType` | *?string* | :heavy_minus_sign: | N/A | progressive |
| `embeddedInVideo` | *?string* | :heavy_minus_sign: | N/A | progressive |
| `refFrames` | *?int* | :heavy_minus_sign: | Number of reference frames. | 1 |
| `width` | *?int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `selected` | *?bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |

2
docs/Models/Operations/GetAllMediaLibraryWriter.md
View File

@@ -5,4 +5,4 @@
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *string* | :heavy_check_mark: | The role of Writer | Danny Boyle |
| `tag` | *string* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |

11
docs/Models/Operations/GetLibraryItemsEnableCreditsMarkerGeneration.md
View File

@@ -1,11 +0,0 @@
# GetLibraryItemsEnableCreditsMarkerGeneration
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Disabled` | 0 |

12
docs/Models/Operations/GetLibraryItemsEpisodeSort.md
View File

@@ -1,12 +0,0 @@
# GetLibraryItemsEpisodeSort
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `OldestFirst` | 0 |
| `NewestFirst` | 1 |

12
docs/Models/Operations/GetLibraryItemsFlattenSeasons.md
View File

@@ -1,12 +0,0 @@
# GetLibraryItemsFlattenSeasons
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Hide` | 0 |
| `Show` | 1 |

8
docs/Models/Operations/GetLibraryItemsMediaGuid.md
View File

@@ -1,8 +0,0 @@
# GetLibraryItemsMediaGuid
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `id` | *string* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |

10
docs/Models/Operations/GetLibraryItemsMetaDataRating.md
View File

@@ -1,10 +0,0 @@
# GetLibraryItemsMetaDataRating
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| `image` | *string* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
| `value` | *float* | :heavy_check_mark: | The value of the rating. | 3 |
| `type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |

12
docs/Models/Operations/GetLibraryItemsMetadata.md
View File

@@ -24,10 +24,10 @@
| `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` | [?Operations\GetLibraryItemsFlattenSeasons](../../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](../../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](../../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](../../Models/Operations/GetLibraryItemsShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
| `flattenSeasons` | [?Operations\FlattenSeasons](../../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](../../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](../../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](../../Models/Operations/ShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `banner` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
@@ -55,9 +55,9 @@
| `collection` | array<[Operations\GetLibraryItemsCollection](../../Models/Operations/GetLibraryItemsCollection.md)> | :heavy_minus_sign: | N/A | |
| `role` | array<[Operations\GetLibraryItemsRole](../../Models/Operations/GetLibraryItemsRole.md)> | :heavy_minus_sign: | N/A | |
| `location` | array<[Operations\GetLibraryItemsLocation](../../Models/Operations/GetLibraryItemsLocation.md)> | :heavy_minus_sign: | N/A | |
| `mediaGuid` | array<[Operations\GetLibraryItemsMediaGuid](../../Models/Operations/GetLibraryItemsMediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `mediaGuid` | array<[Operations\MediaGuid](../../Models/Operations/MediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `ultraBlurColors` | [?Operations\GetLibraryItemsUltraBlurColors](../../Models/Operations/GetLibraryItemsUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
| `metaDataRating` | array<[Operations\GetLibraryItemsMetaDataRating](../../Models/Operations/GetLibraryItemsMetaDataRating.md)> | :heavy_minus_sign: | N/A | |
| `metaDataRating` | array<[Operations\MetaDataRating](../../Models/Operations/MetaDataRating.md)> | :heavy_minus_sign: | N/A | |
| `image` | array<[Operations\GetLibraryItemsImage](../../Models/Operations/GetLibraryItemsImage.md)> | :heavy_minus_sign: | N/A | |
| `titleSort` | *?string* | :heavy_minus_sign: | N/A | Whale |
| `viewCount` | *?int* | :heavy_minus_sign: | N/A | 1 |

20
docs/Models/Operations/GetLibraryItemsShowOrdering.md
View File

@@ -1,20 +0,0 @@
# GetLibraryItemsShowOrdering
Setting that indicates the episode ordering for the show.
None = Library default,
tmdbAiring = The Movie Database (Aired),
aired = TheTVDB (Aired),
dvd = TheTVDB (DVD),
absolute = TheTVDB (Absolute)).
## Values
| Name | Value |
| -------------- | -------------- |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `TvdbAired` | aired |
| `TvdbDvd` | dvd |
| `TvdbAbsolute` | absolute |

6
docs/Models/Operations/GetMediaMetaDataLibraryOptimizedForStreaming.md
View File

@@ -5,13 +5,13 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
## Supported Types
### `Operations\GetMediaMetaDataOptimizedForStreaming1`
### `Operations\GetMediaMetaDataOptimizedForStreamingLibrary1`
```php
/**
* @var Operations\GetMediaMetaDataOptimizedForStreaming1
* @var Operations\GetMediaMetaDataOptimizedForStreamingLibrary1
*/
Operations\GetMediaMetaDataOptimizedForStreaming1 $value = /* values here */
Operations\GetMediaMetaDataOptimizedForStreamingLibrary1 $value = /* values here */
```
### `bool`

42
docs/Models/Operations/GetMediaMetaDataMedia.md
View File

@@ -3,24 +3,24 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `hasVoiceActivity` | *bool* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
| `part` | array<[Operations\GetMediaMetaDataPart](../../Models/Operations/GetMediaMetaDataPart.md)> | :heavy_check_mark: | An array of parts for this media item. | |
| `duration` | *?int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `width` | *?int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `height` | *?int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `aspectRatio` | *?float* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `audioChannels` | *?int* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `displayOffset` | *?int* | :heavy_minus_sign: | N/A | 50 |
| `audioCodec` | *?string* | :heavy_minus_sign: | Audio codec used. | eac3 |
| `videoCodec` | *?string* | :heavy_minus_sign: | Video codec used. | hevc |
| `videoResolution` | *?string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `container` | *?string* | :heavy_minus_sign: | File container type. | mkv |
| `videoFrameRate` | *?string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `videoProfile` | *?string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `audioProfile` | *?string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `optimizedForStreaming` | [Operations\OptimizedForStreaming1\|bool\|null](../../Models/Operations/GetMediaMetaDataOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `duration` | *?int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `width` | *?int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `height` | *?int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `aspectRatio` | *?float* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `audioChannels` | *?int* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `displayOffset` | *?int* | :heavy_minus_sign: | N/A | 50 |
| `audioCodec` | *?string* | :heavy_minus_sign: | Audio codec used. | eac3 |
| `videoCodec` | *?string* | :heavy_minus_sign: | Video codec used. | hevc |
| `videoResolution` | *?string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `container` | *?string* | :heavy_minus_sign: | File container type. | mkv |
| `videoFrameRate` | *?string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `videoProfile` | *?string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `hasVoiceActivity` | *?bool* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
| `audioProfile` | *?string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `optimizedForStreaming` | [Operations\GetMediaMetaDataOptimizedForStreaming1\|bool\|null](../../Models/Operations/GetMediaMetaDataOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| `part` | array<[Operations\GetMediaMetaDataPart](../../Models/Operations/GetMediaMetaDataPart.md)> | :heavy_minus_sign: | An array of parts for this media item. | |

4
docs/Models/Operations/GetMediaMetaDataMetadata.md
View File

@@ -63,6 +63,6 @@
| `role` | array<[Operations\GetMediaMetaDataRole](../../Models/Operations/GetMediaMetaDataRole.md)> | :heavy_minus_sign: | An array of Actor roles. | |
| `director` | array<[Operations\GetMediaMetaDataDirector](../../Models/Operations/GetMediaMetaDataDirector.md)> | :heavy_minus_sign: | An array of Director roles. | |
| `writer` | array<[Operations\GetMediaMetaDataWriter](../../Models/Operations/GetMediaMetaDataWriter.md)> | :heavy_minus_sign: | An array of Writer roles. | |
| `producer` | array<[Operations\Producer](../../Models/Operations/Producer.md)> | :heavy_minus_sign: | An array of Writer roles. | |
| `similar` | array<[Operations\Similar](../../Models/Operations/Similar.md)> | :heavy_minus_sign: | An array of similar content objects. | |
| `producer` | array<[Operations\GetMediaMetaDataProducer](../../Models/Operations/GetMediaMetaDataProducer.md)> | :heavy_minus_sign: | An array of Writer roles. | |
| `similar` | array<[Operations\GetMediaMetaDataSimilar](../../Models/Operations/GetMediaMetaDataSimilar.md)> | :heavy_minus_sign: | An array of similar content objects. | |
| `location` | array<[Operations\GetMediaMetaDataLocation](../../Models/Operations/GetMediaMetaDataLocation.md)> | :heavy_minus_sign: | An array of location objects. | |

6
docs/Models/Operations/GetMediaMetaDataOptimizedForStreaming.md
View File

@@ -5,13 +5,13 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
## Supported Types
### `Operations\OptimizedForStreaming1`
### `Operations\GetMediaMetaDataOptimizedForStreaming1`
```php
/**
* @var Operations\OptimizedForStreaming1
* @var Operations\GetMediaMetaDataOptimizedForStreaming1
*/
Operations\OptimizedForStreaming1 $value = /* values here */
Operations\GetMediaMetaDataOptimizedForStreaming1 $value = /* values here */
```
### `bool`

9
docs/Models/Operations/GetMediaMetaDataOptimizedForStreamingLibrary1.md Normal file
View File

@@ -0,0 +1,9 @@
# GetMediaMetaDataOptimizedForStreamingLibrary1
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

36
docs/Models/Operations/GetMediaMetaDataPart.md
View File

@@ -3,21 +3,21 @@
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `accessible` | *?bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `exists` | *?bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `indexes` | *?string* | :heavy_minus_sign: | N/A | sd |
| `duration` | *?int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `packetLength` | *?int* | :heavy_minus_sign: | N/A | 188 |
| `container` | *?string* | :heavy_minus_sign: | Container format of the part. | mkv |
| `videoProfile` | *?string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
| `audioProfile` | *?string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | [Operations\GetMediaMetaDataOptimizedForStreaming1\|bool\|null](../../Models/Operations/GetMediaMetaDataLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `hasThumbnail` | [?Operations\GetMediaMetaDataHasThumbnail](../../Models/Operations/GetMediaMetaDataHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | array<[Operations\GetMediaMetaDataStream](../../Models/Operations/GetMediaMetaDataStream.md)> | :heavy_minus_sign: | An array of streams for this part. | |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `accessible` | *?bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `exists` | *?bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `indexes` | *?string* | :heavy_minus_sign: | N/A | sd |
| `duration` | *?int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `packetLength` | *?int* | :heavy_minus_sign: | N/A | 188 |
| `container` | *?string* | :heavy_minus_sign: | Container format of the part. | mkv |
| `videoProfile` | *?string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
| `audioProfile` | *?string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | [Operations\GetMediaMetaDataOptimizedForStreamingLibrary1\|bool\|null](../../Models/Operations/GetMediaMetaDataLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `hasThumbnail` | [?Operations\GetMediaMetaDataHasThumbnail](../../Models/Operations/GetMediaMetaDataHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | array<[Operations\GetMediaMetaDataStream](../../Models/Operations/GetMediaMetaDataStream.md)> | :heavy_minus_sign: | An array of streams for this part. | |

13
docs/Models/Operations/GetMediaMetaDataProducer.md Normal file
View File

@@ -0,0 +1,13 @@
# GetMediaMetaDataProducer
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique role identifier. | 109501 |
| `filter` | *string* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
| `tag` | *string* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
| `tagKey` | *string* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
| `role` | *?string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
| `thumb` | *?string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |

10
docs/Models/Operations/GetMediaMetaDataSimilar.md Normal file
View File

@@ -0,0 +1,10 @@
# GetMediaMetaDataSimilar
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique similar item identifier. | 26 |
| `filter` | *string* | :heavy_check_mark: | The filter string for similar items. | similar=26 |
| `tag` | *string* | :heavy_check_mark: | The tag or title of the similar content. | Breaking Bad |

8
docs/Models/Operations/GetMediaMetaDataStream.md
View File

@@ -9,13 +9,13 @@
| `streamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
| `language` | *string* | :heavy_check_mark: | Language of the stream. | English |
| `languageTag` | *string* | :heavy_check_mark: | Language tag (e.g., en). | en |
| `languageCode` | *string* | :heavy_check_mark: | ISO language code. | eng |
| `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `language` | *?string* | :heavy_minus_sign: | Language of the stream. | English |
| `languageTag` | *?string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
| `languageCode` | *?string* | :heavy_minus_sign: | ISO language code. | eng |
| `headerCompression` | *?bool* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
| `doviblCompatID` | *?int* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
| `doviblPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
@@ -30,6 +30,7 @@
| `chromaSubsampling` | *?string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
| `codedHeight` | *?int* | :heavy_minus_sign: | Coded video height. | 1608 |
| `codedWidth` | *?int* | :heavy_minus_sign: | Coded video width. | 3840 |
| `closedCaptions` | *?bool* | :heavy_minus_sign: | N/A | true |
| `colorPrimaries` | *?string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
| `colorRange` | *?string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
| `colorSpace` | *?string* | :heavy_minus_sign: | Color space. | bt2020nc |
@@ -41,6 +42,7 @@
| `hasScalingMatrix` | *?bool* | :heavy_minus_sign: | N/A | false |
| `profile` | *?string* | :heavy_minus_sign: | Video profile. | main 10 |
| `scanType` | *?string* | :heavy_minus_sign: | N/A | progressive |
| `embeddedInVideo` | *?string* | :heavy_minus_sign: | N/A | progressive |
| `refFrames` | *?int* | :heavy_minus_sign: | Number of reference frames. | 1 |
| `width` | *?int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `selected` | *?bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |

8
docs/Models/Operations/GetOnDeckGuids.md
View File

@@ -1,8 +0,0 @@
# GetOnDeckGuids
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *?string* | :heavy_minus_sign: | N/A | imdb://tt13303712 |

22
docs/Models/Operations/GetOnDeckMedia.md
View File

@@ -1,22 +0,0 @@
# GetOnDeckMedia
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `id` | *?float* | :heavy_minus_sign: | N/A | 80994 |
| `duration` | *?float* | :heavy_minus_sign: | N/A | 420080 |
| `bitrate` | *?float* | :heavy_minus_sign: | N/A | 1046 |
| `width` | *?float* | :heavy_minus_sign: | N/A | 1920 |
| `height` | *?float* | :heavy_minus_sign: | N/A | 1080 |
| `aspectRatio` | *?float* | :heavy_minus_sign: | N/A | 1.78 |
| `audioChannels` | *?float* | :heavy_minus_sign: | N/A | 2 |
| `audioCodec` | *?string* | :heavy_minus_sign: | N/A | aac |
| `videoCodec` | *?string* | :heavy_minus_sign: | N/A | hevc |
| `videoResolution` | *?string* | :heavy_minus_sign: | N/A | 1080 |
| `container` | *?string* | :heavy_minus_sign: | N/A | mkv |
| `videoFrameRate` | *?string* | :heavy_minus_sign: | N/A | PAL |
| `audioProfile` | *?string* | :heavy_minus_sign: | N/A | lc |
| `videoProfile` | *?string* | :heavy_minus_sign: | N/A | main |
| `part` | array<[Operations\GetOnDeckPart](../../Models/Operations/GetOnDeckPart.md)> | :heavy_minus_sign: | N/A | |

14
docs/Models/Operations/GetOnDeckMediaContainer.md
View File

@@ -1,14 +0,0 @@
# GetOnDeckMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `size` | *?float* | :heavy_minus_sign: | N/A | 16 |
| `allowSync` | *?bool* | :heavy_minus_sign: | N/A | |
| `identifier` | *?string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `mediaTagPrefix` | *?string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *?float* | :heavy_minus_sign: | N/A | 1680021154 |
| `mixedParents` | *?bool* | :heavy_minus_sign: | N/A | |
| `metadata` | array<[Operations\GetOnDeckMetadata](../../Models/Operations/GetOnDeckMetadata.md)> | :heavy_minus_sign: | N/A | |

43
docs/Models/Operations/GetOnDeckMetadata.md
View File

@@ -1,43 +0,0 @@
# GetOnDeckMetadata
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `allowSync` | *?bool* | :heavy_minus_sign: | N/A | |
| `librarySectionID` | *?float* | :heavy_minus_sign: | N/A | 2 |
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | N/A | TV Shows |
| `librarySectionUUID` | *?string* | :heavy_minus_sign: | N/A | 4bb2521c-8ba9-459b-aaee-8ab8bc35eabd |
| `ratingKey` | *?float* | :heavy_minus_sign: | N/A | 49564 |
| `key` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/49564 |
| `parentRatingKey` | *?float* | :heavy_minus_sign: | N/A | 49557 |
| `grandparentRatingKey` | *?float* | :heavy_minus_sign: | N/A | 49556 |
| `guid` | *?string* | :heavy_minus_sign: | N/A | plex://episode/5ea7d7402e7ab10042e74d4f |
| `parentGuid` | *?string* | :heavy_minus_sign: | N/A | plex://season/602e754d67f4c8002ce54b3d |
| `grandparentGuid` | *?string* | :heavy_minus_sign: | N/A | plex://show/5d9c090e705e7a001e6e94d8 |
| `type` | *?string* | :heavy_minus_sign: | N/A | episode |
| `title` | *?string* | :heavy_minus_sign: | N/A | Circus |
| `grandparentKey` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/49556 |
| `parentKey` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/49557 |
| `librarySectionKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/2 |
| `grandparentTitle` | *?string* | :heavy_minus_sign: | N/A | Bluey (2018) |
| `parentTitle` | *?string* | :heavy_minus_sign: | N/A | Season 2 |
| `contentRating` | *?string* | :heavy_minus_sign: | N/A | TV-Y |
| `summary` | *?string* | :heavy_minus_sign: | N/A | Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy. |
| `index` | *?float* | :heavy_minus_sign: | N/A | 33 |
| `parentIndex` | *?float* | :heavy_minus_sign: | N/A | 2 |
| `lastViewedAt` | *?float* | :heavy_minus_sign: | N/A | 1681908352 |
| `year` | *?float* | :heavy_minus_sign: | N/A | 2018 |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/49564/thumb/1654258204 |
| `art` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/49556/art/1680939546 |
| `parentThumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/49557/thumb/1654258204 |
| `grandparentThumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/49556/thumb/1680939546 |
| `grandparentArt` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/49556/art/1680939546 |
| `grandparentTheme` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/49556/theme/1680939546 |
| `duration` | *?float* | :heavy_minus_sign: | N/A | 420080 |
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A | 2020-10-31 00:00:00 +0000 UTC |
| `addedAt` | *?float* | :heavy_minus_sign: | N/A | 1654258196 |
| `updatedAt` | *?float* | :heavy_minus_sign: | N/A | 1654258204 |
| `media` | array<[Operations\GetOnDeckMedia](../../Models/Operations/GetOnDeckMedia.md)> | :heavy_minus_sign: | N/A | |
| `guids` | array<[Operations\GetOnDeckGuids](../../Models/Operations/GetOnDeckGuids.md)> | :heavy_minus_sign: | N/A | |

16
docs/Models/Operations/GetOnDeckPart.md
View File

@@ -1,16 +0,0 @@
# GetOnDeckPart
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `id` | *?float* | :heavy_minus_sign: | N/A | 80994 |
| `key` | *?string* | :heavy_minus_sign: | N/A | /library/parts/80994/1655007810/file.mkv |
| `duration` | *?float* | :heavy_minus_sign: | N/A | 420080 |
| `file` | *?string* | :heavy_minus_sign: | N/A | /tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv |
| `size` | *?float* | :heavy_minus_sign: | N/A | 55148931 |
| `audioProfile` | *?string* | :heavy_minus_sign: | N/A | lc |
| `container` | *?string* | :heavy_minus_sign: | N/A | mkv |
| `videoProfile` | *?string* | :heavy_minus_sign: | N/A | main |
| `stream` | array<[Operations\GetOnDeckStream](../../Models/Operations/GetOnDeckStream.md)> | :heavy_minus_sign: | N/A | |

11
docs/Models/Operations/GetOnDeckResponse.md
View File

@@ -1,11 +0,0 @@
# GetOnDeckResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [?Operations\GetOnDeckResponseBody](../../Models/Operations/GetOnDeckResponseBody.md) | :heavy_minus_sign: | The on Deck content |

10
docs/Models/Operations/GetOnDeckResponseBody.md
View File

@@ -1,10 +0,0 @@
# GetOnDeckResponseBody
The on Deck content
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `mediaContainer` | [?Operations\GetOnDeckMediaContainer](../../Models/Operations/GetOnDeckMediaContainer.md) | :heavy_minus_sign: | N/A |

30
docs/Models/Operations/GetOnDeckStream.md
View File

@@ -1,30 +0,0 @@
# GetOnDeckStream
## Fields
| Field | Type | Required | Description | Example |
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `id` | *?float* | :heavy_minus_sign: | N/A | 211234 |
| `streamType` | *?float* | :heavy_minus_sign: | N/A | 1 |
| `default` | *?bool* | :heavy_minus_sign: | N/A | |
| `codec` | *?string* | :heavy_minus_sign: | N/A | hevc |
| `index` | *?float* | :heavy_minus_sign: | N/A | 0 |
| `bitrate` | *?float* | :heavy_minus_sign: | N/A | 918 |
| `language` | *?string* | :heavy_minus_sign: | N/A | English |
| `languageTag` | *?string* | :heavy_minus_sign: | N/A | en |
| `languageCode` | *?string* | :heavy_minus_sign: | N/A | eng |
| `bitDepth` | *?float* | :heavy_minus_sign: | N/A | 8 |
| `chromaLocation` | *?string* | :heavy_minus_sign: | N/A | left |
| `chromaSubsampling` | *?string* | :heavy_minus_sign: | N/A | 4:2:0 |
| `codedHeight` | *?float* | :heavy_minus_sign: | N/A | 1080 |
| `codedWidth` | *?float* | :heavy_minus_sign: | N/A | 1920 |
| `colorRange` | *?string* | :heavy_minus_sign: | N/A | tv |
| `frameRate` | *?float* | :heavy_minus_sign: | N/A | 25 |
| `height` | *?float* | :heavy_minus_sign: | N/A | 1080 |
| `level` | *?float* | :heavy_minus_sign: | N/A | 120 |
| `profile` | *?string* | :heavy_minus_sign: | N/A | main |
| `refFrames` | *?float* | :heavy_minus_sign: | N/A | 1 |
| `width` | *?float* | :heavy_minus_sign: | N/A | 1920 |
| `displayTitle` | *?string* | :heavy_minus_sign: | N/A | 1080p (HEVC Main) |
| `extendedDisplayTitle` | *?string* | :heavy_minus_sign: | N/A | 1080p (HEVC Main) |

12
docs/Models/Operations/GetRecentlyAddedMediaContainer.md
View File

@@ -5,10 +5,10 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `size` | *int* | :heavy_check_mark: | N/A | 50 |
| `offset` | *?int* | :heavy_minus_sign: | N/A | |
| `totalSize` | *?int* | :heavy_minus_sign: | N/A | |
| `identifier` | *?string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `allowSync` | *?bool* | :heavy_minus_sign: | N/A | false |
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `totalSize` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
| `offset` | *int* | :heavy_check_mark: | Offset value for pagination. | 0 |
| `allowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `meta` | [?Operations\Meta](../../Models/Operations/Meta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
| `metadata` | array<[Operations\GetRecentlyAddedMetadata](../../Models/Operations/GetRecentlyAddedMetadata.md)> | :heavy_minus_sign: | N/A | |
| `metadata` | array<[Operations\GetRecentlyAddedMetadata](../../Models/Operations/GetRecentlyAddedMetadata.md)> | :heavy_minus_sign: | An array of metadata items. | |

158
docs/Models/Operations/GetRecentlyAddedMetadata.md
View File

@@ -1,83 +1,85 @@
# GetRecentlyAddedMetadata
Unknown
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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 |
| `type` | [Operations\GetRecentlyAddedHubsType](../../Models/Operations/GetRecentlyAddedHubsType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `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. |
| `addedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `studio` | *?string* | :heavy_minus_sign: | N/A | 20th Century Studios |
| `skipChildren` | *?bool* | :heavy_minus_sign: | N/A | false |
| `librarySectionID` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `slug` | *?string* | :heavy_minus_sign: | N/A | 4-for-texas |
| `contentRating` | *?string* | :heavy_minus_sign: | N/A | PG-13 |
| `rating` | *?float* | :heavy_minus_sign: | N/A | 7.6 |
| `audienceRating` | *?float* | :heavy_minus_sign: | N/A | 9.2 |
| `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` | [?Operations\FlattenSeasons](../../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](../../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](../../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](../../Models/Operations/ShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `banner` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
| `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 |
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
| `updatedAt` | *?int* | :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 |
| `ratingImage` | *?string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
| `grandparentRatingKey` | *?string* | :heavy_minus_sign: | N/A | 66 |
| `grandparentGuid` | *?string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
| `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 |
| `parentSlug` | *?string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
| `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` | array<[Operations\Media](../../Models/Operations/Media.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
| `genre` | array<[Operations\Genre](../../Models/Operations/Genre.md)> | :heavy_minus_sign: | N/A | |
| `country` | array<[Operations\Country](../../Models/Operations/Country.md)> | :heavy_minus_sign: | N/A | |
| `director` | array<[Operations\Director](../../Models/Operations/Director.md)> | :heavy_minus_sign: | N/A | |
| `writer` | array<[Operations\Writer](../../Models/Operations/Writer.md)> | :heavy_minus_sign: | N/A | |
| `collection` | array<[Operations\Collection](../../Models/Operations/Collection.md)> | :heavy_minus_sign: | N/A | |
| `role` | array<[Operations\Role](../../Models/Operations/Role.md)> | :heavy_minus_sign: | N/A | |
| `location` | array<[Operations\Location](../../Models/Operations/Location.md)> | :heavy_minus_sign: | N/A | |
| `mediaGuid` | array<[Operations\MediaGuid](../../Models/Operations/MediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `ultraBlurColors` | [?Operations\UltraBlurColors](../../Models/Operations/UltraBlurColors.md) | :heavy_minus_sign: | N/A | |
| `metaDataRating` | array<[Operations\MetaDataRating](../../Models/Operations/MetaDataRating.md)> | :heavy_minus_sign: | N/A | |
| `image` | array<[Operations\GetRecentlyAddedImage](../../Models/Operations/GetRecentlyAddedImage.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 |
| `originalTitle` | *?string* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
| `viewOffset` | *?int* | :heavy_minus_sign: | N/A | 5222500 |
| `skipCount` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `index` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `theme` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
| `leafCount` | *?int* | :heavy_minus_sign: | N/A | 14 |
| `viewedLeafCount` | *?int* | :heavy_minus_sign: | N/A | 0 |
| `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: | 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 |
| `parentTitle` | *?string* | :heavy_minus_sign: | N/A | Caprica |
| `parentIndex` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `parentYear` | *?int* | :heavy_minus_sign: | N/A | 2010 |
| `parentThumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `parentTheme` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `addedAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
| `audienceRating` | *float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `childCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
| `guid` | *string* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
| `index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
| `key` | *string* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
| `librarySectionID` | *int* | :heavy_check_mark: | The identifier for the library section. | 1 |
| `librarySectionKey` | *string* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | Movies |
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
| `parentStudio` | *string* | :heavy_check_mark: | The studio of the parent media item. | UCP |
| `parentTheme` | *string* | :heavy_check_mark: | The theme URL for the parent media item. | /library/metadata/66/theme/1705716261 |
| `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. | 58683 |
| `rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
| `seasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
| `slug` | *string* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
| `summary` | *string* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
| `tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
| `theme` | *string* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
| `thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
| `titleSort` | *string* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
| `title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
| `type` | [Operations\GetRecentlyAddedHubsType](../../Models/Operations/GetRecentlyAddedHubsType.md) | :heavy_check_mark: | N/A | movie |
| `audienceRatingImage` | *?string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
| `chapterSource` | *?string* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
| `contentRating` | *?string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
| `createdAtAccuracy` | *?string* | :heavy_minus_sign: | The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). | epoch,local |
| `createdAtTZOffset` | *?string* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
| `grandparentArt` | *?string* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
| `grandparentGuid` | *?string* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparentKey` | *?string* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
| `grandparentRatingKey` | *?string* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
| `grandparentSlug` | *?string* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
| `grandparentTheme` | *?string* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
| `grandparentThumb` | *?string* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
| `grandparentTitle` | *?string* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
| `lastRatedAt` | *?int* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
| `lastViewedAt` | *?int* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
| `leafCount` | *?int* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `originalTitle` | *?string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
| `parentGuid` | *?string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `parentIndex` | *?int* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
| `parentKey` | *?string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
| `parentRatingKey` | *?string* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
| `parentSlug` | *?string* | :heavy_minus_sign: | The slug for the parent media item. | alice-in-borderland-2020 |
| `parentThumb` | *?string* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
| `parentTitle` | *?string* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
| `parentYear` | *?int* | :heavy_minus_sign: | The release year of the parent media item. | 2010 |
| `primaryExtraKey` | *?string* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
| `ratingImage` | *?string* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
| `skipCount` | *?int* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
| `studio` | *?string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `subtype` | *?string* | :heavy_minus_sign: | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
| `updatedAt` | *?int* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `userRating` | *?float* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
| `viewCount` | *?int* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
| `viewOffset` | *?int* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
| `viewedLeafCount` | *?int* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
| `year` | *?int* | :heavy_minus_sign: | The release year of the media item. | 2022 |
| `image` | array<[Operations\GetRecentlyAddedImage](../../Models/Operations/GetRecentlyAddedImage.md)> | :heavy_minus_sign: | N/A | |
| `ultraBlurColors` | [?Operations\UltraBlurColors](../../Models/Operations/UltraBlurColors.md) | :heavy_minus_sign: | N/A | |
| `media` | array<[Operations\Media](../../Models/Operations/Media.md)> | :heavy_minus_sign: | N/A | |
| `genre` | array<[Operations\Genre](../../Models/Operations/Genre.md)> | :heavy_minus_sign: | N/A | |
| `country` | array<[Operations\Country](../../Models/Operations/Country.md)> | :heavy_minus_sign: | N/A | |
| `director` | array<[Operations\Director](../../Models/Operations/Director.md)> | :heavy_minus_sign: | N/A | |
| `writer` | array<[Operations\Writer](../../Models/Operations/Writer.md)> | :heavy_minus_sign: | N/A | |
| `role` | array<[Operations\Role](../../Models/Operations/Role.md)> | :heavy_minus_sign: | N/A | |
| `producer` | array<[Operations\Producer](../../Models/Operations/Producer.md)> | :heavy_minus_sign: | N/A | |
| `rating1` | array<[Operations\Rating](../../Models/Operations/Rating.md)> | :heavy_minus_sign: | N/A | |
| `similar` | array<[Operations\Similar](../../Models/Operations/Similar.md)> | :heavy_minus_sign: | N/A | |
| `location` | array<[Operations\Location](../../Models/Operations/Location.md)> | :heavy_minus_sign: | N/A | |
| `guids` | array<[Operations\Guids](../../Models/Operations/Guids.md)> | :heavy_minus_sign: | N/A | |
| `collection` | array<[Operations\Collection](../../Models/Operations/Collection.md)> | :heavy_minus_sign: | N/A | |

25
docs/Models/Operations/GetRecentlyAddedOptimizedForStreaming.md Normal file
View File

@@ -0,0 +1,25 @@
# GetRecentlyAddedOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Supported Types
### `Operations\GetRecentlyAddedOptimizedForStreaming1`
```php
/**
* @var Operations\GetRecentlyAddedOptimizedForStreaming1
*/
Operations\GetRecentlyAddedOptimizedForStreaming1 $value = /* values here */
```
### `bool`
```php
/**
* @var bool
*/
bool $value = /* values here */
```

9
docs/Models/Operations/GetRecentlyAddedOptimizedForStreaming1.md Normal file
View File

@@ -0,0 +1,9 @@
# GetRecentlyAddedOptimizedForStreaming1
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

2
docs/Models/Operations/HasThumbnail.md
View File

@@ -1,5 +1,7 @@
# HasThumbnail
Indicates if the part has a thumbnail.
## Values

8
docs/Models/Operations/Location.md
View File

@@ -1,8 +1,10 @@
# Location
The folder path for the media item.
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `path` | *?string* | :heavy_minus_sign: | N/A | /TV Shows/House |
| Field | Type | Required | Description | Example |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `path` | *string* | :heavy_check_mark: | N/A | /TV Shows/Clarkson's Farm |

41
docs/Models/Operations/Media.md
View File

@@ -3,23 +3,24 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
| `container` | *string* | :heavy_check_mark: | N/A | mkv |
| `part` | array<[Operations\Part](../../Models/Operations/Part.md)> | :heavy_check_mark: | N/A | |
| `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` | *?float* | :heavy_minus_sign: | N/A | 1.85 |
| `audioProfile` | *?string* | :heavy_minus_sign: | N/A | dts |
| `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 |
| `videoFrameRate` | *?string* | :heavy_minus_sign: | N/A | 24p |
| `videoProfile` | *?string* | :heavy_minus_sign: | N/A | main 10 |
| `hasVoiceActivity` | *?bool* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | [?Operations\OptimizedForStreaming](../../Models/Operations/OptimizedForStreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `duration` | *?int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `width` | *?int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `height` | *?int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `aspectRatio` | *?float* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `audioChannels` | *?int* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `displayOffset` | *?int* | :heavy_minus_sign: | N/A | 50 |
| `audioCodec` | *?string* | :heavy_minus_sign: | Audio codec used. | eac3 |
| `videoCodec` | *?string* | :heavy_minus_sign: | Video codec used. | hevc |
| `videoResolution` | *?string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `container` | *?string* | :heavy_minus_sign: | File container type. | mkv |
| `videoFrameRate` | *?string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `videoProfile` | *?string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `hasVoiceActivity` | *?bool* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
| `audioProfile` | *?string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `optimizedForStreaming` | [Operations\One\|bool\|null](../../Models/Operations/OptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| `part` | array<[Operations\Part](../../Models/Operations/Part.md)> | :heavy_minus_sign: | An array of parts for this media item. | |

26
docs/Models/Operations/OptimizedForStreaming.md
View File

@@ -1,9 +1,25 @@
# OptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |
## Supported Types
### `Operations\One`
```php
/**
* @var Operations\One
*/
Operations\One $value = /* values here */
```
### `bool`
```php
/**
* @var bool
*/
bool $value = /* values here */
```

33
docs/Models/Operations/Part.md
View File

@@ -3,18 +3,21 @@
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119542 |
| `key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
| `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` | *int* | :heavy_check_mark: | N/A | 36158371307 |
| `container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
| `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 |
| `audioProfile` | *?string* | :heavy_minus_sign: | N/A | dts |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | *?bool* | :heavy_minus_sign: | N/A | false |
| `videoProfile` | *?string* | :heavy_minus_sign: | N/A | main 10 |
| `indexes` | *?string* | :heavy_minus_sign: | N/A | sd |
| `hasThumbnail` | [?Operations\HasThumbnail](../../Models/Operations/HasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | array<[Operations\Stream](../../Models/Operations/Stream.md)> | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `accessible` | *?bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `exists` | *?bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `indexes` | *?string* | :heavy_minus_sign: | N/A | sd |
| `duration` | *?int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `packetLength` | *?int* | :heavy_minus_sign: | N/A | 188 |
| `container` | *?string* | :heavy_minus_sign: | Container format of the part. | mkv |
| `videoProfile` | *?string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
| `audioProfile` | *?string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | [Operations\GetRecentlyAddedOptimizedForStreaming1\|bool\|null](../../Models/Operations/GetRecentlyAddedOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `hasThumbnail` | [?Operations\HasThumbnail](../../Models/Operations/HasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | array<[Operations\Stream](../../Models/Operations/Stream.md)> | :heavy_minus_sign: | An array of streams for this part. | |

15
docs/Models/Operations/Producer.md
View File

@@ -3,11 +3,10 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique role identifier. | 109501 |
| `filter` | *string* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
| `tag` | *string* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
| `tagKey` | *string* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
| `role` | *?string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
| `thumb` | *?string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique identifier for the producer. | 126522 |
| `filter` | *string* | :heavy_check_mark: | The filter string used to query this producer. | producer=126522 |
| `tag` | *string* | :heavy_check_mark: | The name of the producer | Amelia Knapp |
| `tagKey` | *?string* | :heavy_minus_sign: | A unique key associated with the producer's tag, used for internal identification. | 5d77683d85719b001f3a535e |
| `thumb` | *?string* | :heavy_minus_sign: | The URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |

12
docs/Models/Operations/Rating.md Normal file
View File

@@ -0,0 +1,12 @@
# Rating
The type of rating, for example 'audience' or 'critic'.
## Fields
| Field | Type | Required | Description | Example |
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
| `image` | *string* | :heavy_check_mark: | N/A | imdb://image.rating |
| `value` | *float* | :heavy_check_mark: | N/A | 5.1 |
| `type` | *string* | :heavy_check_mark: | N/A | audience |

16
docs/Models/Operations/Role.md
View File

@@ -3,11 +3,11 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *?int* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 |
| `filter` | *?string* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 |
| `thumb` | *?string* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
| `tag` | *?string* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
| `tagKey` | *?string* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
| `role` | *?string* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique identifier for the actor or role. | 126522 |
| `filter` | *string* | :heavy_check_mark: | The filter string used to query this actor. For example, it may indicate that this is an actor with a given key. | actor=126522 |
| `tag` | *string* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
| `tagKey` | *?string* | :heavy_minus_sign: | A unique key associated with the actor's tag, used for internal identification. | 5d77683d85719b001f3a535e |
| `role` | *?string* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
| `thumb` | *?string* | :heavy_minus_sign: | The URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |

12
docs/Models/Operations/Similar.md
View File

@@ -1,10 +1,12 @@
# Similar
The display tag for the similar item, typically the title.
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique similar item identifier. | 26 |
| `filter` | *string* | :heavy_check_mark: | The filter string for similar items. | similar=26 |
| `tag` | *string* | :heavy_check_mark: | The tag or title of the similar content. | Breaking Bad |
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 259 |
| `filter` | *string* | :heavy_check_mark: | N/A | similar=259 |
| `tag` | *string* | :heavy_check_mark: | N/A | Criss Angel Mindfreak |

91
docs/Models/Operations/Stream.md
View File

@@ -3,43 +3,54 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 272796 |
| `streamType` | *int* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream | h264 |
| `index` | *int* | :heavy_check_mark: | The index of the stream | 0 |
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this is the default stream | true |
| `selected` | *?bool* | :heavy_minus_sign: | Indicates if the stream is selected | true |
| `bitrate` | *?int* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
| `colorPrimaries` | *?string* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
| `colorRange` | *?string* | :heavy_minus_sign: | The color range of the video stream | tv |
| `colorSpace` | *?string* | :heavy_minus_sign: | The color space of the video stream | bt709 |
| `colorTrc` | *?string* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
| `bitDepth` | *?int* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
| `chromaLocation` | *?string* | :heavy_minus_sign: | The chroma location of the video stream | left |
| `streamIdentifier` | *?string* | :heavy_minus_sign: | The identifier of the video stream | 2 |
| `chromaSubsampling` | *?string* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
| `codedHeight` | *?int* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
| `codedWidth` | *?int* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
| `frameRate` | *?float* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
| `hasScalingMatrix` | *?bool* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
| `hearingImpaired` | *?bool* | :heavy_minus_sign: | N/A | false |
| `closedCaptions` | *?bool* | :heavy_minus_sign: | N/A | false |
| `embeddedInVideo` | *?string* | :heavy_minus_sign: | N/A | 1 |
| `height` | *?int* | :heavy_minus_sign: | The height of the video stream | 1080 |
| `level` | *?int* | :heavy_minus_sign: | The level of the video codec | 40 |
| `profile` | *?string* | :heavy_minus_sign: | The profile of the video codec | main |
| `refFrames` | *?int* | :heavy_minus_sign: | Number of reference frames | 4 |
| `scanType` | *?string* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
| `width` | *?int* | :heavy_minus_sign: | The width of the video stream | 1920 |
| `displayTitle` | *?string* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
| `extendedDisplayTitle` | *?string* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
| `channels` | *?int* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
| `language` | *?string* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
| `languageTag` | *?string* | :heavy_minus_sign: | Language tag of the stream | en |
| `languageCode` | *?string* | :heavy_minus_sign: | Language code of the stream | eng |
| `audioChannelLayout` | *?string* | :heavy_minus_sign: | The audio channel layout | stereo |
| `samplingRate` | *?int* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
| `title` | *?string* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
| `canAutoSync` | *?bool* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `streamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
| `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `language` | *?string* | :heavy_minus_sign: | Language of the stream. | English |
| `languageTag` | *?string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
| `languageCode` | *?string* | :heavy_minus_sign: | ISO language code. | eng |
| `headerCompression` | *?bool* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
| `doviblCompatID` | *?int* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
| `doviblPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
| `dovielPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
| `doviLevel` | *?int* | :heavy_minus_sign: | Dolby Vision level. | 6 |
| `doviPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
| `doviProfile` | *?int* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
| `dovirpuPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
| `doviVersion` | *?string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
| `bitDepth` | *?int* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
| `chromaLocation` | *?string* | :heavy_minus_sign: | Chroma sample location. | topleft |
| `chromaSubsampling` | *?string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
| `codedHeight` | *?int* | :heavy_minus_sign: | Coded video height. | 1608 |
| `codedWidth` | *?int* | :heavy_minus_sign: | Coded video width. | 3840 |
| `closedCaptions` | *?bool* | :heavy_minus_sign: | N/A | true |
| `colorPrimaries` | *?string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
| `colorRange` | *?string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
| `colorSpace` | *?string* | :heavy_minus_sign: | Color space. | bt2020nc |
| `colorTrc` | *?string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
| `frameRate` | *?float* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
| `height` | *?int* | :heavy_minus_sign: | Height of the video stream. | 1602 |
| `level` | *?int* | :heavy_minus_sign: | Video level. | 150 |
| `original` | *?bool* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
| `hasScalingMatrix` | *?bool* | :heavy_minus_sign: | N/A | false |
| `profile` | *?string* | :heavy_minus_sign: | Video profile. | main 10 |
| `scanType` | *?string* | :heavy_minus_sign: | N/A | progressive |
| `embeddedInVideo` | *?string* | :heavy_minus_sign: | N/A | progressive |
| `refFrames` | *?int* | :heavy_minus_sign: | Number of reference frames. | 1 |
| `width` | *?int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `selected` | *?bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
| `forced` | *?bool* | :heavy_minus_sign: | N/A | true |
| `channels` | *?int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
| `audioChannelLayout` | *?string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
| `samplingRate` | *?int* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
| `canAutoSync` | *?bool* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
| `hearingImpaired` | *?bool* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
| `dub` | *?bool* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
| `title` | *?string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |

9
docs/Models/Operations/Writer.md
View File

@@ -3,6 +3,9 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *?string* | :heavy_minus_sign: | N/A | James Cameron |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
| `filter` | *string* | :heavy_check_mark: | The filter string used to query this writer. | writer=126522 |
| `tag` | *string* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
| `tagKey` | *?string* | :heavy_minus_sign: | A unique key associated with the writers tag, used for internal identification. | 5d77683d85719b001f3a535e |

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

@@ -23,7 +23,6 @@ API Calls interacting with Plex Media Server Libraries
* [getSearchLibrary](#getsearchlibrary) - Search Library
* [getFileHash](#getfilehash) - Get Hash Value
* [getMetadataChildren](#getmetadatachildren) - Get Items Children
* [getOnDeck](#getondeck) - Get On Deck
* [getTopWatchedContent](#gettopwatchedcontent) - Get Top Watched Content
## deleteLibrary
@@ -914,49 +913,6 @@ if ($response->object !== null) {
| Errors\GetMetadataChildrenUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getOnDeck
This endpoint will return the on deck content.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->library->getOnDeck(
);
if ($response->object !== null) {
// handle response
}
```
### Response
**[?Operations\GetOnDeckResponse](../../Models/Operations/GetOnDeckResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ---------------------------- | ---------------------------- | ---------------------------- |
| Errors\GetOnDeckBadRequest | 400 | application/json |
| Errors\GetOnDeckUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getTopWatchedContent
This endpoint will return the top watched content from libraries of a certain type