ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.558.1

This commit is contained in:
speakeasybot
2025-06-10 00:02:39 +00:00
parent 5617d76997
commit 0d8451f5b2
101 changed files with 3273 additions and 3216 deletions

File diff suppressed because one or more lines are too long

View File

@@ -17,13 +17,14 @@ generation:
oAuth2ClientCredentialsEnabled: true oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false oAuth2PasswordEnabled: false
python: python:
version: 0.28.1 version: 0.28.2
additionalDependencies: additionalDependencies:
dev: {} dev: {}
main: {} main: {}
author: LukeHagar author: LukeHagar
authors: authors:
- Speakeasy - Speakeasy
baseErrorName: PlexAPIError
clientServerStatusCodesAsErrors: true clientServerStatusCodesAsErrors: true
defaultErrorName: SDKError defaultErrorName: SDKError
description: Python Client SDK Generated by Speakeasy description: Python Client SDK Generated by Speakeasy

View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.555.3 speakeasyVersion: 1.558.1
sources: sources:
my-source: my-source:
sourceNamespace: my-source sourceNamespace: my-source
@@ -8,19 +8,19 @@ sources:
- latest - latest
plexapi: plexapi:
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:78d07ad78ff60d0e9918696208d8c68a562e170d4e9c431797c02995fb8816d0 sourceRevisionDigest: sha256:dafcc1192236829b85bc924e0462432c0eb7318a17c542f46e3dd05a9a6265df
sourceBlobDigest: sha256:d38dd2a36c1b2fd73409267f7b30c2d5d45d709616141803ea01db424ec68ae4 sourceBlobDigest: sha256:bc072115d585e1695cb8393db901a3d36be1dcd57a69bad2b91a1ba7ac3c9c4b
tags: tags:
- latest - latest
- speakeasy-sdk-regen-1749081688 - speakeasy-sdk-regen-1749513686
targets: targets:
plexpy: plexpy:
source: plexapi source: plexapi
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:78d07ad78ff60d0e9918696208d8c68a562e170d4e9c431797c02995fb8816d0 sourceRevisionDigest: sha256:dafcc1192236829b85bc924e0462432c0eb7318a17c542f46e3dd05a9a6265df
sourceBlobDigest: sha256:d38dd2a36c1b2fd73409267f7b30c2d5d45d709616141803ea01db424ec68ae4 sourceBlobDigest: sha256:bc072115d585e1695cb8393db901a3d36be1dcd57a69bad2b91a1ba7ac3c9c4b
codeSamplesNamespace: code-samples-python-plexpy codeSamplesNamespace: code-samples-python-plexpy
codeSamplesRevisionDigest: sha256:e7e6c374b6975dfe420f76cc8aab7a5fe741a649660093c00e3c9881b19d4179 codeSamplesRevisionDigest: sha256:80b0bb2691ad853eb319483f842ded70eed016c74ac990ae8314ff6bf1a7e116
workflow: workflow:
workflowVersion: 1.0.0 workflowVersion: 1.0.0
speakeasyVersion: latest speakeasyVersion: latest

View File

@@ -1059,3 +1059,13 @@ Based on:
- [python v0.28.1] . - [python v0.28.1] .
### Releases ### Releases
- [PyPI v0.28.1] https://pypi.org/project/plex-api-client/0.28.1 - . - [PyPI v0.28.1] https://pypi.org/project/plex-api-client/0.28.1 - .
## 2025-06-10 00:01:09
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.558.1 (2.623.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v0.28.2] .
### Releases
- [PyPI v0.28.2] https://pypi.org/project/plex-api-client/0.28.2 - .

View File

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

View File

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

View File

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

View File

@@ -16,5 +16,5 @@
| `title1` | *str* | :heavy_check_mark: | The primary title of the media container. | TV Series | | `title1` | *str* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `title2` | *str* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor | | `title2` | *str* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
| `view_group` | *str* | :heavy_check_mark: | Identifier for the view group layout. | secondary | | `view_group` | *str* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
| `view_mode` | *str* | :heavy_check_mark: | Identifier for the view mode. | 131131 | | `view_mode` | *Optional[str]* | :heavy_minus_sign: | Identifier for the view mode. | 131131 |
| `directory` | List[[operations.GetActorsLibraryDirectory](../../models/operations/getactorslibrarydirectory.md)] | :heavy_minus_sign: | An array of actor entries for media items. | | | `directory` | List[[operations.GetActorsLibraryDirectory](../../models/operations/getactorslibrarydirectory.md)] | :heavy_minus_sign: | An array of actor entries for media items. | |

View File

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

View File

@@ -3,6 +3,7 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | United States of America | | `id` | *int* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
| `tag` | *str* | :heavy_check_mark: | The country of origin of this media item | United States of America |

View File

@@ -3,6 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | James Cameron | | `id` | *int* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
| `tag` | *str* | :heavy_check_mark: | The role of Director | Danny Boyle |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |

View File

@@ -10,4 +10,3 @@
| `key` | *str* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 | | `key` | *str* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
| `title` | *str* | :heavy_check_mark: | N/A | Genre | | `title` | *str* | :heavy_check_mark: | N/A | Genre |
| `type` | *str* | :heavy_check_mark: | N/A | filter | | `type` | *str* | :heavy_check_mark: | N/A | filter |
| `advanced` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |

View File

@@ -3,6 +3,7 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | Adventure | | `id` | *int* | :heavy_check_mark: | The unique identifier for the genre.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
| `tag` | *str* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |

View File

@@ -0,0 +1,8 @@
# GetLibraryItemsGuids
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |

View File

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

View File

@@ -3,8 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `alt` | *str* | :heavy_check_mark: | N/A | Episode 1 | | `alt` | *str* | :heavy_check_mark: | N/A | Episode 1 |
| `type` | [operations.GetLibraryItemsLibraryResponse200Type](../../models/operations/getlibraryitemslibraryresponse200type.md) | :heavy_check_mark: | N/A | background | | `type` | [operations.GetLibraryItemsLibraryResponseType](../../models/operations/getlibraryitemslibraryresponsetype.md) | :heavy_check_mark: | N/A | background |
| `url` | *str* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 | | `url` | *str* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |

View File

@@ -1,12 +0,0 @@
# GetLibraryItemsLibraryActiveDirection
The direction of the sort. Can be either `asc` or `desc`.
## Values
| Name | Value |
| ------------ | ------------ |
| `ASCENDING` | asc |
| `DESCENDING` | desc |

View File

@@ -1,12 +0,0 @@
# GetLibraryItemsLibraryDefaultDirection
The direction of the sort. Can be either `asc` or `desc`.
## Values
| Name | Value |
| ------------ | ------------ |
| `ASCENDING` | asc |
| `DESCENDING` | desc |

View File

@@ -1,11 +0,0 @@
# GetLibraryItemsLibraryField
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `key` | *str* | :heavy_check_mark: | N/A | show.title |
| `title` | *str* | :heavy_check_mark: | N/A | Show Title |
| `type` | *str* | :heavy_check_mark: | N/A | string |
| `sub_type` | *Optional[str]* | :heavy_minus_sign: | N/A | rating |

View File

@@ -1,9 +0,0 @@
# GetLibraryItemsLibraryFieldType
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `type` | *str* | :heavy_check_mark: | N/A | tag |
| `operator` | List[[operations.GetLibraryItemsLibraryOperator](../../models/operations/getlibraryitemslibraryoperator.md)] | :heavy_check_mark: | N/A | |

View File

@@ -1,12 +0,0 @@
# GetLibraryItemsLibraryFilter
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `filter_` | *str* | :heavy_check_mark: | N/A | genre |
| `filter_type` | *str* | :heavy_check_mark: | N/A | string |
| `key` | *str* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
| `title` | *str* | :heavy_check_mark: | N/A | Genre |
| `type` | *str* | :heavy_check_mark: | N/A | filter |

View File

@@ -1,9 +0,0 @@
# GetLibraryItemsLibraryOperator
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `key` | *str* | :heavy_check_mark: | N/A | = |
| `title` | *str* | :heavy_check_mark: | N/A | is |

View File

@@ -0,0 +1,20 @@
# GetLibraryItemsLibraryOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Supported Types
### `operations.GetLibraryItemsOptimizedForStreaming1`
```python
value: operations.GetLibraryItemsOptimizedForStreaming1 = /* values here */
```
### `bool`
```python
value: bool = /* values here */
```

View File

@@ -1,11 +0,0 @@
# GetLibraryItemsLibraryResponse200Type
## Values
| Name | Value |
| -------------- | -------------- |
| `COVER_POSTER` | coverPoster |
| `BACKGROUND` | background |
| `SNAPSHOT` | snapshot |
| `CLEAR_LOGO` | clearLogo |

View File

@@ -1,14 +1,11 @@
# GetLibraryItemsLibraryResponseType # GetLibraryItemsLibraryResponseType
## Fields ## Values
| Field | Type | Required | Description | Example | | Name | Value |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | | -------------- | -------------- |
| `key` | *str* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 | | `COVER_POSTER` | coverPoster |
| `type` | *str* | :heavy_check_mark: | N/A | show | | `BACKGROUND` | background |
| `title` | *str* | :heavy_check_mark: | N/A | TV Shows | | `SNAPSHOT` | snapshot |
| `active` | *bool* | :heavy_check_mark: | N/A | false | | `CLEAR_LOGO` | clearLogo |
| `filter_` | List[[operations.GetLibraryItemsLibraryFilter](../../models/operations/getlibraryitemslibraryfilter.md)] | :heavy_minus_sign: | N/A | |
| `sort` | List[[operations.GetLibraryItemsLibrarySort](../../models/operations/getlibraryitemslibrarysort.md)] | :heavy_minus_sign: | N/A | |
| `field` | List[[operations.GetLibraryItemsLibraryField](../../models/operations/getlibraryitemslibraryfield.md)] | :heavy_minus_sign: | N/A | |

View File

@@ -1,15 +0,0 @@
# GetLibraryItemsLibrarySort
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `default` | *Optional[str]* | :heavy_minus_sign: | N/A | asc |
| `active` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `active_direction` | [Optional[operations.GetLibraryItemsLibraryActiveDirection]](../../models/operations/getlibraryitemslibraryactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `default_direction` | [Optional[operations.GetLibraryItemsLibraryDefaultDirection]](../../models/operations/getlibraryitemslibrarydefaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `desc_key` | *Optional[str]* | :heavy_minus_sign: | N/A | titleSort:desc |
| `first_character_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `key` | *str* | :heavy_check_mark: | N/A | titleSort |
| `title` | *str* | :heavy_check_mark: | N/A | Title |

View File

@@ -1,20 +1,14 @@
# GetLibraryItemsLibraryType # GetLibraryItemsLibraryType
The type of media content in the Plex library. This can represent videos, music, or photos.
## Fields
| Field | Type | Required | Description | Example |
## Values | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `key` | *str* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| Name | Value | | `type` | *str* | :heavy_check_mark: | N/A | show |
| ------------- | ------------- | | `title` | *str* | :heavy_check_mark: | N/A | TV Shows |
| `MOVIE` | movie | | `active` | *bool* | :heavy_check_mark: | N/A | false |
| `TV_SHOW` | show | | `filter_` | List[[operations.GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md)] | :heavy_minus_sign: | N/A | |
| `SEASON` | season | | `sort` | List[[operations.GetLibraryItemsSort](../../models/operations/getlibraryitemssort.md)] | :heavy_minus_sign: | N/A | |
| `EPISODE` | episode | | `field` | List[[operations.GetLibraryItemsField](../../models/operations/getlibraryitemsfield.md)] | :heavy_minus_sign: | N/A | |
| `ARTIST` | artist |
| `ALBUM` | album |
| `TRACK` | track |
| `PHOTO_ALBUM` | photoalbum |
| `PHOTO` | photo |
| `COLLECTION` | collection |

View File

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

View File

@@ -3,23 +3,24 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119534 | | `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 | | `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | N/A | 25025 | | `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `width` | *Optional[int]* | :heavy_minus_sign: | N/A | 3840 | | `width` | *Optional[int]* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `height` | *Optional[int]* | :heavy_minus_sign: | N/A | 2072 | | `height` | *Optional[int]* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | N/A | 1.85 | | `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts | | `audio_channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | N/A | 6 | | `display_offset` | *Optional[int]* | :heavy_minus_sign: | N/A | 50 |
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | eac3 | | `audio_codec` | *Optional[str]* | :heavy_minus_sign: | Audio codec used. | aac |
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | hevc | | `video_codec` | *Optional[str]* | :heavy_minus_sign: | Video codec used. | hevc |
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | N/A | 4k | | `video_resolution` | *Optional[str]* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `container` | *str* | :heavy_check_mark: | N/A | mkv | | `container` | *Optional[str]* | :heavy_minus_sign: | Container format of the media. | mp4 |
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | N/A | 24p | | `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main 10 | | `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
| `optimized_for_streaming` | [Optional[operations.GetLibraryItemsOptimizedForStreaming]](../../models/operations/getlibraryitemsoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 | | `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `optimized_for_streaming` | [Optional[operations.GetLibraryItemsOptimizedForStreaming]](../../models/operations/getlibraryitemsoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `part` | List[[operations.GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md)] | :heavy_check_mark: | N/A | | | `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether the media has 64-bit offsets.<br/>This is relevant for media files that may require larger offsets than what 32-bit integers can provide.<br/> | false |
| `part` | List[[operations.GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md)] | :heavy_minus_sign: | N/A | |

View File

@@ -1,33 +1,28 @@
# GetLibraryItemsMediaContainer # GetLibraryItemsMediaContainer
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `type` | List[[operations.GetLibraryItemsType](../../models/operations/getlibraryitemstype.md)] | :heavy_minus_sign: | N/A | | | `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `field_type` | List[[operations.GetLibraryItemsFieldType](../../models/operations/getlibraryitemsfieldtype.md)] | :heavy_minus_sign: | N/A | | | `total_size` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
| `size` | *int* | :heavy_check_mark: | N/A | 70 | | `offset` | *int* | :heavy_check_mark: | Offset value for pagination. | 0 |
| `total_size` | *int* | :heavy_check_mark: | N/A | 170 | | `content` | *str* | :heavy_check_mark: | The content type or mode. | secondary |
| `offset` | *int* | :heavy_check_mark: | N/A | 0 | | `allow_sync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `content` | *str* | :heavy_check_mark: | N/A | secondary | | `nocache` | *bool* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
| `allow_sync` | *bool* | :heavy_check_mark: | N/A | true | | `art` | *str* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `nocache` | *Optional[bool]* | :heavy_minus_sign: | N/A | true | | `identifier` | *str* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `art` | *str* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg | | `library_section_id` | *Optional[int]* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
| `identifier` | *str* | :heavy_check_mark: | N/A | com.plexapp.plugins.library | | `library_section_title` | *Optional[str]* | :heavy_minus_sign: | The title of the library section. | TV Series |
| `library_section_id` | *int* | :heavy_check_mark: | N/A | 1 | | `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
| `library_section_title` | *str* | :heavy_check_mark: | N/A | Movies | | `media_tag_prefix` | *str* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `library_section_uuid` | *str* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 | | `media_tag_version` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `media_tag_prefix` | *str* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ | | `thumb` | *str* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `media_tag_version` | *int* | :heavy_check_mark: | N/A | 1701731894 | | `title1` | *str* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `thumb` | *str* | :heavy_check_mark: | N/A | /:/resources/movie.png | | `title2` | *str* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
| `title1` | *str* | :heavy_check_mark: | N/A | Movies | | `view_group` | *str* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
| `title2` | *str* | :heavy_check_mark: | N/A | Recently Released | | `view_mode` | *Optional[str]* | :heavy_minus_sign: | Identifier for the view mode. | 131131 |
| `view_group` | *str* | :heavy_check_mark: | N/A | movie | | `mixed_parents` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the media container has mixed parents. | true |
| `view_mode` | *Optional[int]* | :heavy_minus_sign: | N/A | 65592 | | `metadata` | List[[operations.GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md)] | :heavy_check_mark: | An array of metadata items. | |
| `mixed_parents` | *Optional[bool]* | :heavy_minus_sign: | N/A | true | | `meta` | [Optional[operations.GetLibraryItemsMeta]](../../models/operations/getlibraryitemsmeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
| `metadata` | List[[operations.GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md)] | :heavy_minus_sign: | N/A | |
| `meta` | [Optional[operations.GetLibraryItemsMeta]](../../models/operations/getlibraryitemsmeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |

View File

@@ -6,7 +6,7 @@ The Meta object is only included in the response if the `includeMeta` parameter
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `type` | List[[operations.GetLibraryItemsLibraryResponseType](../../models/operations/getlibraryitemslibraryresponsetype.md)] | :heavy_minus_sign: | N/A | | `type` | List[[operations.GetLibraryItemsLibraryType](../../models/operations/getlibraryitemslibrarytype.md)] | :heavy_minus_sign: | N/A |
| `field_type` | List[[operations.GetLibraryItemsLibraryFieldType](../../models/operations/getlibraryitemslibraryfieldtype.md)] | :heavy_minus_sign: | N/A | | `field_type` | List[[operations.GetLibraryItemsFieldType](../../models/operations/getlibraryitemsfieldtype.md)] | :heavy_minus_sign: | N/A |

View File

@@ -1,83 +1,88 @@
# GetLibraryItemsMetadata # GetLibraryItemsMetadata
Unknown
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rating_key` | *str* | :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 | | `rating_key` | *str* | :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 |
| `key` | *str* | :heavy_check_mark: | N/A | /library/metadata/58683 | | `key` | *str* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
| `guid` | *str* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 | | `guid` | *str* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
| `studio` | *Optional[str]* | :heavy_minus_sign: | N/A | 20th Century Studios | | `slug` | *str* | :heavy_check_mark: | A URLfriendly version of the media title. | 4-for-texas |
| `skip_children` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `studio` | *Optional[str]* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | | `type` | [operations.GetLibraryItemsType](../../models/operations/getlibraryitemstype.md) | :heavy_check_mark: | N/A | movie |
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Movies | | `title` | *str* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
| `library_section_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/1 | | `banner` | *str* | :heavy_check_mark: | The banner image URL for the media item. | /library/metadata/58683/banner/1703239236 |
| `type` | [operations.GetLibraryItemsLibraryType](../../models/operations/getlibraryitemslibrarytype.md) | :heavy_check_mark: | The type of media content in the Plex library. This can represent videos, music, or photos.<br/> | movie | | `title_sort` | *str* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
| `title` | *str* | :heavy_check_mark: | N/A | Avatar: The Way of Water | | `content_rating` | *Optional[str]* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
| `slug` | *Optional[str]* | :heavy_minus_sign: | N/A | 4-for-texas | | `summary` | *str* | :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/> |
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | N/A | PG-13 | | `rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
| `summary` | *str* | :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. | | `audience_rating` | *float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `rating` | *Optional[float]* | :heavy_minus_sign: | N/A | 7.6 | | `year` | *Optional[int]* | :heavy_minus_sign: | The release year of the media item. | 2022 |
| `audience_rating` | *Optional[float]* | :heavy_minus_sign: | N/A | 9.2 | | `tagline` | *str* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
| `year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 | | `thumb` | *str* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
| `season_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 | | `art` | *str* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
| `tagline` | *Optional[str]* | :heavy_minus_sign: | N/A | Return to Pandora. | | `theme` | *str* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
| `flatten_seasons` | [Optional[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 | | `index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
| `episode_sort` | [Optional[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 | | `leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `enable_credits_marker_generation` | [Optional[operations.EnableCreditsMarkerGeneration]](../../models/operations/enablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 | | `viewed_leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
| `show_ordering` | [Optional[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 | | `child_count` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 | | `season_count` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
| `art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 | | `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
| `banner` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 | | `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 | | `added_at` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC | | `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `added_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 | | `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 | | `chapter_source` | *Optional[str]* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright | | `primary_extra_key` | *Optional[str]* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
| `chapter_source` | *Optional[str]* | :heavy_minus_sign: | N/A | media | | `original_title` | *Optional[str]* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
| `primary_extra_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58684 | | `parent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
| `rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe | | `grandparent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
| `grandparent_rating_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 66 | | `parent_guid` | *Optional[str]* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparent_guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 | | `grandparent_guid` | *Optional[str]* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66 | | `grandparent_slug` | *Optional[str]* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
| `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Caprica | | `grandparent_key` | *Optional[str]* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
| `grandparent_thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 | | `parent_key` | *Optional[str]* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
| `parent_slug` | *Optional[str]* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 | | `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
| `grandparent_slug` | *Optional[str]* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 | | `grandparent_thumb` | *Optional[str]* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
| `grandparent_art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 | | `grandparent_theme` | *Optional[str]* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
| `grandparent_theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 | | `grandparent_art` | *Optional[str]* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
| `media` | List[[operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md)] | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | | | `parent_title` | *Optional[str]* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
| `genre` | List[[operations.GetLibraryItemsGenre](../../models/operations/getlibraryitemsgenre.md)] | :heavy_minus_sign: | N/A | | | `parent_index` | *Optional[int]* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
| `country` | List[[operations.GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md)] | :heavy_minus_sign: | N/A | | | `parent_thumb` | *Optional[str]* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
| `director` | List[[operations.GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md)] | :heavy_minus_sign: | N/A | | | `rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
| `writer` | List[[operations.GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md)] | :heavy_minus_sign: | N/A | | | `view_count` | *Optional[int]* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
| `collection` | List[[operations.GetLibraryItemsCollection](../../models/operations/getlibraryitemscollection.md)] | :heavy_minus_sign: | N/A | | | `view_offset` | *Optional[int]* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
| `role` | List[[operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)] | :heavy_minus_sign: | N/A | | | `skip_count` | *Optional[int]* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
| `location` | List[[operations.GetLibraryItemsLocation](../../models/operations/getlibraryitemslocation.md)] | :heavy_minus_sign: | N/A | | | `subtype` | *Optional[str]* | :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 |
| `media_guid` | List[[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/> | | | `last_rated_at` | *Optional[int]* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
| `ultra_blur_colors` | [Optional[operations.GetLibraryItemsUltraBlurColors]](../../models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | | | `created_at_accuracy` | *Optional[str]* | :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 |
| `meta_data_rating` | List[[operations.MetaDataRating](../../models/operations/metadatarating.md)] | :heavy_minus_sign: | N/A | | | `created_at_tz_offset` | *Optional[str]* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
| `image` | List[[operations.GetLibraryItemsImage](../../models/operations/getlibraryitemsimage.md)] | :heavy_minus_sign: | N/A | | | `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
| `title_sort` | *Optional[str]* | :heavy_minus_sign: | N/A | Whale | | `user_rating` | *Optional[float]* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
| `view_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | | `image` | List[[operations.GetLibraryItemsImage](../../models/operations/getlibraryitemsimage.md)] | :heavy_minus_sign: | N/A | |
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1682752242 | | `ultra_blur_colors` | [Optional[operations.GetLibraryItemsUltraBlurColors]](../../models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `original_title` | *Optional[str]* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 | | `guids` | List[[operations.GetLibraryItemsGuids](../../models/operations/getlibraryitemsguids.md)] | :heavy_minus_sign: | N/A | |
| `view_offset` | *Optional[int]* | :heavy_minus_sign: | N/A | 5222500 | | `library_section_id` | *Optional[int]* | :heavy_minus_sign: | The identifier for the library section. | 1 |
| `skip_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | | `library_section_title` | *Optional[str]* | :heavy_minus_sign: | The title of the library section. | Movies |
| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | | `library_section_key` | *Optional[str]* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
| `theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 | | `show_ordering` | [Optional[operations.ShowOrdering]](../../models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>Options:<br/> - None = Library default<br/> - tmdbAiring = The Movie Database (Aired)<br/> - aired = TheTVDB (Aired)<br/> - dvd = TheTVDB (DVD)<br/> - absolute = TheTVDB (Absolute)<br/> | absolute |
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 14 | | `flatten_seasons` | [Optional[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).<br/> | 1 |
| `viewed_leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 0 | | `skip_children` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether child items should be skipped. | false |
| `child_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | | `media` | List[[operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md)] | :heavy_minus_sign: | N/A | |
| `has_premium_extras` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 | | `genre` | List[[operations.GetLibraryItemsGenre](../../models/operations/getlibraryitemsgenre.md)] | :heavy_minus_sign: | N/A | |
| `has_premium_primary_extra` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 | | `country` | List[[operations.GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md)] | :heavy_minus_sign: | N/A | |
| `parent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 | | `director` | List[[operations.GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md)] | :heavy_minus_sign: | N/A | |
| `parent_guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 | | `writer` | List[[operations.GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md)] | :heavy_minus_sign: | N/A | |
| `parent_studio` | *Optional[str]* | :heavy_minus_sign: | N/A | UCP | | `producer` | List[[operations.GetLibraryItemsProducer](../../models/operations/getlibraryitemsproducer.md)] | :heavy_minus_sign: | N/A | |
| `parent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66 | | `collection` | List[[operations.GetLibraryItemsCollection](../../models/operations/getlibraryitemscollection.md)] | :heavy_minus_sign: | N/A | |
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Caprica | | `role` | List[[operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)] | :heavy_minus_sign: | N/A | |
| `parent_index` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | | `ratings` | List[[operations.Ratings](../../models/operations/ratings.md)] | :heavy_minus_sign: | N/A | |
| `parent_year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2010 | | `similar` | List[[operations.GetLibraryItemsSimilar](../../models/operations/getlibraryitemssimilar.md)] | :heavy_minus_sign: | N/A | |
| `parent_thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 | | `location` | List[[operations.GetLibraryItemsLocation](../../models/operations/getlibraryitemslocation.md)] | :heavy_minus_sign: | N/A | |
| `parent_theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 | | `chapter` | List[[operations.Chapter](../../models/operations/chapter.md)] | :heavy_minus_sign: | N/A | |
| `marker` | List[[operations.Marker](../../models/operations/marker.md)] | :heavy_minus_sign: | N/A | |
| `extras` | [Optional[operations.Extras]](../../models/operations/extras.md) | :heavy_minus_sign: | N/A | |

View File

@@ -1,9 +1,19 @@
# GetLibraryItemsOptimizedForStreaming # GetLibraryItemsOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Values
| Name | Value | ## Supported Types
| --------- | --------- |
| `DISABLE` | 0 | ### `operations.OptimizedForStreaming1`
| `ENABLE` | 1 |
```python
value: operations.OptimizedForStreaming1 = /* values here */
```
### `bool`
```python
value: bool = /* values here */
```

View File

@@ -0,0 +1,9 @@
# GetLibraryItemsOptimizedForStreaming1
## Values
| Name | Value |
| ------ | ------ |
| `ZERO` | 0 |
| `ONE` | 1 |

View File

@@ -3,18 +3,20 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | *int* | :heavy_check_mark: | N/A | 119542 | | `accessible` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `key` | *str* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv | | `exists` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 | | `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `file` | *str* | :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 | | `key` | *Optional[str]* | :heavy_minus_sign: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `size` | *int* | :heavy_check_mark: | N/A | 36158371307 | | `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
| `container` | *str* | :heavy_check_mark: | The container format of the media file.<br/> | mkv | | `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts | | `file` | *Optional[str]* | :heavy_minus_sign: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `size` | *Optional[int]* | :heavy_minus_sign: | File size in bytes. | 30649952104 |
| `optimized_for_streaming` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `packet_length` | *Optional[int]* | :heavy_minus_sign: | N/A | 188 |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main 10 | | `container` | *Optional[str]* | :heavy_minus_sign: | Container format of the part. | mkv |
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd | | `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile for the part. | main 10 |
| `has_thumbnail` | [Optional[operations.GetLibraryItemsHasThumbnail]](../../models/operations/getlibraryitemshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 | | `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `stream` | List[[operations.GetLibraryItemsStream](../../models/operations/getlibraryitemsstream.md)] | :heavy_minus_sign: | N/A | | | `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | [Optional[operations.GetLibraryItemsLibraryOptimizedForStreaming]](../../models/operations/getlibraryitemslibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true<br/> | |
| `has_thumbnail` | [Optional[operations.GetLibraryItemsHasThumbnail]](../../models/operations/getlibraryitemshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |

View File

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

View File

@@ -3,11 +3,9 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `id` | *Optional[int]* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 | | `id` | *int* | :heavy_check_mark: | The unique identifier for the role.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 126522 |
| `filter_` | *Optional[str]* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 | | `tag` | *str* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg | | `role` | *Optional[str]* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
| `tag` | *Optional[str]* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith | | `thumb` | *Optional[str]* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
| `tag_key` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
| `role` | *Optional[str]* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |

View File

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

View File

@@ -1,45 +0,0 @@
# GetLibraryItemsStream
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 272796 |
| `stream_type` | *int* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this is the default stream | true |
| `selected` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is selected | true |
| `codec` | *str* | :heavy_check_mark: | Codec used by the stream | h264 |
| `index` | *int* | :heavy_check_mark: | The index of the stream | 0 |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
| `color_primaries` | *Optional[str]* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
| `color_range` | *Optional[str]* | :heavy_minus_sign: | The color range of the video stream | tv |
| `color_space` | *Optional[str]* | :heavy_minus_sign: | The color space of the video stream | bt709 |
| `color_trc` | *Optional[str]* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
| `bit_depth` | *Optional[int]* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
| `chroma_location` | *Optional[str]* | :heavy_minus_sign: | The chroma location of the video stream | left |
| `stream_identifier` | *Optional[str]* | :heavy_minus_sign: | The identifier of the video stream | 2 |
| `chroma_subsampling` | *Optional[str]* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
| `coded_height` | *Optional[int]* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
| `coded_width` | *Optional[int]* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
| `frame_rate` | *Optional[float]* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
| `has_scaling_matrix` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
| `hearing_impaired` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `closed_captions` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `embedded_in_video` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
| `height` | *Optional[int]* | :heavy_minus_sign: | The height of the video stream | 1080 |
| `level` | *Optional[int]* | :heavy_minus_sign: | The level of the video codec | 40 |
| `profile` | *Optional[str]* | :heavy_minus_sign: | The profile of the video codec | main |
| `ref_frames` | *Optional[int]* | :heavy_minus_sign: | Number of reference frames | 4 |
| `scan_type` | *Optional[str]* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
| `width` | *Optional[int]* | :heavy_minus_sign: | The width of the video stream | 1920 |
| `display_title` | *Optional[str]* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
| `extended_display_title` | *Optional[str]* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
| `channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
| `language` | *Optional[str]* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
| `language_tag` | *Optional[str]* | :heavy_minus_sign: | Language tag of the stream | en |
| `language_code` | *Optional[str]* | :heavy_minus_sign: | Language code of the stream | eng |
| `audio_channel_layout` | *Optional[str]* | :heavy_minus_sign: | The audio channel layout | stereo |
| `sampling_rate` | *Optional[int]* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
| `title` | *Optional[str]* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
| `can_auto_sync` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |

View File

@@ -1,15 +1,20 @@
# GetLibraryItemsType # GetLibraryItemsType
The type of media content in the Plex library. This can represent videos, music, or photos.
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ## Values
| `key` | *str* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *str* | :heavy_check_mark: | N/A | filter | | Name | Value |
| `subtype` | *Optional[str]* | :heavy_minus_sign: | N/A | clip | | ------------- | ------------- |
| `title` | *str* | :heavy_check_mark: | N/A | TV Shows | | `MOVIE` | movie |
| `active` | *bool* | :heavy_check_mark: | N/A | false | | `TV_SHOW` | show |
| `filter_` | List[[operations.GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md)] | :heavy_minus_sign: | N/A | | | `SEASON` | season |
| `sort` | List[[operations.GetLibraryItemsSort](../../models/operations/getlibraryitemssort.md)] | :heavy_minus_sign: | N/A | | | `EPISODE` | episode |
| `field` | List[[operations.GetLibraryItemsField](../../models/operations/getlibraryitemsfield.md)] | :heavy_minus_sign: | N/A | | | `ARTIST` | artist |
| `ALBUM` | album |
| `TRACK` | track |
| `PHOTO_ALBUM` | photoalbum |
| `PHOTO` | photo |
| `COLLECTION` | collection |

View File

@@ -3,6 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | James Cameron | | `id` | *int* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
| `tag` | *str* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the writer. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |

View File

@@ -5,10 +5,10 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
## Supported Types ## Supported Types
### `operations.GetLibrarySectionsAllOptimizedForStreaming1` ### `operations.GetLibrarySectionsAllOptimizedForStreamingLibrary1`
```python ```python
value: operations.GetLibrarySectionsAllOptimizedForStreaming1 = /* values here */ value: operations.GetLibrarySectionsAllOptimizedForStreamingLibrary1 = /* values here */
``` ```
### `bool` ### `bool`

View File

@@ -12,8 +12,8 @@
| `art` | *str* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg | | `art` | *str* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `content` | *str* | :heavy_check_mark: | The content type or mode. | secondary | | `content` | *str* | :heavy_check_mark: | The content type or mode. | secondary |
| `identifier` | *str* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library | | `identifier` | *str* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `library_section_id` | *int* | :heavy_check_mark: | The unique identifier for the library section. | 2 | | `library_section_id` | *Optional[int]* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
| `library_section_title` | *str* | :heavy_check_mark: | The title of the library section. | TV Series | | `library_section_title` | *Optional[str]* | :heavy_minus_sign: | The title of the library section. | TV Series |
| `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 | | `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
| `media_tag_prefix` | *str* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ | | `media_tag_prefix` | *str* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `media_tag_version` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 | | `media_tag_version` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |

View File

@@ -31,7 +31,7 @@ Unknown
| `child_count` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 | | `child_count` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
| `season_count` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 | | `season_count` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 | | `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 | | `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
| `added_at` | *int* | :heavy_check_mark: | N/A | 1556281940 | | `added_at` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 | | `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright | | `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |

View File

@@ -5,10 +5,10 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
## Supported Types ## Supported Types
### `operations.OptimizedForStreaming1` ### `operations.GetLibrarySectionsAllOptimizedForStreaming1`
```python ```python
value: operations.OptimizedForStreaming1 = /* values here */ value: operations.GetLibrarySectionsAllOptimizedForStreaming1 = /* values here */
``` ```
### `bool` ### `bool`

View File

@@ -0,0 +1,9 @@
# GetLibrarySectionsAllOptimizedForStreamingLibrary1
## Values
| Name | Value |
| ------ | ------ |
| `ZERO` | 0 |
| `ONE` | 1 |

View File

@@ -3,56 +3,56 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 | | `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `stream_type` | [operations.GetLibrarySectionsAllStreamType](../../models/operations/getlibrarysectionsallstreamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 | | `stream_type` | *Literal[1]* | :heavy_check_mark: | Stream type:<br/> - VIDEO = 1<br/> - AUDIO = 2<br/> - SUBTITLE = 3<br/> | |
| `format_` | *Optional[str]* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt | | `format_` | *Optional[str]* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true | | `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `codec` | *str* | :heavy_check_mark: | Codec used by the stream. | hevc | | `codec` | *str* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `index` | *Optional[int]* | :heavy_minus_sign: | Index of the stream. | 0 | | `index` | *Optional[int]* | :heavy_minus_sign: | Index of the stream. | 0 |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate of the stream. | 24743 | | `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `language` | *Optional[str]* | :heavy_minus_sign: | Language of the stream. | English | | `language` | *Optional[str]* | :heavy_minus_sign: | Language of the stream. | English |
| `language_tag` | *Optional[str]* | :heavy_minus_sign: | Language tag (e.g., en). | en | | `language_tag` | *Optional[str]* | :heavy_minus_sign: | Language tag (e.g., en). | en |
| `language_code` | *Optional[str]* | :heavy_minus_sign: | ISO language code. | eng | | `language_code` | *Optional[str]* | :heavy_minus_sign: | ISO language code. | eng |
| `header_compression` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true | | `header_compression` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
| `dovibl_compat_id` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 | | `dovibl_compat_id` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
| `dovibl_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true | | `dovibl_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
| `doviel_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false | | `doviel_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
| `dovi_level` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision level. | 6 | | `dovi_level` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision level. | 6 |
| `dovi_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true | | `dovi_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
| `dovi_profile` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision profile. | 8 | | `dovi_profile` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
| `dovirpu_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true | | `dovirpu_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
| `dovi_version` | *Optional[str]* | :heavy_minus_sign: | Dolby Vision version. | 1.0 | | `dovi_version` | *Optional[str]* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
| `bit_depth` | *Optional[int]* | :heavy_minus_sign: | Bit depth of the video stream. | 10 | | `bit_depth` | *Optional[int]* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
| `chroma_location` | *Optional[str]* | :heavy_minus_sign: | Chroma sample location. | topleft | | `chroma_location` | *Optional[str]* | :heavy_minus_sign: | Chroma sample location. | topleft |
| `chroma_subsampling` | *Optional[str]* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 | | `chroma_subsampling` | *Optional[str]* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
| `coded_height` | *Optional[int]* | :heavy_minus_sign: | Coded video height. | 1608 | | `coded_height` | *Optional[int]* | :heavy_minus_sign: | Coded video height. | 1608 |
| `coded_width` | *Optional[int]* | :heavy_minus_sign: | Coded video width. | 3840 | | `coded_width` | *Optional[int]* | :heavy_minus_sign: | Coded video width. | 3840 |
| `closed_captions` | *Optional[bool]* | :heavy_minus_sign: | N/A | true | | `closed_captions` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `color_primaries` | *Optional[str]* | :heavy_minus_sign: | Color primaries used. | bt2020 | | `color_primaries` | *Optional[str]* | :heavy_minus_sign: | Color primaries used. | bt2020 |
| `color_range` | *Optional[str]* | :heavy_minus_sign: | Color range (e.g., tv). | tv | | `color_range` | *Optional[str]* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
| `color_space` | *Optional[str]* | :heavy_minus_sign: | Color space. | bt2020nc | | `color_space` | *Optional[str]* | :heavy_minus_sign: | Color space. | bt2020nc |
| `color_trc` | *Optional[str]* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 | | `color_trc` | *Optional[str]* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
| `frame_rate` | *Optional[float]* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 | | `frame_rate` | *Optional[float]* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
| `key` | *Optional[str]* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 | | `key` | *Optional[str]* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
| `height` | *Optional[int]* | :heavy_minus_sign: | Height of the video stream. | 1602 | | `height` | *Optional[int]* | :heavy_minus_sign: | Height of the video stream. | 1602 |
| `level` | *Optional[int]* | :heavy_minus_sign: | Video level. | 150 | | `level` | *Optional[int]* | :heavy_minus_sign: | Video level. | 150 |
| `original` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this is the original stream. | true | | `original` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
| `has_scaling_matrix` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `has_scaling_matrix` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `profile` | *Optional[str]* | :heavy_minus_sign: | Video profile. | main 10 | | `profile` | *Optional[str]* | :heavy_minus_sign: | Video profile. | main 10 |
| `scan_type` | *Optional[str]* | :heavy_minus_sign: | N/A | progressive | | `scan_type` | *Optional[str]* | :heavy_minus_sign: | N/A | progressive |
| `embedded_in_video` | *Optional[str]* | :heavy_minus_sign: | N/A | progressive | | `embedded_in_video` | *Optional[str]* | :heavy_minus_sign: | N/A | progressive |
| `ref_frames` | *Optional[int]* | :heavy_minus_sign: | Number of reference frames. | 1 | | `ref_frames` | *Optional[int]* | :heavy_minus_sign: | Number of reference frames. | 1 |
| `width` | *Optional[int]* | :heavy_minus_sign: | Width of the video stream. | 3840 | | `width` | *Optional[int]* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `display_title` | *str* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) | | `display_title` | *str* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `extended_display_title` | *str* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) | | `extended_display_title` | *str* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `selected` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true | | `selected` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
| `forced` | *Optional[bool]* | :heavy_minus_sign: | N/A | true | | `forced` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 | | `channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
| `audio_channel_layout` | *Optional[str]* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) | | `audio_channel_layout` | *Optional[str]* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
| `sampling_rate` | *Optional[int]* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 | | `sampling_rate` | *Optional[int]* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
| `can_auto_sync` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false | | `can_auto_sync` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
| `hearing_impaired` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true | | `hearing_impaired` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
| `dub` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is a dub. | true | | `dub` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
| `title` | *Optional[str]* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH | | `title` | *Optional[str]* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |

View File

@@ -1,16 +0,0 @@
# GetLibrarySectionsAllStreamType
Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
## Values
| Name | Value |
| ---------- | ---------- |
| `VIDEO` | 1 |
| `AUDIO` | 2 |
| `SUBTITLE` | 3 |

View File

@@ -0,0 +1,11 @@
# GetMediaMetaDataAttributes
Attributes associated with the marker.
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The identifier for the attributes. | 306970 |
| `version` | *Optional[int]* | :heavy_minus_sign: | The version number of the marker attributes. | 4 |

View File

@@ -0,0 +1,15 @@
# GetMediaMetaDataChapter
The thumbnail for the chapter
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `id` | *int* | :heavy_check_mark: | N/A | 4 |
| `filter_` | *str* | :heavy_check_mark: | N/A | thumb=4 |
| `index` | *int* | :heavy_check_mark: | N/A | 1 |
| `start_time_offset` | *int* | :heavy_check_mark: | N/A | 0 |
| `end_time_offset` | *int* | :heavy_check_mark: | N/A | 100100 |
| `thumb` | *str* | :heavy_check_mark: | N/A | /library/media/46883/chapterImages/1 |

View File

@@ -0,0 +1,8 @@
# GetMediaMetaDataExtras
## Fields
| Field | Type | Required | Description | Example |
| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
| `size` | *Optional[int]* | :heavy_minus_sign: | The size of the extras. | 1 |

View File

@@ -3,6 +3,7 @@
Indicates if the part has a thumbnail. Indicates if the part has a thumbnail.
## Values ## Values
| Name | Value | | Name | Value |

View File

@@ -3,6 +3,7 @@
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Supported Types ## Supported Types
### `operations.GetMediaMetaDataOptimizedForStreamingLibrary1` ### `operations.GetMediaMetaDataOptimizedForStreamingLibrary1`

View File

@@ -0,0 +1,15 @@
# GetMediaMetaDataMarker
The final status of the marker
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 306970 |
| `type` | *str* | :heavy_check_mark: | N/A | credits |
| `start_time_offset` | *int* | :heavy_check_mark: | N/A | 4176050 |
| `end_time_offset` | *int* | :heavy_check_mark: | N/A | 4393389 |
| `final` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `attributes` | [Optional[operations.GetMediaMetaDataAttributes]](../../models/operations/getmediametadataattributes.md) | :heavy_minus_sign: | Attributes associated with the marker. | |

View File

@@ -3,24 +3,24 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 | | `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 | | `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 | | `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `width` | *Optional[int]* | :heavy_minus_sign: | Video width in pixels. | 3840 | | `width` | *Optional[int]* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `height` | *Optional[int]* | :heavy_minus_sign: | Video height in pixels. | 1602 | | `height` | *Optional[int]* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 | | `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels. | 6 | | `audio_channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `display_offset` | *Optional[int]* | :heavy_minus_sign: | N/A | 50 | | `display_offset` | *Optional[int]* | :heavy_minus_sign: | N/A | 50 |
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | Audio codec used. | eac3 | | `audio_codec` | *Optional[str]* | :heavy_minus_sign: | Audio codec used. | aac |
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | Video codec used. | hevc | | `video_codec` | *Optional[str]* | :heavy_minus_sign: | Video codec used. | hevc |
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k | | `video_resolution` | *Optional[str]* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `container` | *Optional[str]* | :heavy_minus_sign: | File container type. | mkv | | `container` | *Optional[str]* | :heavy_minus_sign: | Container format of the media. | mp4 |
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p | | `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 | | `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false | | `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts | | `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `optimized_for_streaming` | [Optional[operations.GetMediaMetaDataOptimizedForStreaming]](../../models/operations/getmediametadataoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | | | `optimized_for_streaming` | [Optional[operations.GetMediaMetaDataOptimizedForStreaming]](../../models/operations/getmediametadataoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether the media has 64-bit offsets.<br/>This is relevant for media files that may require larger offsets than what 32-bit integers can provide.<br/> | false |
| `part` | List[[operations.GetMediaMetaDataPart](../../models/operations/getmediametadatapart.md)] | :heavy_minus_sign: | An array of parts for this media item. | | | `part` | List[[operations.GetMediaMetaDataPart](../../models/operations/getmediametadatapart.md)] | :heavy_minus_sign: | N/A | |

View File

@@ -8,8 +8,8 @@
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 | | `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `allow_sync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false | | `allow_sync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `identifier` | *str* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library | | `identifier` | *str* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `library_section_id` | *int* | :heavy_check_mark: | The unique identifier for the library section. | 2 | | `library_section_id` | *Optional[int]* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
| `library_section_title` | *str* | :heavy_check_mark: | The title of the library section. | TV Series | | `library_section_title` | *Optional[str]* | :heavy_minus_sign: | The title of the library section. | TV Series |
| `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 | | `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
| `media_tag_prefix` | *str* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ | | `media_tag_prefix` | *str* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `media_tag_version` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 | | `media_tag_version` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |

View File

@@ -31,7 +31,7 @@ Unknown
| `child_count` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 | | `child_count` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
| `season_count` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 | | `season_count` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 | | `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 | | `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
| `added_at` | *int* | :heavy_check_mark: | N/A | 1556281940 | | `added_at` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 | | `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright | | `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
@@ -64,9 +64,9 @@ Unknown
| `user_rating` | *Optional[float]* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 | | `user_rating` | *Optional[float]* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
| `image` | List[[operations.GetMediaMetaDataImage](../../models/operations/getmediametadataimage.md)] | :heavy_minus_sign: | N/A | | | `image` | List[[operations.GetMediaMetaDataImage](../../models/operations/getmediametadataimage.md)] | :heavy_minus_sign: | N/A | |
| `ultra_blur_colors` | [Optional[operations.GetMediaMetaDataUltraBlurColors]](../../models/operations/getmediametadataultrablurcolors.md) | :heavy_minus_sign: | N/A | | | `ultra_blur_colors` | [Optional[operations.GetMediaMetaDataUltraBlurColors]](../../models/operations/getmediametadataultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `library_section_id` | *int* | :heavy_check_mark: | The identifier for the library section. | 1 | | `library_section_id` | *Optional[int]* | :heavy_minus_sign: | The identifier for the library section. | 1 |
| `library_section_title` | *str* | :heavy_check_mark: | The title of the library section. | Movies | | `library_section_title` | *Optional[str]* | :heavy_minus_sign: | The title of the library section. | Movies |
| `library_section_key` | *str* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 | | `library_section_key` | *Optional[str]* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
| `guids` | List[[operations.GetMediaMetaDataGuids](../../models/operations/getmediametadataguids.md)] | :heavy_minus_sign: | N/A | | | `guids` | List[[operations.GetMediaMetaDataGuids](../../models/operations/getmediametadataguids.md)] | :heavy_minus_sign: | N/A | |
| `media` | List[[operations.GetMediaMetaDataMedia](../../models/operations/getmediametadatamedia.md)] | :heavy_minus_sign: | N/A | | | `media` | List[[operations.GetMediaMetaDataMedia](../../models/operations/getmediametadatamedia.md)] | :heavy_minus_sign: | N/A | |
| `genre` | List[[operations.GetMediaMetaDataGenre](../../models/operations/getmediametadatagenre.md)] | :heavy_minus_sign: | N/A | | | `genre` | List[[operations.GetMediaMetaDataGenre](../../models/operations/getmediametadatagenre.md)] | :heavy_minus_sign: | N/A | |
@@ -75,9 +75,9 @@ Unknown
| `writer` | List[[operations.GetMediaMetaDataWriter](../../models/operations/getmediametadatawriter.md)] | :heavy_minus_sign: | N/A | | | `writer` | List[[operations.GetMediaMetaDataWriter](../../models/operations/getmediametadatawriter.md)] | :heavy_minus_sign: | N/A | |
| `producer` | List[[operations.GetMediaMetaDataProducer](../../models/operations/getmediametadataproducer.md)] | :heavy_minus_sign: | N/A | | | `producer` | List[[operations.GetMediaMetaDataProducer](../../models/operations/getmediametadataproducer.md)] | :heavy_minus_sign: | N/A | |
| `role` | List[[operations.GetMediaMetaDataRole](../../models/operations/getmediametadatarole.md)] | :heavy_minus_sign: | N/A | | | `role` | List[[operations.GetMediaMetaDataRole](../../models/operations/getmediametadatarole.md)] | :heavy_minus_sign: | N/A | |
| `ratings` | List[[operations.Ratings](../../models/operations/ratings.md)] | :heavy_minus_sign: | N/A | | | `ratings` | List[[operations.GetMediaMetaDataRatings](../../models/operations/getmediametadataratings.md)] | :heavy_minus_sign: | N/A | |
| `similar` | List[[operations.GetMediaMetaDataSimilar](../../models/operations/getmediametadatasimilar.md)] | :heavy_minus_sign: | N/A | | | `similar` | List[[operations.GetMediaMetaDataSimilar](../../models/operations/getmediametadatasimilar.md)] | :heavy_minus_sign: | N/A | |
| `location` | List[[operations.GetMediaMetaDataLocation](../../models/operations/getmediametadatalocation.md)] | :heavy_minus_sign: | N/A | | | `location` | List[[operations.GetMediaMetaDataLocation](../../models/operations/getmediametadatalocation.md)] | :heavy_minus_sign: | N/A | |
| `chapter` | List[[operations.Chapter](../../models/operations/chapter.md)] | :heavy_minus_sign: | N/A | | | `chapter` | List[[operations.GetMediaMetaDataChapter](../../models/operations/getmediametadatachapter.md)] | :heavy_minus_sign: | N/A | |
| `marker` | List[[operations.Marker](../../models/operations/marker.md)] | :heavy_minus_sign: | N/A | | | `marker` | List[[operations.GetMediaMetaDataMarker](../../models/operations/getmediametadatamarker.md)] | :heavy_minus_sign: | N/A | |
| `extras` | [Optional[operations.Extras]](../../models/operations/extras.md) | :heavy_minus_sign: | N/A | | | `extras` | [Optional[operations.GetMediaMetaDataExtras]](../../models/operations/getmediametadataextras.md) | :heavy_minus_sign: | N/A | |

View File

@@ -8,16 +8,16 @@
| `accessible` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part is accessible. | true | | `accessible` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `exists` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part exists. | true | | `exists` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 | | `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `key` | *str* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv | | `key` | *Optional[str]* | :heavy_minus_sign: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd | | `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
| `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 | | `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `file` | *str* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv | | `file` | *Optional[str]* | :heavy_minus_sign: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 | | `size` | *Optional[int]* | :heavy_minus_sign: | File size in bytes. | 30649952104 |
| `packet_length` | *Optional[int]* | :heavy_minus_sign: | N/A | 188 | | `packet_length` | *Optional[int]* | :heavy_minus_sign: | N/A | 188 |
| `container` | *Optional[str]* | :heavy_minus_sign: | Container format of the part. | mkv | | `container` | *Optional[str]* | :heavy_minus_sign: | Container format of the part. | mkv |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile for the part. | main 10 | | `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile for the part. | main 10 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts | | `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | [Optional[operations.GetMediaMetaDataLibraryOptimizedForStreaming]](../../models/operations/getmediametadatalibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | | | `optimized_for_streaming` | [Optional[operations.GetMediaMetaDataLibraryOptimizedForStreaming]](../../models/operations/getmediametadatalibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true<br/> | |
| `has_thumbnail` | [Optional[operations.GetMediaMetaDataHasThumbnail]](../../models/operations/getmediametadatahasthumbnail.md) | :heavy_minus_sign: | N/A | 1 | | `has_thumbnail` | [Optional[operations.GetMediaMetaDataHasThumbnail]](../../models/operations/getmediametadatahasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | List[[operations.GetMediaMetaDataStream](../../models/operations/getmediametadatastream.md)] | :heavy_minus_sign: | An array of streams for this part. | | | `stream` | List[[operations.GetMediaMetaDataStream](../../models/operations/getmediametadatastream.md)] | :heavy_minus_sign: | N/A | |

View File

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

View File

@@ -3,56 +3,56 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 | | `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `stream_type` | [operations.GetMediaMetaDataStreamType](../../models/operations/getmediametadatastreamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 | | `stream_type` | *Literal[1]* | :heavy_check_mark: | Stream type:<br/> - VIDEO = 1<br/> - AUDIO = 2<br/> - SUBTITLE = 3<br/> | |
| `format_` | *Optional[str]* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt | | `format_` | *Optional[str]* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true | | `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `codec` | *str* | :heavy_check_mark: | Codec used by the stream. | hevc | | `codec` | *Optional[str]* | :heavy_minus_sign: | Codec used by the stream. | hevc |
| `index` | *Optional[int]* | :heavy_minus_sign: | Index of the stream. | 0 | | `index` | *Optional[int]* | :heavy_minus_sign: | Index of the stream. | 0 |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate of the stream. | 24743 | | `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `language` | *Optional[str]* | :heavy_minus_sign: | Language of the stream. | English | | `language` | *Optional[str]* | :heavy_minus_sign: | Language of the stream. | English |
| `language_tag` | *Optional[str]* | :heavy_minus_sign: | Language tag (e.g., en). | en | | `language_tag` | *Optional[str]* | :heavy_minus_sign: | Language tag (e.g., en). | en |
| `language_code` | *Optional[str]* | :heavy_minus_sign: | ISO language code. | eng | | `language_code` | *Optional[str]* | :heavy_minus_sign: | ISO language code. | eng |
| `header_compression` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true | | `header_compression` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
| `dovibl_compat_id` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 | | `dovibl_compat_id` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
| `dovibl_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true | | `dovibl_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
| `doviel_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false | | `doviel_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
| `dovi_level` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision level. | 6 | | `dovi_level` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision level. | 6 |
| `dovi_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true | | `dovi_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
| `dovi_profile` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision profile. | 8 | | `dovi_profile` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
| `dovirpu_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true | | `dovirpu_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
| `dovi_version` | *Optional[str]* | :heavy_minus_sign: | Dolby Vision version. | 1.0 | | `dovi_version` | *Optional[str]* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
| `bit_depth` | *Optional[int]* | :heavy_minus_sign: | Bit depth of the video stream. | 10 | | `bit_depth` | *Optional[int]* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
| `chroma_location` | *Optional[str]* | :heavy_minus_sign: | Chroma sample location. | topleft | | `chroma_location` | *Optional[str]* | :heavy_minus_sign: | Chroma sample location. | topleft |
| `chroma_subsampling` | *Optional[str]* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 | | `chroma_subsampling` | *Optional[str]* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
| `coded_height` | *Optional[int]* | :heavy_minus_sign: | Coded video height. | 1608 | | `coded_height` | *Optional[int]* | :heavy_minus_sign: | Coded video height. | 1608 |
| `coded_width` | *Optional[int]* | :heavy_minus_sign: | Coded video width. | 3840 | | `coded_width` | *Optional[int]* | :heavy_minus_sign: | Coded video width. | 3840 |
| `closed_captions` | *Optional[bool]* | :heavy_minus_sign: | N/A | true | | `closed_captions` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `color_primaries` | *Optional[str]* | :heavy_minus_sign: | Color primaries used. | bt2020 | | `color_primaries` | *Optional[str]* | :heavy_minus_sign: | Color primaries used. | bt2020 |
| `color_range` | *Optional[str]* | :heavy_minus_sign: | Color range (e.g., tv). | tv | | `color_range` | *Optional[str]* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
| `color_space` | *Optional[str]* | :heavy_minus_sign: | Color space. | bt2020nc | | `color_space` | *Optional[str]* | :heavy_minus_sign: | Color space. | bt2020nc |
| `color_trc` | *Optional[str]* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 | | `color_trc` | *Optional[str]* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
| `frame_rate` | *Optional[float]* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 | | `frame_rate` | *Optional[float]* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
| `key` | *Optional[str]* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 | | `key` | *Optional[str]* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
| `height` | *Optional[int]* | :heavy_minus_sign: | Height of the video stream. | 1602 | | `height` | *Optional[int]* | :heavy_minus_sign: | Height of the video stream. | 1602 |
| `level` | *Optional[int]* | :heavy_minus_sign: | Video level. | 150 | | `level` | *Optional[int]* | :heavy_minus_sign: | Video level. | 150 |
| `original` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this is the original stream. | true | | `original` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
| `has_scaling_matrix` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `has_scaling_matrix` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `profile` | *Optional[str]* | :heavy_minus_sign: | Video profile. | main 10 | | `profile` | *Optional[str]* | :heavy_minus_sign: | Video profile. | main 10 |
| `scan_type` | *Optional[str]* | :heavy_minus_sign: | N/A | progressive | | `scan_type` | *Optional[str]* | :heavy_minus_sign: | N/A | progressive |
| `embedded_in_video` | *Optional[str]* | :heavy_minus_sign: | N/A | progressive | | `embedded_in_video` | *Optional[str]* | :heavy_minus_sign: | N/A | progressive |
| `ref_frames` | *Optional[int]* | :heavy_minus_sign: | Number of reference frames. | 1 | | `ref_frames` | *Optional[int]* | :heavy_minus_sign: | Number of reference frames. | 1 |
| `width` | *Optional[int]* | :heavy_minus_sign: | Width of the video stream. | 3840 | | `width` | *Optional[int]* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `display_title` | *str* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) | | `display_title` | *Optional[str]* | :heavy_minus_sign: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `extended_display_title` | *str* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) | | `extended_display_title` | *Optional[str]* | :heavy_minus_sign: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `selected` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true | | `selected` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
| `forced` | *Optional[bool]* | :heavy_minus_sign: | N/A | true | | `forced` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 | | `channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
| `audio_channel_layout` | *Optional[str]* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) | | `audio_channel_layout` | *Optional[str]* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
| `sampling_rate` | *Optional[int]* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 | | `sampling_rate` | *Optional[int]* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
| `can_auto_sync` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false | | `can_auto_sync` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
| `hearing_impaired` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true | | `hearing_impaired` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
| `dub` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is a dub. | true | | `dub` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
| `title` | *Optional[str]* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH | | `title` | *Optional[str]* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |

View File

@@ -1,16 +0,0 @@
# GetMediaMetaDataStreamType
Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
## Values
| Name | Value |
| ---------- | ---------- |
| `VIDEO` | 1 |
| `AUDIO` | 2 |
| `SUBTITLE` | 3 |

View File

@@ -32,11 +32,11 @@ Unknown
| `last_rated_at` | *Optional[int]* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 | | `last_rated_at` | *Optional[int]* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 | | `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 | | `leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `library_section_id` | *int* | :heavy_check_mark: | The identifier for the library section. | 1 | | `library_section_id` | *Optional[int]* | :heavy_minus_sign: | The identifier for the library section. | 1 |
| `library_section_key` | *str* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 | | `library_section_key` | *Optional[str]* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
| `library_section_title` | *str* | :heavy_check_mark: | The title of the library section. | Movies | | `library_section_title` | *Optional[str]* | :heavy_minus_sign: | The title of the library section. | Movies |
| `original_title` | *Optional[str]* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 | | `original_title` | *Optional[str]* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 | | `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
| `parent_guid` | *Optional[str]* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 | | `parent_guid` | *Optional[str]* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `parent_index` | *Optional[int]* | :heavy_minus_sign: | The index position of the parent media item. | 1 | | `parent_index` | *Optional[int]* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
| `parent_key` | *Optional[str]* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 | | `parent_key` | *Optional[str]* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |

View File

@@ -1,8 +0,0 @@
# GetSearchAllLibrariesCollection
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | Working NL Subs |

View File

@@ -3,6 +3,7 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | United States of America | | `id` | *int* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
| `tag` | *str* | :heavy_check_mark: | The country of origin of this media item | United States of America |

View File

@@ -3,6 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | James Cameron | | `id` | *int* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
| `tag` | *str* | :heavy_check_mark: | The role of Director | Danny Boyle |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |

View File

@@ -0,0 +1,20 @@
# GetSearchAllLibrariesDirectory
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `key` | *str* | :heavy_check_mark: | The unique identifier path for the search result item. | /library/sections/3/all?actor=197429 |
| `library_section_id` | *int* | :heavy_check_mark: | The identifier for the library section. | 1 |
| `library_section_key` | *str* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
| `library_section_title` | *str* | :heavy_check_mark: | The title of the library section. | Movies |
| `library_section_type` | *Optional[Literal[1]]* | :heavy_minus_sign: | N/A | |
| `type` | *str* | :heavy_check_mark: | The type of the directory. | tag |
| `id` | *int* | :heavy_check_mark: | N/A | 197429 |
| `filter_` | *Optional[str]* | :heavy_minus_sign: | The filter string used to query this specific item in the library. | actor=197429 |
| `tag` | *str* | :heavy_check_mark: | N/A | Ben Stiller |
| `tag_type` | *Optional[Literal[4]]* | :heavy_minus_sign: | The type of tag associated with this search result (e.g., Director, Actor). | |
| `tag_key` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the tag associated with this search result. | 5d776826999c64001ec2c606 |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The URL to the thumbnail image associated with this search result. | https://metadata-static.plex.tv/5/people/57bd7c7d6c5c9e2881251b30e5603d3d.jpg |
| `count` | *Optional[int]* | :heavy_minus_sign: | The number of items associated with this search result. | 10 |

View File

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

View File

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

View File

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

View File

@@ -3,6 +3,7 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | Adventure | | `id` | *int* | :heavy_check_mark: | The unique identifier for the genre.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
| `tag` | *str* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |

View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesGuids
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |

View File

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

View File

@@ -0,0 +1,20 @@
# GetSearchAllLibrariesLibraryOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Supported Types
### `operations.GetSearchAllLibrariesOptimizedForStreamingLibrary1`
```python
value: operations.GetSearchAllLibrariesOptimizedForStreamingLibrary1 = /* values here */
```
### `bool`
```python
value: bool = /* values here */
```

View File

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

View File

@@ -3,23 +3,24 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119534 | | `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 | | `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | N/A | 25025 | | `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `width` | *Optional[int]* | :heavy_minus_sign: | N/A | 3840 | | `width` | *Optional[int]* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `height` | *Optional[int]* | :heavy_minus_sign: | N/A | 2072 | | `height` | *Optional[int]* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | N/A | 1.85 | | `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts | | `audio_channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | N/A | 6 | | `display_offset` | *Optional[int]* | :heavy_minus_sign: | N/A | 50 |
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | eac3 | | `audio_codec` | *Optional[str]* | :heavy_minus_sign: | Audio codec used. | aac |
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | hevc | | `video_codec` | *Optional[str]* | :heavy_minus_sign: | Video codec used. | hevc |
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | N/A | 4k | | `video_resolution` | *Optional[str]* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `container` | *str* | :heavy_check_mark: | N/A | mkv | | `container` | *Optional[str]* | :heavy_minus_sign: | Container format of the media. | mp4 |
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | N/A | 24p | | `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main 10 | | `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
| `optimized_for_streaming` | [Optional[operations.GetSearchAllLibrariesOptimizedForStreaming]](../../models/operations/getsearchalllibrariesoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 | | `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `optimized_for_streaming` | [Optional[operations.GetSearchAllLibrariesOptimizedForStreaming]](../../models/operations/getsearchalllibrariesoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `part` | List[[operations.GetSearchAllLibrariesPart](../../models/operations/getsearchalllibrariespart.md)] | :heavy_check_mark: | N/A | | | `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether the media has 64-bit offsets.<br/>This is relevant for media files that may require larger offsets than what 32-bit integers can provide.<br/> | false |
| `part` | List[[operations.GetSearchAllLibrariesPart](../../models/operations/getsearchalllibrariespart.md)] | :heavy_minus_sign: | N/A | |

View File

@@ -3,7 +3,14 @@
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `size` | *float* | :heavy_check_mark: | N/A | | `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `search_result` | List[[operations.SearchResult](../../models/operations/searchresult.md)] | :heavy_check_mark: | N/A | | `allow_sync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `identifier` | *str* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | The title of the library section. | TV Series |
| `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
| `media_tag_prefix` | *str* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `media_tag_version` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `search_result` | List[[operations.SearchResult](../../models/operations/searchresult.md)] | :heavy_check_mark: | N/A | |

View File

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

View File

@@ -1,83 +1,82 @@
# GetSearchAllLibrariesMetadata # GetSearchAllLibrariesMetadata
Unknown
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rating_key` | *str* | :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 | | `rating_key` | *str* | :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 |
| `key` | *str* | :heavy_check_mark: | N/A | /library/metadata/58683 | | `key` | *str* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
| `guid` | *str* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 | | `guid` | *str* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
| `studio` | *Optional[str]* | :heavy_minus_sign: | N/A | 20th Century Studios | | `slug` | *str* | :heavy_check_mark: | A URLfriendly version of the media title. | 4-for-texas |
| `skip_children` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `studio` | *Optional[str]* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | | `type` | [operations.GetSearchAllLibrariesType](../../models/operations/getsearchalllibrariestype.md) | :heavy_check_mark: | N/A | movie |
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Movies | | `title` | *str* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
| `library_section_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/1 | | `banner` | *str* | :heavy_check_mark: | The banner image URL for the media item. | /library/metadata/58683/banner/1703239236 |
| `type` | [operations.GetSearchAllLibrariesType](../../models/operations/getsearchalllibrariestype.md) | :heavy_check_mark: | The type of media content in the Plex library. This can represent videos, music, or photos.<br/> | movie | | `title_sort` | *str* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
| `title` | *str* | :heavy_check_mark: | N/A | Avatar: The Way of Water | | `content_rating` | *Optional[str]* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
| `slug` | *Optional[str]* | :heavy_minus_sign: | N/A | 4-for-texas | | `summary` | *str* | :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/> |
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | N/A | PG-13 | | `rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
| `summary` | *str* | :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. | | `audience_rating` | *float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `rating` | *Optional[float]* | :heavy_minus_sign: | N/A | 7.6 | | `year` | *Optional[int]* | :heavy_minus_sign: | The release year of the media item. | 2022 |
| `audience_rating` | *Optional[float]* | :heavy_minus_sign: | N/A | 9.2 | | `tagline` | *str* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
| `year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 | | `thumb` | *str* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
| `season_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 | | `art` | *str* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
| `tagline` | *Optional[str]* | :heavy_minus_sign: | N/A | Return to Pandora. | | `theme` | *str* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
| `flatten_seasons` | [Optional[operations.GetSearchAllLibrariesFlattenSeasons]](../../models/operations/getsearchalllibrariesflattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 | | `index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
| `episode_sort` | [Optional[operations.GetSearchAllLibrariesEpisodeSort]](../../models/operations/getsearchalllibrariesepisodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 | | `leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `enable_credits_marker_generation` | [Optional[operations.GetSearchAllLibrariesEnableCreditsMarkerGeneration]](../../models/operations/getsearchalllibrariesenablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 | | `viewed_leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
| `show_ordering` | [Optional[operations.GetSearchAllLibrariesShowOrdering]](../../models/operations/getsearchalllibrariesshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute | | `child_count` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 | | `season_count` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
| `art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 | | `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
| `banner` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 | | `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 | | `added_at` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC | | `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `added_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 | | `parent_year` | *Optional[int]* | :heavy_minus_sign: | The release year of the parent media item. | 2010 |
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 | | `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright | | `chapter_source` | *Optional[str]* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
| `chapter_source` | *Optional[str]* | :heavy_minus_sign: | N/A | media | | `primary_extra_key` | *Optional[str]* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
| `primary_extra_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58684 | | `original_title` | *Optional[str]* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
| `rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe | | `parent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
| `grandparent_rating_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 66 | | `grandparent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
| `grandparent_guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 | | `parent_guid` | *Optional[str]* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66 | | `grandparent_guid` | *Optional[str]* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Caprica | | `grandparent_slug` | *Optional[str]* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
| `grandparent_thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 | | `grandparent_key` | *Optional[str]* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
| `parent_slug` | *Optional[str]* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 | | `parent_key` | *Optional[str]* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
| `grandparent_slug` | *Optional[str]* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 | | `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
| `grandparent_art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 | | `grandparent_thumb` | *Optional[str]* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
| `grandparent_theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 | | `grandparent_theme` | *Optional[str]* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
| `media` | List[[operations.GetSearchAllLibrariesMedia](../../models/operations/getsearchalllibrariesmedia.md)] | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | | | `grandparent_art` | *Optional[str]* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
| `genre` | List[[operations.GetSearchAllLibrariesGenre](../../models/operations/getsearchalllibrariesgenre.md)] | :heavy_minus_sign: | N/A | | | `parent_title` | *Optional[str]* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
| `country` | List[[operations.GetSearchAllLibrariesCountry](../../models/operations/getsearchalllibrariescountry.md)] | :heavy_minus_sign: | N/A | | | `parent_index` | *Optional[int]* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
| `director` | List[[operations.GetSearchAllLibrariesDirector](../../models/operations/getsearchalllibrariesdirector.md)] | :heavy_minus_sign: | N/A | | | `parent_thumb` | *Optional[str]* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
| `writer` | List[[operations.GetSearchAllLibrariesWriter](../../models/operations/getsearchalllibrarieswriter.md)] | :heavy_minus_sign: | N/A | | | `rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
| `collection` | List[[operations.GetSearchAllLibrariesCollection](../../models/operations/getsearchalllibrariescollection.md)] | :heavy_minus_sign: | N/A | | | `view_count` | *Optional[int]* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
| `role` | List[[operations.GetSearchAllLibrariesRole](../../models/operations/getsearchalllibrariesrole.md)] | :heavy_minus_sign: | N/A | | | `view_offset` | *Optional[int]* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
| `location` | List[[operations.GetSearchAllLibrariesLocation](../../models/operations/getsearchalllibrarieslocation.md)] | :heavy_minus_sign: | N/A | | | `skip_count` | *Optional[int]* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
| `media_guid` | List[[operations.GetSearchAllLibrariesMediaGUID](../../models/operations/getsearchalllibrariesmediaguid.md)] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | | | `subtype` | *Optional[str]* | :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 |
| `ultra_blur_colors` | [Optional[operations.GetSearchAllLibrariesUltraBlurColors]](../../models/operations/getsearchalllibrariesultrablurcolors.md) | :heavy_minus_sign: | N/A | | | `last_rated_at` | *Optional[int]* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
| `meta_data_rating` | List[[operations.GetSearchAllLibrariesMetaDataRating](../../models/operations/getsearchalllibrariesmetadatarating.md)] | :heavy_minus_sign: | N/A | | | `created_at_accuracy` | *Optional[str]* | :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 |
| `image` | List[[operations.GetSearchAllLibrariesImage](../../models/operations/getsearchalllibrariesimage.md)] | :heavy_minus_sign: | N/A | | | `created_at_tz_offset` | *Optional[str]* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
| `title_sort` | *Optional[str]* | :heavy_minus_sign: | N/A | Whale | | `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
| `view_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | | `user_rating` | *Optional[float]* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1682752242 | | `image` | List[[operations.GetSearchAllLibrariesImage](../../models/operations/getsearchalllibrariesimage.md)] | :heavy_minus_sign: | N/A | |
| `original_title` | *Optional[str]* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 | | `ultra_blur_colors` | [Optional[operations.GetSearchAllLibrariesUltraBlurColors]](../../models/operations/getsearchalllibrariesultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `view_offset` | *Optional[int]* | :heavy_minus_sign: | N/A | 5222500 | | `guids` | List[[operations.GetSearchAllLibrariesGuids](../../models/operations/getsearchalllibrariesguids.md)] | :heavy_minus_sign: | N/A | |
| `skip_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | | `library_section_id` | *Optional[int]* | :heavy_minus_sign: | The identifier for the library section. | 1 |
| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | | `library_section_title` | *Optional[str]* | :heavy_minus_sign: | The title of the library section. | Movies |
| `theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 | | `library_section_key` | *Optional[str]* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 14 | | `show_ordering` | [Optional[operations.GetSearchAllLibrariesShowOrdering]](../../models/operations/getsearchalllibrariesshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>Options:<br/> - None = Library default<br/> - tmdbAiring = The Movie Database (Aired)<br/> - aired = TheTVDB (Aired)<br/> - dvd = TheTVDB (DVD)<br/> - absolute = TheTVDB (Absolute)<br/> | absolute |
| `viewed_leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 0 | | `flatten_seasons` | [Optional[operations.GetSearchAllLibrariesFlattenSeasons]](../../models/operations/getsearchalllibrariesflattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).<br/> | 1 |
| `child_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | | `skip_children` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether child items should be skipped. | false |
| `has_premium_extras` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 | | `media` | List[[operations.GetSearchAllLibrariesMedia](../../models/operations/getsearchalllibrariesmedia.md)] | :heavy_minus_sign: | N/A | |
| `has_premium_primary_extra` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 | | `genre` | List[[operations.GetSearchAllLibrariesGenre](../../models/operations/getsearchalllibrariesgenre.md)] | :heavy_minus_sign: | N/A | |
| `parent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 | | `country` | List[[operations.GetSearchAllLibrariesCountry](../../models/operations/getsearchalllibrariescountry.md)] | :heavy_minus_sign: | N/A | |
| `parent_guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 | | `director` | List[[operations.GetSearchAllLibrariesDirector](../../models/operations/getsearchalllibrariesdirector.md)] | :heavy_minus_sign: | N/A | |
| `parent_studio` | *Optional[str]* | :heavy_minus_sign: | N/A | UCP | | `writer` | List[[operations.GetSearchAllLibrariesWriter](../../models/operations/getsearchalllibrarieswriter.md)] | :heavy_minus_sign: | N/A | |
| `parent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66 | | `role` | List[[operations.GetSearchAllLibrariesRole](../../models/operations/getsearchalllibrariesrole.md)] | :heavy_minus_sign: | N/A | |
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Caprica | | `location` | List[[operations.GetSearchAllLibrariesLocation](../../models/operations/getsearchalllibrarieslocation.md)] | :heavy_minus_sign: | N/A | |
| `parent_index` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `parent_year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2010 |
| `parent_thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `parent_theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |

View File

@@ -1,10 +0,0 @@
# GetSearchAllLibrariesMetaDataRating
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| `image` | *str* | :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` | *str* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |

View File

@@ -1,9 +1,19 @@
# GetSearchAllLibrariesOptimizedForStreaming # GetSearchAllLibrariesOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Values
| Name | Value | ## Supported Types
| --------- | --------- |
| `DISABLE` | 0 | ### `operations.GetSearchAllLibrariesOptimizedForStreaming1`
| `ENABLE` | 1 |
```python
value: operations.GetSearchAllLibrariesOptimizedForStreaming1 = /* values here */
```
### `bool`
```python
value: bool = /* values here */
```

View File

@@ -0,0 +1,9 @@
# GetSearchAllLibrariesOptimizedForStreaming1
## Values
| Name | Value |
| ------ | ------ |
| `ZERO` | 0 |
| `ONE` | 1 |

View File

@@ -0,0 +1,9 @@
# GetSearchAllLibrariesOptimizedForStreamingLibrary1
## Values
| Name | Value |
| ------ | ------ |
| `ZERO` | 0 |
| `ONE` | 1 |

View File

@@ -3,18 +3,20 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | *int* | :heavy_check_mark: | N/A | 119542 | | `accessible` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `key` | *str* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv | | `exists` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 | | `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `file` | *str* | :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 | | `key` | *Optional[str]* | :heavy_minus_sign: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `size` | *int* | :heavy_check_mark: | N/A | 36158371307 | | `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
| `container` | *str* | :heavy_check_mark: | The container format of the media file.<br/> | mkv | | `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts | | `file` | *Optional[str]* | :heavy_minus_sign: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `size` | *Optional[int]* | :heavy_minus_sign: | File size in bytes. | 30649952104 |
| `optimized_for_streaming` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `packet_length` | *Optional[int]* | :heavy_minus_sign: | N/A | 188 |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main 10 | | `container` | *Optional[str]* | :heavy_minus_sign: | Container format of the part. | mkv |
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd | | `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile for the part. | main 10 |
| `has_thumbnail` | [Optional[operations.GetSearchAllLibrariesHasThumbnail]](../../models/operations/getsearchalllibrarieshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 | | `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `stream` | List[[operations.GetSearchAllLibrariesStream](../../models/operations/getsearchalllibrariesstream.md)] | :heavy_minus_sign: | N/A | | | `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | [Optional[operations.GetSearchAllLibrariesLibraryOptimizedForStreaming]](../../models/operations/getsearchalllibrarieslibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true<br/> | |
| `has_thumbnail` | [Optional[operations.GetSearchAllLibrariesHasThumbnail]](../../models/operations/getsearchalllibrarieshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |

View File

@@ -3,11 +3,9 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `id` | *Optional[int]* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 | | `id` | *int* | :heavy_check_mark: | The unique identifier for the role.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 126522 |
| `filter_` | *Optional[str]* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 | | `tag` | *str* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg | | `role` | *Optional[str]* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
| `tag` | *Optional[str]* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith | | `thumb` | *Optional[str]* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
| `tag_key` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
| `role` | *Optional[str]* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |

View File

@@ -1,11 +1,12 @@
# GetSearchAllLibrariesShowOrdering # GetSearchAllLibrariesShowOrdering
Setting that indicates the episode ordering for the show. Setting that indicates the episode ordering for the show.
None = Library default, Options:
tmdbAiring = The Movie Database (Aired), - None = Library default
aired = TheTVDB (Aired), - tmdbAiring = The Movie Database (Aired)
dvd = TheTVDB (DVD), - aired = TheTVDB (Aired)
absolute = TheTVDB (Absolute)). - dvd = TheTVDB (DVD)
- absolute = TheTVDB (Absolute)

View File

@@ -1,45 +0,0 @@
# GetSearchAllLibrariesStream
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 272796 |
| `stream_type` | *int* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this is the default stream | true |
| `selected` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is selected | true |
| `codec` | *str* | :heavy_check_mark: | Codec used by the stream | h264 |
| `index` | *int* | :heavy_check_mark: | The index of the stream | 0 |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
| `color_primaries` | *Optional[str]* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
| `color_range` | *Optional[str]* | :heavy_minus_sign: | The color range of the video stream | tv |
| `color_space` | *Optional[str]* | :heavy_minus_sign: | The color space of the video stream | bt709 |
| `color_trc` | *Optional[str]* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
| `bit_depth` | *Optional[int]* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
| `chroma_location` | *Optional[str]* | :heavy_minus_sign: | The chroma location of the video stream | left |
| `stream_identifier` | *Optional[str]* | :heavy_minus_sign: | The identifier of the video stream | 2 |
| `chroma_subsampling` | *Optional[str]* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
| `coded_height` | *Optional[int]* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
| `coded_width` | *Optional[int]* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
| `frame_rate` | *Optional[float]* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
| `has_scaling_matrix` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
| `hearing_impaired` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `closed_captions` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `embedded_in_video` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
| `height` | *Optional[int]* | :heavy_minus_sign: | The height of the video stream | 1080 |
| `level` | *Optional[int]* | :heavy_minus_sign: | The level of the video codec | 40 |
| `profile` | *Optional[str]* | :heavy_minus_sign: | The profile of the video codec | main |
| `ref_frames` | *Optional[int]* | :heavy_minus_sign: | Number of reference frames | 4 |
| `scan_type` | *Optional[str]* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
| `width` | *Optional[int]* | :heavy_minus_sign: | The width of the video stream | 1920 |
| `display_title` | *Optional[str]* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
| `extended_display_title` | *Optional[str]* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
| `channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
| `language` | *Optional[str]* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
| `language_tag` | *Optional[str]* | :heavy_minus_sign: | Language tag of the stream | en |
| `language_code` | *Optional[str]* | :heavy_minus_sign: | Language code of the stream | eng |
| `audio_channel_layout` | *Optional[str]* | :heavy_minus_sign: | The audio channel layout | stereo |
| `sampling_rate` | *Optional[int]* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
| `title` | *Optional[str]* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
| `can_auto_sync` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |

View File

@@ -3,6 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | James Cameron | | `id` | *int* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
| `tag` | *str* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the writer. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |

View File

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

View File

@@ -3,7 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `score` | *float* | :heavy_check_mark: | N/A | | `score` | *float* | :heavy_check_mark: | The score of the search result, typically a float value between 0 and 1. | 0.92 |
| `metadata` | [operations.GetSearchAllLibrariesMetadata](../../models/operations/getsearchalllibrariesmetadata.md) | :heavy_check_mark: | N/A | | `directory` | [Optional[operations.GetSearchAllLibrariesDirectory]](../../models/operations/getsearchalllibrariesdirectory.md) | :heavy_minus_sign: | N/A | |
| `metadata` | [Optional[operations.GetSearchAllLibrariesMetadata]](../../models/operations/getsearchalllibrariesmetadata.md) | :heavy_minus_sign: | N/A | |

View File

@@ -1,11 +1,12 @@
# ShowOrdering # ShowOrdering
Setting that indicates the episode ordering for the show. Setting that indicates the episode ordering for the show.
None = Library default, Options:
tmdbAiring = The Movie Database (Aired), - None = Library default
aired = TheTVDB (Aired), - tmdbAiring = The Movie Database (Aired)
dvd = TheTVDB (DVD), - aired = TheTVDB (Aired)
absolute = TheTVDB (Absolute)). - dvd = TheTVDB (DVD)
- absolute = TheTVDB (Absolute)

View File

@@ -6,7 +6,7 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 | | `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `stream_type` | [operations.StreamType](../../models/operations/streamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 | | `stream_type` | *Literal[1]* | :heavy_check_mark: | Stream type:<br/> - VIDEO = 1<br/> - AUDIO = 2<br/> - SUBTITLE = 3<br/> | |
| `format_` | *Optional[str]* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt | | `format_` | *Optional[str]* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true | | `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `codec` | *str* | :heavy_check_mark: | Codec used by the stream. | hevc | | `codec` | *str* | :heavy_check_mark: | Codec used by the stream. | hevc |

View File

@@ -1,16 +0,0 @@
# StreamType
Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
## Values
| Name | Value |
| ---------- | ---------- |
| `VIDEO` | 1 |
| `AUDIO` | 2 |
| `SUBTITLE` | 3 |

View File

@@ -1,6 +1,6 @@
[project] [project]
name = "plex-api-client" name = "plex-api-client"
version = "0.28.1" version = "0.28.2"
description = "Python Client SDK Generated by Speakeasy" description = "Python Client SDK Generated by Speakeasy"
authors = [{ name = "Speakeasy" },] authors = [{ name = "Speakeasy" },]
readme = "README-PYPI.md" readme = "README-PYPI.md"

View File

@@ -3,10 +3,10 @@
import importlib.metadata import importlib.metadata
__title__: str = "plex-api-client" __title__: str = "plex-api-client"
__version__: str = "0.28.1" __version__: str = "0.28.2"
__openapi_doc_version__: str = "0.0.3" __openapi_doc_version__: str = "0.0.3"
__gen_version__: str = "2.620.2" __gen_version__: str = "2.623.4"
__user_agent__: str = "speakeasy-sdk/python 0.28.1 2.620.2 0.0.3 plex-api-client" __user_agent__: str = "speakeasy-sdk/python 0.28.2 2.623.4 0.0.3 plex-api-client"
try: try:
if __package__ is not None: if __package__ is not None:

View File

@@ -158,8 +158,12 @@ if TYPE_CHECKING:
IncludeDetails, IncludeDetails,
) )
from .get_library_items import ( from .get_library_items import (
EnableCreditsMarkerGeneration, Attributes,
EpisodeSort, AttributesTypedDict,
Chapter,
ChapterTypedDict,
Extras,
ExtrasTypedDict,
FlattenSeasons, FlattenSeasons,
GetLibraryItemsActiveDirection, GetLibraryItemsActiveDirection,
GetLibraryItemsCollection, GetLibraryItemsCollection,
@@ -177,25 +181,16 @@ if TYPE_CHECKING:
GetLibraryItemsFilterTypedDict, GetLibraryItemsFilterTypedDict,
GetLibraryItemsGenre, GetLibraryItemsGenre,
GetLibraryItemsGenreTypedDict, GetLibraryItemsGenreTypedDict,
GetLibraryItemsGuids,
GetLibraryItemsGuidsTypedDict,
GetLibraryItemsHasThumbnail, GetLibraryItemsHasThumbnail,
GetLibraryItemsImage, GetLibraryItemsImage,
GetLibraryItemsImageTypedDict, GetLibraryItemsImageTypedDict,
GetLibraryItemsLibraryActiveDirection, GetLibraryItemsLibraryOptimizedForStreaming,
GetLibraryItemsLibraryDefaultDirection, GetLibraryItemsLibraryOptimizedForStreamingTypedDict,
GetLibraryItemsLibraryField,
GetLibraryItemsLibraryFieldType,
GetLibraryItemsLibraryFieldTypeTypedDict,
GetLibraryItemsLibraryFieldTypedDict,
GetLibraryItemsLibraryFilter,
GetLibraryItemsLibraryFilterTypedDict,
GetLibraryItemsLibraryOperator,
GetLibraryItemsLibraryOperatorTypedDict,
GetLibraryItemsLibraryResponse200Type,
GetLibraryItemsLibraryResponseType, GetLibraryItemsLibraryResponseType,
GetLibraryItemsLibraryResponseTypeTypedDict,
GetLibraryItemsLibrarySort,
GetLibraryItemsLibrarySortTypedDict,
GetLibraryItemsLibraryType, GetLibraryItemsLibraryType,
GetLibraryItemsLibraryTypeTypedDict,
GetLibraryItemsLocation, GetLibraryItemsLocation,
GetLibraryItemsLocationTypedDict, GetLibraryItemsLocationTypedDict,
GetLibraryItemsMedia, GetLibraryItemsMedia,
@@ -209,8 +204,12 @@ if TYPE_CHECKING:
GetLibraryItemsOperator, GetLibraryItemsOperator,
GetLibraryItemsOperatorTypedDict, GetLibraryItemsOperatorTypedDict,
GetLibraryItemsOptimizedForStreaming, GetLibraryItemsOptimizedForStreaming,
GetLibraryItemsOptimizedForStreaming1,
GetLibraryItemsOptimizedForStreamingTypedDict,
GetLibraryItemsPart, GetLibraryItemsPart,
GetLibraryItemsPartTypedDict, GetLibraryItemsPartTypedDict,
GetLibraryItemsProducer,
GetLibraryItemsProducerTypedDict,
GetLibraryItemsQueryParamIncludeMeta, GetLibraryItemsQueryParamIncludeMeta,
GetLibraryItemsQueryParamType, GetLibraryItemsQueryParamType,
GetLibraryItemsRequest, GetLibraryItemsRequest,
@@ -221,21 +220,21 @@ if TYPE_CHECKING:
GetLibraryItemsResponseTypedDict, GetLibraryItemsResponseTypedDict,
GetLibraryItemsRole, GetLibraryItemsRole,
GetLibraryItemsRoleTypedDict, GetLibraryItemsRoleTypedDict,
GetLibraryItemsSimilar,
GetLibraryItemsSimilarTypedDict,
GetLibraryItemsSort, GetLibraryItemsSort,
GetLibraryItemsSortTypedDict, GetLibraryItemsSortTypedDict,
GetLibraryItemsStream,
GetLibraryItemsStreamTypedDict,
GetLibraryItemsType, GetLibraryItemsType,
GetLibraryItemsTypeTypedDict,
GetLibraryItemsUltraBlurColors, GetLibraryItemsUltraBlurColors,
GetLibraryItemsUltraBlurColorsTypedDict, GetLibraryItemsUltraBlurColorsTypedDict,
GetLibraryItemsWriter, GetLibraryItemsWriter,
GetLibraryItemsWriterTypedDict, GetLibraryItemsWriterTypedDict,
IncludeGuids, IncludeGuids,
MediaGUID, Marker,
MediaGUIDTypedDict, MarkerTypedDict,
MetaDataRating, OptimizedForStreaming1,
MetaDataRatingTypedDict, Ratings,
RatingsTypedDict,
ShowOrdering, ShowOrdering,
Tag, Tag,
) )
@@ -277,6 +276,7 @@ if TYPE_CHECKING:
GetLibrarySectionsAllOperatorTypedDict, GetLibrarySectionsAllOperatorTypedDict,
GetLibrarySectionsAllOptimizedForStreaming, GetLibrarySectionsAllOptimizedForStreaming,
GetLibrarySectionsAllOptimizedForStreaming1, GetLibrarySectionsAllOptimizedForStreaming1,
GetLibrarySectionsAllOptimizedForStreamingLibrary1,
GetLibrarySectionsAllOptimizedForStreamingTypedDict, GetLibrarySectionsAllOptimizedForStreamingTypedDict,
GetLibrarySectionsAllPart, GetLibrarySectionsAllPart,
GetLibrarySectionsAllPartTypedDict, GetLibrarySectionsAllPartTypedDict,
@@ -293,7 +293,6 @@ if TYPE_CHECKING:
GetLibrarySectionsAllSort, GetLibrarySectionsAllSort,
GetLibrarySectionsAllSortTypedDict, GetLibrarySectionsAllSortTypedDict,
GetLibrarySectionsAllStream, GetLibrarySectionsAllStream,
GetLibrarySectionsAllStreamType,
GetLibrarySectionsAllStreamTypedDict, GetLibrarySectionsAllStreamTypedDict,
GetLibrarySectionsAllType, GetLibrarySectionsAllType,
GetLibrarySectionsAllTypeTypedDict, GetLibrarySectionsAllTypeTypedDict,
@@ -302,7 +301,6 @@ if TYPE_CHECKING:
GetLibrarySectionsAllWriter, GetLibrarySectionsAllWriter,
GetLibrarySectionsAllWriterTypedDict, GetLibrarySectionsAllWriterTypedDict,
IncludeAdvanced, IncludeAdvanced,
OptimizedForStreaming1,
QueryParamIncludeCollections, QueryParamIncludeCollections,
QueryParamIncludeExternalMedia, QueryParamIncludeExternalMedia,
QueryParamIncludeGuids, QueryParamIncludeGuids,
@@ -320,16 +318,16 @@ if TYPE_CHECKING:
GetMediaArtsResponseTypedDict, GetMediaArtsResponseTypedDict,
) )
from .get_media_meta_data import ( from .get_media_meta_data import (
Attributes, GetMediaMetaDataAttributes,
AttributesTypedDict, GetMediaMetaDataAttributesTypedDict,
Chapter, GetMediaMetaDataChapter,
ChapterTypedDict, GetMediaMetaDataChapterTypedDict,
Extras,
ExtrasTypedDict,
GetMediaMetaDataCountry, GetMediaMetaDataCountry,
GetMediaMetaDataCountryTypedDict, GetMediaMetaDataCountryTypedDict,
GetMediaMetaDataDirector, GetMediaMetaDataDirector,
GetMediaMetaDataDirectorTypedDict, GetMediaMetaDataDirectorTypedDict,
GetMediaMetaDataExtras,
GetMediaMetaDataExtrasTypedDict,
GetMediaMetaDataGenre, GetMediaMetaDataGenre,
GetMediaMetaDataGenreTypedDict, GetMediaMetaDataGenreTypedDict,
GetMediaMetaDataGuids, GetMediaMetaDataGuids,
@@ -342,6 +340,8 @@ if TYPE_CHECKING:
GetMediaMetaDataLibraryType, GetMediaMetaDataLibraryType,
GetMediaMetaDataLocation, GetMediaMetaDataLocation,
GetMediaMetaDataLocationTypedDict, GetMediaMetaDataLocationTypedDict,
GetMediaMetaDataMarker,
GetMediaMetaDataMarkerTypedDict,
GetMediaMetaDataMedia, GetMediaMetaDataMedia,
GetMediaMetaDataMediaContainer, GetMediaMetaDataMediaContainer,
GetMediaMetaDataMediaContainerTypedDict, GetMediaMetaDataMediaContainerTypedDict,
@@ -356,6 +356,8 @@ if TYPE_CHECKING:
GetMediaMetaDataPartTypedDict, GetMediaMetaDataPartTypedDict,
GetMediaMetaDataProducer, GetMediaMetaDataProducer,
GetMediaMetaDataProducerTypedDict, GetMediaMetaDataProducerTypedDict,
GetMediaMetaDataRatings,
GetMediaMetaDataRatingsTypedDict,
GetMediaMetaDataRequest, GetMediaMetaDataRequest,
GetMediaMetaDataRequestTypedDict, GetMediaMetaDataRequestTypedDict,
GetMediaMetaDataResponse, GetMediaMetaDataResponse,
@@ -367,17 +369,12 @@ if TYPE_CHECKING:
GetMediaMetaDataSimilar, GetMediaMetaDataSimilar,
GetMediaMetaDataSimilarTypedDict, GetMediaMetaDataSimilarTypedDict,
GetMediaMetaDataStream, GetMediaMetaDataStream,
GetMediaMetaDataStreamType,
GetMediaMetaDataStreamTypedDict, GetMediaMetaDataStreamTypedDict,
GetMediaMetaDataType, GetMediaMetaDataType,
GetMediaMetaDataUltraBlurColors, GetMediaMetaDataUltraBlurColors,
GetMediaMetaDataUltraBlurColorsTypedDict, GetMediaMetaDataUltraBlurColorsTypedDict,
GetMediaMetaDataWriter, GetMediaMetaDataWriter,
GetMediaMetaDataWriterTypedDict, GetMediaMetaDataWriterTypedDict,
Marker,
MarkerTypedDict,
Ratings,
RatingsTypedDict,
) )
from .get_media_posters import ( from .get_media_posters import (
GetMediaPostersMediaContainer, GetMediaPostersMediaContainer,
@@ -475,7 +472,6 @@ if TYPE_CHECKING:
Similar, Similar,
SimilarTypedDict, SimilarTypedDict,
Stream, Stream,
StreamType,
StreamTypedDict, StreamTypedDict,
Type, Type,
UltraBlurColors, UltraBlurColors,
@@ -533,34 +529,35 @@ if TYPE_CHECKING:
GetRefreshLibraryMetadataResponseTypedDict, GetRefreshLibraryMetadataResponseTypedDict,
) )
from .get_search_all_libraries import ( from .get_search_all_libraries import (
GetSearchAllLibrariesCollection,
GetSearchAllLibrariesCollectionTypedDict,
GetSearchAllLibrariesCountry, GetSearchAllLibrariesCountry,
GetSearchAllLibrariesCountryTypedDict, GetSearchAllLibrariesCountryTypedDict,
GetSearchAllLibrariesDirector, GetSearchAllLibrariesDirector,
GetSearchAllLibrariesDirectorTypedDict, GetSearchAllLibrariesDirectorTypedDict,
GetSearchAllLibrariesEnableCreditsMarkerGeneration, GetSearchAllLibrariesDirectory,
GetSearchAllLibrariesEpisodeSort, GetSearchAllLibrariesDirectoryTypedDict,
GetSearchAllLibrariesFlattenSeasons, GetSearchAllLibrariesFlattenSeasons,
GetSearchAllLibrariesGenre, GetSearchAllLibrariesGenre,
GetSearchAllLibrariesGenreTypedDict, GetSearchAllLibrariesGenreTypedDict,
GetSearchAllLibrariesGuids,
GetSearchAllLibrariesGuidsTypedDict,
GetSearchAllLibrariesHasThumbnail, GetSearchAllLibrariesHasThumbnail,
GetSearchAllLibrariesImage, GetSearchAllLibrariesImage,
GetSearchAllLibrariesImageTypedDict, GetSearchAllLibrariesImageTypedDict,
GetSearchAllLibrariesLibraryOptimizedForStreaming,
GetSearchAllLibrariesLibraryOptimizedForStreamingTypedDict,
GetSearchAllLibrariesLibraryType, GetSearchAllLibrariesLibraryType,
GetSearchAllLibrariesLocation, GetSearchAllLibrariesLocation,
GetSearchAllLibrariesLocationTypedDict, GetSearchAllLibrariesLocationTypedDict,
GetSearchAllLibrariesMedia, GetSearchAllLibrariesMedia,
GetSearchAllLibrariesMediaContainer, GetSearchAllLibrariesMediaContainer,
GetSearchAllLibrariesMediaContainerTypedDict, GetSearchAllLibrariesMediaContainerTypedDict,
GetSearchAllLibrariesMediaGUID,
GetSearchAllLibrariesMediaGUIDTypedDict,
GetSearchAllLibrariesMediaTypedDict, GetSearchAllLibrariesMediaTypedDict,
GetSearchAllLibrariesMetaDataRating,
GetSearchAllLibrariesMetaDataRatingTypedDict,
GetSearchAllLibrariesMetadata, GetSearchAllLibrariesMetadata,
GetSearchAllLibrariesMetadataTypedDict, GetSearchAllLibrariesMetadataTypedDict,
GetSearchAllLibrariesOptimizedForStreaming, GetSearchAllLibrariesOptimizedForStreaming,
GetSearchAllLibrariesOptimizedForStreaming1,
GetSearchAllLibrariesOptimizedForStreamingLibrary1,
GetSearchAllLibrariesOptimizedForStreamingTypedDict,
GetSearchAllLibrariesPart, GetSearchAllLibrariesPart,
GetSearchAllLibrariesPartTypedDict, GetSearchAllLibrariesPartTypedDict,
GetSearchAllLibrariesQueryParamIncludeCollections, GetSearchAllLibrariesQueryParamIncludeCollections,
@@ -574,8 +571,6 @@ if TYPE_CHECKING:
GetSearchAllLibrariesRole, GetSearchAllLibrariesRole,
GetSearchAllLibrariesRoleTypedDict, GetSearchAllLibrariesRoleTypedDict,
GetSearchAllLibrariesShowOrdering, GetSearchAllLibrariesShowOrdering,
GetSearchAllLibrariesStream,
GetSearchAllLibrariesStreamTypedDict,
GetSearchAllLibrariesType, GetSearchAllLibrariesType,
GetSearchAllLibrariesUltraBlurColors, GetSearchAllLibrariesUltraBlurColors,
GetSearchAllLibrariesUltraBlurColorsTypedDict, GetSearchAllLibrariesUltraBlurColorsTypedDict,
@@ -1343,10 +1338,8 @@ __all__ = [
"Directory", "Directory",
"DirectoryTypedDict", "DirectoryTypedDict",
"Download", "Download",
"EnableCreditsMarkerGeneration",
"EnablePaperTrailResponse", "EnablePaperTrailResponse",
"EnablePaperTrailResponseTypedDict", "EnablePaperTrailResponseTypedDict",
"EpisodeSort",
"Extras", "Extras",
"ExtrasTypedDict", "ExtrasTypedDict",
"Feature", "Feature",
@@ -1537,25 +1530,16 @@ __all__ = [
"GetLibraryItemsFilterTypedDict", "GetLibraryItemsFilterTypedDict",
"GetLibraryItemsGenre", "GetLibraryItemsGenre",
"GetLibraryItemsGenreTypedDict", "GetLibraryItemsGenreTypedDict",
"GetLibraryItemsGuids",
"GetLibraryItemsGuidsTypedDict",
"GetLibraryItemsHasThumbnail", "GetLibraryItemsHasThumbnail",
"GetLibraryItemsImage", "GetLibraryItemsImage",
"GetLibraryItemsImageTypedDict", "GetLibraryItemsImageTypedDict",
"GetLibraryItemsLibraryActiveDirection", "GetLibraryItemsLibraryOptimizedForStreaming",
"GetLibraryItemsLibraryDefaultDirection", "GetLibraryItemsLibraryOptimizedForStreamingTypedDict",
"GetLibraryItemsLibraryField",
"GetLibraryItemsLibraryFieldType",
"GetLibraryItemsLibraryFieldTypeTypedDict",
"GetLibraryItemsLibraryFieldTypedDict",
"GetLibraryItemsLibraryFilter",
"GetLibraryItemsLibraryFilterTypedDict",
"GetLibraryItemsLibraryOperator",
"GetLibraryItemsLibraryOperatorTypedDict",
"GetLibraryItemsLibraryResponse200Type",
"GetLibraryItemsLibraryResponseType", "GetLibraryItemsLibraryResponseType",
"GetLibraryItemsLibraryResponseTypeTypedDict",
"GetLibraryItemsLibrarySort",
"GetLibraryItemsLibrarySortTypedDict",
"GetLibraryItemsLibraryType", "GetLibraryItemsLibraryType",
"GetLibraryItemsLibraryTypeTypedDict",
"GetLibraryItemsLocation", "GetLibraryItemsLocation",
"GetLibraryItemsLocationTypedDict", "GetLibraryItemsLocationTypedDict",
"GetLibraryItemsMedia", "GetLibraryItemsMedia",
@@ -1569,8 +1553,12 @@ __all__ = [
"GetLibraryItemsOperator", "GetLibraryItemsOperator",
"GetLibraryItemsOperatorTypedDict", "GetLibraryItemsOperatorTypedDict",
"GetLibraryItemsOptimizedForStreaming", "GetLibraryItemsOptimizedForStreaming",
"GetLibraryItemsOptimizedForStreaming1",
"GetLibraryItemsOptimizedForStreamingTypedDict",
"GetLibraryItemsPart", "GetLibraryItemsPart",
"GetLibraryItemsPartTypedDict", "GetLibraryItemsPartTypedDict",
"GetLibraryItemsProducer",
"GetLibraryItemsProducerTypedDict",
"GetLibraryItemsQueryParamIncludeMeta", "GetLibraryItemsQueryParamIncludeMeta",
"GetLibraryItemsQueryParamType", "GetLibraryItemsQueryParamType",
"GetLibraryItemsRequest", "GetLibraryItemsRequest",
@@ -1581,12 +1569,11 @@ __all__ = [
"GetLibraryItemsResponseTypedDict", "GetLibraryItemsResponseTypedDict",
"GetLibraryItemsRole", "GetLibraryItemsRole",
"GetLibraryItemsRoleTypedDict", "GetLibraryItemsRoleTypedDict",
"GetLibraryItemsSimilar",
"GetLibraryItemsSimilarTypedDict",
"GetLibraryItemsSort", "GetLibraryItemsSort",
"GetLibraryItemsSortTypedDict", "GetLibraryItemsSortTypedDict",
"GetLibraryItemsStream",
"GetLibraryItemsStreamTypedDict",
"GetLibraryItemsType", "GetLibraryItemsType",
"GetLibraryItemsTypeTypedDict",
"GetLibraryItemsUltraBlurColors", "GetLibraryItemsUltraBlurColors",
"GetLibraryItemsUltraBlurColorsTypedDict", "GetLibraryItemsUltraBlurColorsTypedDict",
"GetLibraryItemsWriter", "GetLibraryItemsWriter",
@@ -1628,6 +1615,7 @@ __all__ = [
"GetLibrarySectionsAllOperatorTypedDict", "GetLibrarySectionsAllOperatorTypedDict",
"GetLibrarySectionsAllOptimizedForStreaming", "GetLibrarySectionsAllOptimizedForStreaming",
"GetLibrarySectionsAllOptimizedForStreaming1", "GetLibrarySectionsAllOptimizedForStreaming1",
"GetLibrarySectionsAllOptimizedForStreamingLibrary1",
"GetLibrarySectionsAllOptimizedForStreamingTypedDict", "GetLibrarySectionsAllOptimizedForStreamingTypedDict",
"GetLibrarySectionsAllPart", "GetLibrarySectionsAllPart",
"GetLibrarySectionsAllPartTypedDict", "GetLibrarySectionsAllPartTypedDict",
@@ -1644,7 +1632,6 @@ __all__ = [
"GetLibrarySectionsAllSort", "GetLibrarySectionsAllSort",
"GetLibrarySectionsAllSortTypedDict", "GetLibrarySectionsAllSortTypedDict",
"GetLibrarySectionsAllStream", "GetLibrarySectionsAllStream",
"GetLibrarySectionsAllStreamType",
"GetLibrarySectionsAllStreamTypedDict", "GetLibrarySectionsAllStreamTypedDict",
"GetLibrarySectionsAllType", "GetLibrarySectionsAllType",
"GetLibrarySectionsAllTypeTypedDict", "GetLibrarySectionsAllTypeTypedDict",
@@ -1662,10 +1649,16 @@ __all__ = [
"GetMediaArtsResponseBody", "GetMediaArtsResponseBody",
"GetMediaArtsResponseBodyTypedDict", "GetMediaArtsResponseBodyTypedDict",
"GetMediaArtsResponseTypedDict", "GetMediaArtsResponseTypedDict",
"GetMediaMetaDataAttributes",
"GetMediaMetaDataAttributesTypedDict",
"GetMediaMetaDataChapter",
"GetMediaMetaDataChapterTypedDict",
"GetMediaMetaDataCountry", "GetMediaMetaDataCountry",
"GetMediaMetaDataCountryTypedDict", "GetMediaMetaDataCountryTypedDict",
"GetMediaMetaDataDirector", "GetMediaMetaDataDirector",
"GetMediaMetaDataDirectorTypedDict", "GetMediaMetaDataDirectorTypedDict",
"GetMediaMetaDataExtras",
"GetMediaMetaDataExtrasTypedDict",
"GetMediaMetaDataGenre", "GetMediaMetaDataGenre",
"GetMediaMetaDataGenreTypedDict", "GetMediaMetaDataGenreTypedDict",
"GetMediaMetaDataGuids", "GetMediaMetaDataGuids",
@@ -1678,6 +1671,8 @@ __all__ = [
"GetMediaMetaDataLibraryType", "GetMediaMetaDataLibraryType",
"GetMediaMetaDataLocation", "GetMediaMetaDataLocation",
"GetMediaMetaDataLocationTypedDict", "GetMediaMetaDataLocationTypedDict",
"GetMediaMetaDataMarker",
"GetMediaMetaDataMarkerTypedDict",
"GetMediaMetaDataMedia", "GetMediaMetaDataMedia",
"GetMediaMetaDataMediaContainer", "GetMediaMetaDataMediaContainer",
"GetMediaMetaDataMediaContainerTypedDict", "GetMediaMetaDataMediaContainerTypedDict",
@@ -1692,6 +1687,8 @@ __all__ = [
"GetMediaMetaDataPartTypedDict", "GetMediaMetaDataPartTypedDict",
"GetMediaMetaDataProducer", "GetMediaMetaDataProducer",
"GetMediaMetaDataProducerTypedDict", "GetMediaMetaDataProducerTypedDict",
"GetMediaMetaDataRatings",
"GetMediaMetaDataRatingsTypedDict",
"GetMediaMetaDataRequest", "GetMediaMetaDataRequest",
"GetMediaMetaDataRequestTypedDict", "GetMediaMetaDataRequestTypedDict",
"GetMediaMetaDataResponse", "GetMediaMetaDataResponse",
@@ -1703,7 +1700,6 @@ __all__ = [
"GetMediaMetaDataSimilar", "GetMediaMetaDataSimilar",
"GetMediaMetaDataSimilarTypedDict", "GetMediaMetaDataSimilarTypedDict",
"GetMediaMetaDataStream", "GetMediaMetaDataStream",
"GetMediaMetaDataStreamType",
"GetMediaMetaDataStreamTypedDict", "GetMediaMetaDataStreamTypedDict",
"GetMediaMetaDataType", "GetMediaMetaDataType",
"GetMediaMetaDataUltraBlurColors", "GetMediaMetaDataUltraBlurColors",
@@ -1872,34 +1868,35 @@ __all__ = [
"GetResourcesStatisticsResponseBody", "GetResourcesStatisticsResponseBody",
"GetResourcesStatisticsResponseBodyTypedDict", "GetResourcesStatisticsResponseBodyTypedDict",
"GetResourcesStatisticsResponseTypedDict", "GetResourcesStatisticsResponseTypedDict",
"GetSearchAllLibrariesCollection",
"GetSearchAllLibrariesCollectionTypedDict",
"GetSearchAllLibrariesCountry", "GetSearchAllLibrariesCountry",
"GetSearchAllLibrariesCountryTypedDict", "GetSearchAllLibrariesCountryTypedDict",
"GetSearchAllLibrariesDirector", "GetSearchAllLibrariesDirector",
"GetSearchAllLibrariesDirectorTypedDict", "GetSearchAllLibrariesDirectorTypedDict",
"GetSearchAllLibrariesEnableCreditsMarkerGeneration", "GetSearchAllLibrariesDirectory",
"GetSearchAllLibrariesEpisodeSort", "GetSearchAllLibrariesDirectoryTypedDict",
"GetSearchAllLibrariesFlattenSeasons", "GetSearchAllLibrariesFlattenSeasons",
"GetSearchAllLibrariesGenre", "GetSearchAllLibrariesGenre",
"GetSearchAllLibrariesGenreTypedDict", "GetSearchAllLibrariesGenreTypedDict",
"GetSearchAllLibrariesGuids",
"GetSearchAllLibrariesGuidsTypedDict",
"GetSearchAllLibrariesHasThumbnail", "GetSearchAllLibrariesHasThumbnail",
"GetSearchAllLibrariesImage", "GetSearchAllLibrariesImage",
"GetSearchAllLibrariesImageTypedDict", "GetSearchAllLibrariesImageTypedDict",
"GetSearchAllLibrariesLibraryOptimizedForStreaming",
"GetSearchAllLibrariesLibraryOptimizedForStreamingTypedDict",
"GetSearchAllLibrariesLibraryType", "GetSearchAllLibrariesLibraryType",
"GetSearchAllLibrariesLocation", "GetSearchAllLibrariesLocation",
"GetSearchAllLibrariesLocationTypedDict", "GetSearchAllLibrariesLocationTypedDict",
"GetSearchAllLibrariesMedia", "GetSearchAllLibrariesMedia",
"GetSearchAllLibrariesMediaContainer", "GetSearchAllLibrariesMediaContainer",
"GetSearchAllLibrariesMediaContainerTypedDict", "GetSearchAllLibrariesMediaContainerTypedDict",
"GetSearchAllLibrariesMediaGUID",
"GetSearchAllLibrariesMediaGUIDTypedDict",
"GetSearchAllLibrariesMediaTypedDict", "GetSearchAllLibrariesMediaTypedDict",
"GetSearchAllLibrariesMetaDataRating",
"GetSearchAllLibrariesMetaDataRatingTypedDict",
"GetSearchAllLibrariesMetadata", "GetSearchAllLibrariesMetadata",
"GetSearchAllLibrariesMetadataTypedDict", "GetSearchAllLibrariesMetadataTypedDict",
"GetSearchAllLibrariesOptimizedForStreaming", "GetSearchAllLibrariesOptimizedForStreaming",
"GetSearchAllLibrariesOptimizedForStreaming1",
"GetSearchAllLibrariesOptimizedForStreamingLibrary1",
"GetSearchAllLibrariesOptimizedForStreamingTypedDict",
"GetSearchAllLibrariesPart", "GetSearchAllLibrariesPart",
"GetSearchAllLibrariesPartTypedDict", "GetSearchAllLibrariesPartTypedDict",
"GetSearchAllLibrariesQueryParamIncludeCollections", "GetSearchAllLibrariesQueryParamIncludeCollections",
@@ -1913,8 +1910,6 @@ __all__ = [
"GetSearchAllLibrariesRole", "GetSearchAllLibrariesRole",
"GetSearchAllLibrariesRoleTypedDict", "GetSearchAllLibrariesRoleTypedDict",
"GetSearchAllLibrariesShowOrdering", "GetSearchAllLibrariesShowOrdering",
"GetSearchAllLibrariesStream",
"GetSearchAllLibrariesStreamTypedDict",
"GetSearchAllLibrariesType", "GetSearchAllLibrariesType",
"GetSearchAllLibrariesUltraBlurColors", "GetSearchAllLibrariesUltraBlurColors",
"GetSearchAllLibrariesUltraBlurColorsTypedDict", "GetSearchAllLibrariesUltraBlurColorsTypedDict",
@@ -2155,15 +2150,11 @@ __all__ = [
"Media", "Media",
"MediaContainer", "MediaContainer",
"MediaContainerTypedDict", "MediaContainerTypedDict",
"MediaGUID",
"MediaGUIDTypedDict",
"MediaProvider", "MediaProvider",
"MediaProviderTypedDict", "MediaProviderTypedDict",
"MediaReviewsVisibility", "MediaReviewsVisibility",
"MediaTypedDict", "MediaTypedDict",
"Meta", "Meta",
"MetaDataRating",
"MetaDataRatingTypedDict",
"MetaTypedDict", "MetaTypedDict",
"Metadata", "Metadata",
"MetadataTypedDict", "MetadataTypedDict",
@@ -2313,7 +2304,6 @@ __all__ = [
"StopTranscodeSessionResponse", "StopTranscodeSessionResponse",
"StopTranscodeSessionResponseTypedDict", "StopTranscodeSessionResponseTypedDict",
"Stream", "Stream",
"StreamType",
"StreamTypedDict", "StreamTypedDict",
"Subscription", "Subscription",
"SubscriptionTypedDict", "SubscriptionTypedDict",
@@ -2473,8 +2463,12 @@ _dynamic_imports: dict[str, str] = {
"GetLibraryDetailsType": ".get_library_details", "GetLibraryDetailsType": ".get_library_details",
"GetLibraryDetailsTypeTypedDict": ".get_library_details", "GetLibraryDetailsTypeTypedDict": ".get_library_details",
"IncludeDetails": ".get_library_details", "IncludeDetails": ".get_library_details",
"EnableCreditsMarkerGeneration": ".get_library_items", "Attributes": ".get_library_items",
"EpisodeSort": ".get_library_items", "AttributesTypedDict": ".get_library_items",
"Chapter": ".get_library_items",
"ChapterTypedDict": ".get_library_items",
"Extras": ".get_library_items",
"ExtrasTypedDict": ".get_library_items",
"FlattenSeasons": ".get_library_items", "FlattenSeasons": ".get_library_items",
"GetLibraryItemsActiveDirection": ".get_library_items", "GetLibraryItemsActiveDirection": ".get_library_items",
"GetLibraryItemsCollection": ".get_library_items", "GetLibraryItemsCollection": ".get_library_items",
@@ -2492,25 +2486,16 @@ _dynamic_imports: dict[str, str] = {
"GetLibraryItemsFilterTypedDict": ".get_library_items", "GetLibraryItemsFilterTypedDict": ".get_library_items",
"GetLibraryItemsGenre": ".get_library_items", "GetLibraryItemsGenre": ".get_library_items",
"GetLibraryItemsGenreTypedDict": ".get_library_items", "GetLibraryItemsGenreTypedDict": ".get_library_items",
"GetLibraryItemsGuids": ".get_library_items",
"GetLibraryItemsGuidsTypedDict": ".get_library_items",
"GetLibraryItemsHasThumbnail": ".get_library_items", "GetLibraryItemsHasThumbnail": ".get_library_items",
"GetLibraryItemsImage": ".get_library_items", "GetLibraryItemsImage": ".get_library_items",
"GetLibraryItemsImageTypedDict": ".get_library_items", "GetLibraryItemsImageTypedDict": ".get_library_items",
"GetLibraryItemsLibraryActiveDirection": ".get_library_items", "GetLibraryItemsLibraryOptimizedForStreaming": ".get_library_items",
"GetLibraryItemsLibraryDefaultDirection": ".get_library_items", "GetLibraryItemsLibraryOptimizedForStreamingTypedDict": ".get_library_items",
"GetLibraryItemsLibraryField": ".get_library_items",
"GetLibraryItemsLibraryFieldType": ".get_library_items",
"GetLibraryItemsLibraryFieldTypeTypedDict": ".get_library_items",
"GetLibraryItemsLibraryFieldTypedDict": ".get_library_items",
"GetLibraryItemsLibraryFilter": ".get_library_items",
"GetLibraryItemsLibraryFilterTypedDict": ".get_library_items",
"GetLibraryItemsLibraryOperator": ".get_library_items",
"GetLibraryItemsLibraryOperatorTypedDict": ".get_library_items",
"GetLibraryItemsLibraryResponse200Type": ".get_library_items",
"GetLibraryItemsLibraryResponseType": ".get_library_items", "GetLibraryItemsLibraryResponseType": ".get_library_items",
"GetLibraryItemsLibraryResponseTypeTypedDict": ".get_library_items",
"GetLibraryItemsLibrarySort": ".get_library_items",
"GetLibraryItemsLibrarySortTypedDict": ".get_library_items",
"GetLibraryItemsLibraryType": ".get_library_items", "GetLibraryItemsLibraryType": ".get_library_items",
"GetLibraryItemsLibraryTypeTypedDict": ".get_library_items",
"GetLibraryItemsLocation": ".get_library_items", "GetLibraryItemsLocation": ".get_library_items",
"GetLibraryItemsLocationTypedDict": ".get_library_items", "GetLibraryItemsLocationTypedDict": ".get_library_items",
"GetLibraryItemsMedia": ".get_library_items", "GetLibraryItemsMedia": ".get_library_items",
@@ -2524,8 +2509,12 @@ _dynamic_imports: dict[str, str] = {
"GetLibraryItemsOperator": ".get_library_items", "GetLibraryItemsOperator": ".get_library_items",
"GetLibraryItemsOperatorTypedDict": ".get_library_items", "GetLibraryItemsOperatorTypedDict": ".get_library_items",
"GetLibraryItemsOptimizedForStreaming": ".get_library_items", "GetLibraryItemsOptimizedForStreaming": ".get_library_items",
"GetLibraryItemsOptimizedForStreaming1": ".get_library_items",
"GetLibraryItemsOptimizedForStreamingTypedDict": ".get_library_items",
"GetLibraryItemsPart": ".get_library_items", "GetLibraryItemsPart": ".get_library_items",
"GetLibraryItemsPartTypedDict": ".get_library_items", "GetLibraryItemsPartTypedDict": ".get_library_items",
"GetLibraryItemsProducer": ".get_library_items",
"GetLibraryItemsProducerTypedDict": ".get_library_items",
"GetLibraryItemsQueryParamIncludeMeta": ".get_library_items", "GetLibraryItemsQueryParamIncludeMeta": ".get_library_items",
"GetLibraryItemsQueryParamType": ".get_library_items", "GetLibraryItemsQueryParamType": ".get_library_items",
"GetLibraryItemsRequest": ".get_library_items", "GetLibraryItemsRequest": ".get_library_items",
@@ -2536,21 +2525,21 @@ _dynamic_imports: dict[str, str] = {
"GetLibraryItemsResponseTypedDict": ".get_library_items", "GetLibraryItemsResponseTypedDict": ".get_library_items",
"GetLibraryItemsRole": ".get_library_items", "GetLibraryItemsRole": ".get_library_items",
"GetLibraryItemsRoleTypedDict": ".get_library_items", "GetLibraryItemsRoleTypedDict": ".get_library_items",
"GetLibraryItemsSimilar": ".get_library_items",
"GetLibraryItemsSimilarTypedDict": ".get_library_items",
"GetLibraryItemsSort": ".get_library_items", "GetLibraryItemsSort": ".get_library_items",
"GetLibraryItemsSortTypedDict": ".get_library_items", "GetLibraryItemsSortTypedDict": ".get_library_items",
"GetLibraryItemsStream": ".get_library_items",
"GetLibraryItemsStreamTypedDict": ".get_library_items",
"GetLibraryItemsType": ".get_library_items", "GetLibraryItemsType": ".get_library_items",
"GetLibraryItemsTypeTypedDict": ".get_library_items",
"GetLibraryItemsUltraBlurColors": ".get_library_items", "GetLibraryItemsUltraBlurColors": ".get_library_items",
"GetLibraryItemsUltraBlurColorsTypedDict": ".get_library_items", "GetLibraryItemsUltraBlurColorsTypedDict": ".get_library_items",
"GetLibraryItemsWriter": ".get_library_items", "GetLibraryItemsWriter": ".get_library_items",
"GetLibraryItemsWriterTypedDict": ".get_library_items", "GetLibraryItemsWriterTypedDict": ".get_library_items",
"IncludeGuids": ".get_library_items", "IncludeGuids": ".get_library_items",
"MediaGUID": ".get_library_items", "Marker": ".get_library_items",
"MediaGUIDTypedDict": ".get_library_items", "MarkerTypedDict": ".get_library_items",
"MetaDataRating": ".get_library_items", "OptimizedForStreaming1": ".get_library_items",
"MetaDataRatingTypedDict": ".get_library_items", "Ratings": ".get_library_items",
"RatingsTypedDict": ".get_library_items",
"ShowOrdering": ".get_library_items", "ShowOrdering": ".get_library_items",
"Tag": ".get_library_items", "Tag": ".get_library_items",
"GetLibrarySectionsAllActiveDirection": ".get_library_sections_all", "GetLibrarySectionsAllActiveDirection": ".get_library_sections_all",
@@ -2590,6 +2579,7 @@ _dynamic_imports: dict[str, str] = {
"GetLibrarySectionsAllOperatorTypedDict": ".get_library_sections_all", "GetLibrarySectionsAllOperatorTypedDict": ".get_library_sections_all",
"GetLibrarySectionsAllOptimizedForStreaming": ".get_library_sections_all", "GetLibrarySectionsAllOptimizedForStreaming": ".get_library_sections_all",
"GetLibrarySectionsAllOptimizedForStreaming1": ".get_library_sections_all", "GetLibrarySectionsAllOptimizedForStreaming1": ".get_library_sections_all",
"GetLibrarySectionsAllOptimizedForStreamingLibrary1": ".get_library_sections_all",
"GetLibrarySectionsAllOptimizedForStreamingTypedDict": ".get_library_sections_all", "GetLibrarySectionsAllOptimizedForStreamingTypedDict": ".get_library_sections_all",
"GetLibrarySectionsAllPart": ".get_library_sections_all", "GetLibrarySectionsAllPart": ".get_library_sections_all",
"GetLibrarySectionsAllPartTypedDict": ".get_library_sections_all", "GetLibrarySectionsAllPartTypedDict": ".get_library_sections_all",
@@ -2606,7 +2596,6 @@ _dynamic_imports: dict[str, str] = {
"GetLibrarySectionsAllSort": ".get_library_sections_all", "GetLibrarySectionsAllSort": ".get_library_sections_all",
"GetLibrarySectionsAllSortTypedDict": ".get_library_sections_all", "GetLibrarySectionsAllSortTypedDict": ".get_library_sections_all",
"GetLibrarySectionsAllStream": ".get_library_sections_all", "GetLibrarySectionsAllStream": ".get_library_sections_all",
"GetLibrarySectionsAllStreamType": ".get_library_sections_all",
"GetLibrarySectionsAllStreamTypedDict": ".get_library_sections_all", "GetLibrarySectionsAllStreamTypedDict": ".get_library_sections_all",
"GetLibrarySectionsAllType": ".get_library_sections_all", "GetLibrarySectionsAllType": ".get_library_sections_all",
"GetLibrarySectionsAllTypeTypedDict": ".get_library_sections_all", "GetLibrarySectionsAllTypeTypedDict": ".get_library_sections_all",
@@ -2615,7 +2604,6 @@ _dynamic_imports: dict[str, str] = {
"GetLibrarySectionsAllWriter": ".get_library_sections_all", "GetLibrarySectionsAllWriter": ".get_library_sections_all",
"GetLibrarySectionsAllWriterTypedDict": ".get_library_sections_all", "GetLibrarySectionsAllWriterTypedDict": ".get_library_sections_all",
"IncludeAdvanced": ".get_library_sections_all", "IncludeAdvanced": ".get_library_sections_all",
"OptimizedForStreaming1": ".get_library_sections_all",
"QueryParamIncludeCollections": ".get_library_sections_all", "QueryParamIncludeCollections": ".get_library_sections_all",
"QueryParamIncludeExternalMedia": ".get_library_sections_all", "QueryParamIncludeExternalMedia": ".get_library_sections_all",
"QueryParamIncludeGuids": ".get_library_sections_all", "QueryParamIncludeGuids": ".get_library_sections_all",
@@ -2629,16 +2617,16 @@ _dynamic_imports: dict[str, str] = {
"GetMediaArtsResponseBody": ".get_media_arts", "GetMediaArtsResponseBody": ".get_media_arts",
"GetMediaArtsResponseBodyTypedDict": ".get_media_arts", "GetMediaArtsResponseBodyTypedDict": ".get_media_arts",
"GetMediaArtsResponseTypedDict": ".get_media_arts", "GetMediaArtsResponseTypedDict": ".get_media_arts",
"Attributes": ".get_media_meta_data", "GetMediaMetaDataAttributes": ".get_media_meta_data",
"AttributesTypedDict": ".get_media_meta_data", "GetMediaMetaDataAttributesTypedDict": ".get_media_meta_data",
"Chapter": ".get_media_meta_data", "GetMediaMetaDataChapter": ".get_media_meta_data",
"ChapterTypedDict": ".get_media_meta_data", "GetMediaMetaDataChapterTypedDict": ".get_media_meta_data",
"Extras": ".get_media_meta_data",
"ExtrasTypedDict": ".get_media_meta_data",
"GetMediaMetaDataCountry": ".get_media_meta_data", "GetMediaMetaDataCountry": ".get_media_meta_data",
"GetMediaMetaDataCountryTypedDict": ".get_media_meta_data", "GetMediaMetaDataCountryTypedDict": ".get_media_meta_data",
"GetMediaMetaDataDirector": ".get_media_meta_data", "GetMediaMetaDataDirector": ".get_media_meta_data",
"GetMediaMetaDataDirectorTypedDict": ".get_media_meta_data", "GetMediaMetaDataDirectorTypedDict": ".get_media_meta_data",
"GetMediaMetaDataExtras": ".get_media_meta_data",
"GetMediaMetaDataExtrasTypedDict": ".get_media_meta_data",
"GetMediaMetaDataGenre": ".get_media_meta_data", "GetMediaMetaDataGenre": ".get_media_meta_data",
"GetMediaMetaDataGenreTypedDict": ".get_media_meta_data", "GetMediaMetaDataGenreTypedDict": ".get_media_meta_data",
"GetMediaMetaDataGuids": ".get_media_meta_data", "GetMediaMetaDataGuids": ".get_media_meta_data",
@@ -2651,6 +2639,8 @@ _dynamic_imports: dict[str, str] = {
"GetMediaMetaDataLibraryType": ".get_media_meta_data", "GetMediaMetaDataLibraryType": ".get_media_meta_data",
"GetMediaMetaDataLocation": ".get_media_meta_data", "GetMediaMetaDataLocation": ".get_media_meta_data",
"GetMediaMetaDataLocationTypedDict": ".get_media_meta_data", "GetMediaMetaDataLocationTypedDict": ".get_media_meta_data",
"GetMediaMetaDataMarker": ".get_media_meta_data",
"GetMediaMetaDataMarkerTypedDict": ".get_media_meta_data",
"GetMediaMetaDataMedia": ".get_media_meta_data", "GetMediaMetaDataMedia": ".get_media_meta_data",
"GetMediaMetaDataMediaContainer": ".get_media_meta_data", "GetMediaMetaDataMediaContainer": ".get_media_meta_data",
"GetMediaMetaDataMediaContainerTypedDict": ".get_media_meta_data", "GetMediaMetaDataMediaContainerTypedDict": ".get_media_meta_data",
@@ -2665,6 +2655,8 @@ _dynamic_imports: dict[str, str] = {
"GetMediaMetaDataPartTypedDict": ".get_media_meta_data", "GetMediaMetaDataPartTypedDict": ".get_media_meta_data",
"GetMediaMetaDataProducer": ".get_media_meta_data", "GetMediaMetaDataProducer": ".get_media_meta_data",
"GetMediaMetaDataProducerTypedDict": ".get_media_meta_data", "GetMediaMetaDataProducerTypedDict": ".get_media_meta_data",
"GetMediaMetaDataRatings": ".get_media_meta_data",
"GetMediaMetaDataRatingsTypedDict": ".get_media_meta_data",
"GetMediaMetaDataRequest": ".get_media_meta_data", "GetMediaMetaDataRequest": ".get_media_meta_data",
"GetMediaMetaDataRequestTypedDict": ".get_media_meta_data", "GetMediaMetaDataRequestTypedDict": ".get_media_meta_data",
"GetMediaMetaDataResponse": ".get_media_meta_data", "GetMediaMetaDataResponse": ".get_media_meta_data",
@@ -2676,17 +2668,12 @@ _dynamic_imports: dict[str, str] = {
"GetMediaMetaDataSimilar": ".get_media_meta_data", "GetMediaMetaDataSimilar": ".get_media_meta_data",
"GetMediaMetaDataSimilarTypedDict": ".get_media_meta_data", "GetMediaMetaDataSimilarTypedDict": ".get_media_meta_data",
"GetMediaMetaDataStream": ".get_media_meta_data", "GetMediaMetaDataStream": ".get_media_meta_data",
"GetMediaMetaDataStreamType": ".get_media_meta_data",
"GetMediaMetaDataStreamTypedDict": ".get_media_meta_data", "GetMediaMetaDataStreamTypedDict": ".get_media_meta_data",
"GetMediaMetaDataType": ".get_media_meta_data", "GetMediaMetaDataType": ".get_media_meta_data",
"GetMediaMetaDataUltraBlurColors": ".get_media_meta_data", "GetMediaMetaDataUltraBlurColors": ".get_media_meta_data",
"GetMediaMetaDataUltraBlurColorsTypedDict": ".get_media_meta_data", "GetMediaMetaDataUltraBlurColorsTypedDict": ".get_media_meta_data",
"GetMediaMetaDataWriter": ".get_media_meta_data", "GetMediaMetaDataWriter": ".get_media_meta_data",
"GetMediaMetaDataWriterTypedDict": ".get_media_meta_data", "GetMediaMetaDataWriterTypedDict": ".get_media_meta_data",
"Marker": ".get_media_meta_data",
"MarkerTypedDict": ".get_media_meta_data",
"Ratings": ".get_media_meta_data",
"RatingsTypedDict": ".get_media_meta_data",
"GetMediaPostersMediaContainer": ".get_media_posters", "GetMediaPostersMediaContainer": ".get_media_posters",
"GetMediaPostersMediaContainerTypedDict": ".get_media_posters", "GetMediaPostersMediaContainerTypedDict": ".get_media_posters",
"GetMediaPostersMetadata": ".get_media_posters", "GetMediaPostersMetadata": ".get_media_posters",
@@ -2778,7 +2765,6 @@ _dynamic_imports: dict[str, str] = {
"Similar": ".get_recently_added", "Similar": ".get_recently_added",
"SimilarTypedDict": ".get_recently_added", "SimilarTypedDict": ".get_recently_added",
"Stream": ".get_recently_added", "Stream": ".get_recently_added",
"StreamType": ".get_recently_added",
"StreamTypedDict": ".get_recently_added", "StreamTypedDict": ".get_recently_added",
"Type": ".get_recently_added", "Type": ".get_recently_added",
"UltraBlurColors": ".get_recently_added", "UltraBlurColors": ".get_recently_added",
@@ -2830,34 +2816,35 @@ _dynamic_imports: dict[str, str] = {
"GetRefreshLibraryMetadataRequestTypedDict": ".get_refresh_library_metadata", "GetRefreshLibraryMetadataRequestTypedDict": ".get_refresh_library_metadata",
"GetRefreshLibraryMetadataResponse": ".get_refresh_library_metadata", "GetRefreshLibraryMetadataResponse": ".get_refresh_library_metadata",
"GetRefreshLibraryMetadataResponseTypedDict": ".get_refresh_library_metadata", "GetRefreshLibraryMetadataResponseTypedDict": ".get_refresh_library_metadata",
"GetSearchAllLibrariesCollection": ".get_search_all_libraries",
"GetSearchAllLibrariesCollectionTypedDict": ".get_search_all_libraries",
"GetSearchAllLibrariesCountry": ".get_search_all_libraries", "GetSearchAllLibrariesCountry": ".get_search_all_libraries",
"GetSearchAllLibrariesCountryTypedDict": ".get_search_all_libraries", "GetSearchAllLibrariesCountryTypedDict": ".get_search_all_libraries",
"GetSearchAllLibrariesDirector": ".get_search_all_libraries", "GetSearchAllLibrariesDirector": ".get_search_all_libraries",
"GetSearchAllLibrariesDirectorTypedDict": ".get_search_all_libraries", "GetSearchAllLibrariesDirectorTypedDict": ".get_search_all_libraries",
"GetSearchAllLibrariesEnableCreditsMarkerGeneration": ".get_search_all_libraries", "GetSearchAllLibrariesDirectory": ".get_search_all_libraries",
"GetSearchAllLibrariesEpisodeSort": ".get_search_all_libraries", "GetSearchAllLibrariesDirectoryTypedDict": ".get_search_all_libraries",
"GetSearchAllLibrariesFlattenSeasons": ".get_search_all_libraries", "GetSearchAllLibrariesFlattenSeasons": ".get_search_all_libraries",
"GetSearchAllLibrariesGenre": ".get_search_all_libraries", "GetSearchAllLibrariesGenre": ".get_search_all_libraries",
"GetSearchAllLibrariesGenreTypedDict": ".get_search_all_libraries", "GetSearchAllLibrariesGenreTypedDict": ".get_search_all_libraries",
"GetSearchAllLibrariesGuids": ".get_search_all_libraries",
"GetSearchAllLibrariesGuidsTypedDict": ".get_search_all_libraries",
"GetSearchAllLibrariesHasThumbnail": ".get_search_all_libraries", "GetSearchAllLibrariesHasThumbnail": ".get_search_all_libraries",
"GetSearchAllLibrariesImage": ".get_search_all_libraries", "GetSearchAllLibrariesImage": ".get_search_all_libraries",
"GetSearchAllLibrariesImageTypedDict": ".get_search_all_libraries", "GetSearchAllLibrariesImageTypedDict": ".get_search_all_libraries",
"GetSearchAllLibrariesLibraryOptimizedForStreaming": ".get_search_all_libraries",
"GetSearchAllLibrariesLibraryOptimizedForStreamingTypedDict": ".get_search_all_libraries",
"GetSearchAllLibrariesLibraryType": ".get_search_all_libraries", "GetSearchAllLibrariesLibraryType": ".get_search_all_libraries",
"GetSearchAllLibrariesLocation": ".get_search_all_libraries", "GetSearchAllLibrariesLocation": ".get_search_all_libraries",
"GetSearchAllLibrariesLocationTypedDict": ".get_search_all_libraries", "GetSearchAllLibrariesLocationTypedDict": ".get_search_all_libraries",
"GetSearchAllLibrariesMedia": ".get_search_all_libraries", "GetSearchAllLibrariesMedia": ".get_search_all_libraries",
"GetSearchAllLibrariesMediaContainer": ".get_search_all_libraries", "GetSearchAllLibrariesMediaContainer": ".get_search_all_libraries",
"GetSearchAllLibrariesMediaContainerTypedDict": ".get_search_all_libraries", "GetSearchAllLibrariesMediaContainerTypedDict": ".get_search_all_libraries",
"GetSearchAllLibrariesMediaGUID": ".get_search_all_libraries",
"GetSearchAllLibrariesMediaGUIDTypedDict": ".get_search_all_libraries",
"GetSearchAllLibrariesMediaTypedDict": ".get_search_all_libraries", "GetSearchAllLibrariesMediaTypedDict": ".get_search_all_libraries",
"GetSearchAllLibrariesMetaDataRating": ".get_search_all_libraries",
"GetSearchAllLibrariesMetaDataRatingTypedDict": ".get_search_all_libraries",
"GetSearchAllLibrariesMetadata": ".get_search_all_libraries", "GetSearchAllLibrariesMetadata": ".get_search_all_libraries",
"GetSearchAllLibrariesMetadataTypedDict": ".get_search_all_libraries", "GetSearchAllLibrariesMetadataTypedDict": ".get_search_all_libraries",
"GetSearchAllLibrariesOptimizedForStreaming": ".get_search_all_libraries", "GetSearchAllLibrariesOptimizedForStreaming": ".get_search_all_libraries",
"GetSearchAllLibrariesOptimizedForStreaming1": ".get_search_all_libraries",
"GetSearchAllLibrariesOptimizedForStreamingLibrary1": ".get_search_all_libraries",
"GetSearchAllLibrariesOptimizedForStreamingTypedDict": ".get_search_all_libraries",
"GetSearchAllLibrariesPart": ".get_search_all_libraries", "GetSearchAllLibrariesPart": ".get_search_all_libraries",
"GetSearchAllLibrariesPartTypedDict": ".get_search_all_libraries", "GetSearchAllLibrariesPartTypedDict": ".get_search_all_libraries",
"GetSearchAllLibrariesQueryParamIncludeCollections": ".get_search_all_libraries", "GetSearchAllLibrariesQueryParamIncludeCollections": ".get_search_all_libraries",
@@ -2871,8 +2858,6 @@ _dynamic_imports: dict[str, str] = {
"GetSearchAllLibrariesRole": ".get_search_all_libraries", "GetSearchAllLibrariesRole": ".get_search_all_libraries",
"GetSearchAllLibrariesRoleTypedDict": ".get_search_all_libraries", "GetSearchAllLibrariesRoleTypedDict": ".get_search_all_libraries",
"GetSearchAllLibrariesShowOrdering": ".get_search_all_libraries", "GetSearchAllLibrariesShowOrdering": ".get_search_all_libraries",
"GetSearchAllLibrariesStream": ".get_search_all_libraries",
"GetSearchAllLibrariesStreamTypedDict": ".get_search_all_libraries",
"GetSearchAllLibrariesType": ".get_search_all_libraries", "GetSearchAllLibrariesType": ".get_search_all_libraries",
"GetSearchAllLibrariesUltraBlurColors": ".get_search_all_libraries", "GetSearchAllLibrariesUltraBlurColors": ".get_search_all_libraries",
"GetSearchAllLibrariesUltraBlurColorsTypedDict": ".get_search_all_libraries", "GetSearchAllLibrariesUltraBlurColorsTypedDict": ".get_search_all_libraries",

View File

@@ -130,7 +130,7 @@ class GetActorsLibraryMediaContainerTypedDict(TypedDict):
r"""The secondary title of the media container.""" r"""The secondary title of the media container."""
view_group: str view_group: str
r"""Identifier for the view group layout.""" r"""Identifier for the view group layout."""
view_mode: str view_mode: NotRequired[str]
r"""Identifier for the view mode.""" r"""Identifier for the view mode."""
directory: NotRequired[List[GetActorsLibraryDirectoryTypedDict]] directory: NotRequired[List[GetActorsLibraryDirectoryTypedDict]]
r"""An array of actor entries for media items.""" r"""An array of actor entries for media items."""
@@ -170,7 +170,7 @@ class GetActorsLibraryMediaContainer(BaseModel):
view_group: Annotated[str, pydantic.Field(alias="viewGroup")] view_group: Annotated[str, pydantic.Field(alias="viewGroup")]
r"""Identifier for the view group layout.""" r"""Identifier for the view group layout."""
view_mode: Annotated[str, pydantic.Field(alias="viewMode")] view_mode: Annotated[Optional[str], pydantic.Field(alias="viewMode")] = None
r"""Identifier for the view mode.""" r"""Identifier for the view mode."""
directory: Annotated[ directory: Annotated[

File diff suppressed because it is too large Load Diff

View File

@@ -10,11 +10,12 @@ from plex_api_client.utils import (
FieldMetadata, FieldMetadata,
PathParamMetadata, PathParamMetadata,
QueryParamMetadata, QueryParamMetadata,
validate_const,
validate_open_enum, validate_open_enum,
) )
import pydantic import pydantic
from pydantic.functional_validators import PlainValidator from pydantic.functional_validators import AfterValidator, PlainValidator
from typing import List, Optional, Union from typing import List, Literal, Optional, Union
from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
@@ -446,39 +447,40 @@ class GetLibrarySectionsAllGuids(BaseModel):
""" """
class OptimizedForStreaming1(int, Enum): class GetLibrarySectionsAllOptimizedForStreaming1(int, Enum):
ZERO = 0 ZERO = 0
ONE = 1 ONE = 1
GetLibrarySectionsAllOptimizedForStreamingTypedDict = TypeAliasType( GetLibrarySectionsAllOptimizedForStreamingTypedDict = TypeAliasType(
"GetLibrarySectionsAllOptimizedForStreamingTypedDict", "GetLibrarySectionsAllOptimizedForStreamingTypedDict",
Union[OptimizedForStreaming1, bool], Union[GetLibrarySectionsAllOptimizedForStreaming1, bool],
) )
r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true""" r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true"""
GetLibrarySectionsAllOptimizedForStreaming = TypeAliasType( GetLibrarySectionsAllOptimizedForStreaming = TypeAliasType(
"GetLibrarySectionsAllOptimizedForStreaming", Union[OptimizedForStreaming1, bool] "GetLibrarySectionsAllOptimizedForStreaming",
Union[GetLibrarySectionsAllOptimizedForStreaming1, bool],
) )
r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true""" r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true"""
class GetLibrarySectionsAllOptimizedForStreaming1(int, Enum): class GetLibrarySectionsAllOptimizedForStreamingLibrary1(int, Enum):
ZERO = 0 ZERO = 0
ONE = 1 ONE = 1
GetLibrarySectionsAllLibraryOptimizedForStreamingTypedDict = TypeAliasType( GetLibrarySectionsAllLibraryOptimizedForStreamingTypedDict = TypeAliasType(
"GetLibrarySectionsAllLibraryOptimizedForStreamingTypedDict", "GetLibrarySectionsAllLibraryOptimizedForStreamingTypedDict",
Union[GetLibrarySectionsAllOptimizedForStreaming1, bool], Union[GetLibrarySectionsAllOptimizedForStreamingLibrary1, bool],
) )
r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true""" r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true"""
GetLibrarySectionsAllLibraryOptimizedForStreaming = TypeAliasType( GetLibrarySectionsAllLibraryOptimizedForStreaming = TypeAliasType(
"GetLibrarySectionsAllLibraryOptimizedForStreaming", "GetLibrarySectionsAllLibraryOptimizedForStreaming",
Union[GetLibrarySectionsAllOptimizedForStreaming1, bool], Union[GetLibrarySectionsAllOptimizedForStreamingLibrary1, bool],
) )
r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true""" r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true"""
@@ -490,35 +492,22 @@ class GetLibrarySectionsAllHasThumbnail(str, Enum):
TRUE = "1" TRUE = "1"
class GetLibrarySectionsAllStreamType(int, Enum, metaclass=utils.OpenEnumMeta):
r"""Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
"""
VIDEO = 1
AUDIO = 2
SUBTITLE = 3
class GetLibrarySectionsAllStreamTypedDict(TypedDict): class GetLibrarySectionsAllStreamTypedDict(TypedDict):
id: int id: int
r"""Unique stream identifier.""" r"""Unique stream identifier."""
stream_type: GetLibrarySectionsAllStreamType
r"""Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
"""
codec: str codec: str
r"""Codec used by the stream.""" r"""Codec used by the stream."""
display_title: str display_title: str
r"""Display title for the stream.""" r"""Display title for the stream."""
extended_display_title: str extended_display_title: str
r"""Extended display title for the stream.""" r"""Extended display title for the stream."""
stream_type: Literal[1]
r"""Stream type:
- VIDEO = 1
- AUDIO = 2
- SUBTITLE = 3
"""
format_: NotRequired[str] format_: NotRequired[str]
r"""Format of the stream (e.g., srt).""" r"""Format of the stream (e.g., srt)."""
default: NotRequired[bool] default: NotRequired[bool]
@@ -612,19 +601,6 @@ class GetLibrarySectionsAllStream(BaseModel):
id: int id: int
r"""Unique stream identifier.""" r"""Unique stream identifier."""
stream_type: Annotated[
Annotated[
GetLibrarySectionsAllStreamType, PlainValidator(validate_open_enum(True))
],
pydantic.Field(alias="streamType"),
]
r"""Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
"""
codec: str codec: str
r"""Codec used by the stream.""" r"""Codec used by the stream."""
@@ -634,6 +610,17 @@ class GetLibrarySectionsAllStream(BaseModel):
extended_display_title: Annotated[str, pydantic.Field(alias="extendedDisplayTitle")] extended_display_title: Annotated[str, pydantic.Field(alias="extendedDisplayTitle")]
r"""Extended display title for the stream.""" r"""Extended display title for the stream."""
STREAM_TYPE: Annotated[
Annotated[Literal[1], AfterValidator(validate_const(1))],
pydantic.Field(alias="streamType"),
] = 1
r"""Stream type:
- VIDEO = 1
- AUDIO = 2
- SUBTITLE = 3
"""
format_: Annotated[Optional[str], pydantic.Field(alias="format")] = None format_: Annotated[Optional[str], pydantic.Field(alias="format")] = None
r"""Format of the stream (e.g., srt).""" r"""Format of the stream (e.g., srt)."""
@@ -1104,8 +1091,6 @@ class GetLibrarySectionsAllMetadataTypedDict(TypedDict):
r"""The total number of seasons (for TV shows).""" r"""The total number of seasons (for TV shows)."""
duration: int duration: int
r"""The duration of the media item in milliseconds.""" r"""The duration of the media item in milliseconds."""
originally_available_at: date
r"""The original release date of the media item."""
added_at: int added_at: int
studio: NotRequired[str] studio: NotRequired[str]
r"""The studio that produced the media item.""" r"""The studio that produced the media item."""
@@ -1117,6 +1102,8 @@ class GetLibrarySectionsAllMetadataTypedDict(TypedDict):
r"""The number of leaf items (end nodes) under this media item.""" r"""The number of leaf items (end nodes) under this media item."""
viewed_leaf_count: NotRequired[int] viewed_leaf_count: NotRequired[int]
r"""The number of leaf items that have been viewed.""" r"""The number of leaf items that have been viewed."""
originally_available_at: NotRequired[date]
r"""The original release date of the media item."""
updated_at: NotRequired[int] updated_at: NotRequired[int]
r"""Unix epoch datetime in seconds""" r"""Unix epoch datetime in seconds"""
audience_rating_image: NotRequired[str] audience_rating_image: NotRequired[str]
@@ -1245,11 +1232,6 @@ class GetLibrarySectionsAllMetadata(BaseModel):
duration: int duration: int
r"""The duration of the media item in milliseconds.""" r"""The duration of the media item in milliseconds."""
originally_available_at: Annotated[
date, pydantic.Field(alias="originallyAvailableAt")
]
r"""The original release date of the media item."""
added_at: Annotated[int, pydantic.Field(alias="addedAt")] added_at: Annotated[int, pydantic.Field(alias="addedAt")]
studio: Optional[str] = None studio: Optional[str] = None
@@ -1271,6 +1253,11 @@ class GetLibrarySectionsAllMetadata(BaseModel):
] = None ] = None
r"""The number of leaf items that have been viewed.""" r"""The number of leaf items that have been viewed."""
originally_available_at: Annotated[
Optional[date], pydantic.Field(alias="originallyAvailableAt")
] = None
r"""The original release date of the media item."""
updated_at: Annotated[Optional[int], pydantic.Field(alias="updatedAt")] = None updated_at: Annotated[Optional[int], pydantic.Field(alias="updatedAt")] = None
r"""Unix epoch datetime in seconds""" r"""Unix epoch datetime in seconds"""
@@ -1448,10 +1435,6 @@ class GetLibrarySectionsAllMediaContainerTypedDict(TypedDict):
r"""The content type or mode.""" r"""The content type or mode."""
identifier: str identifier: str
r"""An plugin identifier for the media container.""" r"""An plugin identifier for the media container."""
library_section_id: int
r"""The unique identifier for the library section."""
library_section_title: str
r"""The title of the library section."""
media_tag_prefix: str media_tag_prefix: str
r"""The prefix used for media tag resource paths.""" r"""The prefix used for media tag resource paths."""
media_tag_version: int media_tag_version: int
@@ -1466,6 +1449,10 @@ class GetLibrarySectionsAllMediaContainerTypedDict(TypedDict):
r"""The secondary title of the media container.""" r"""The secondary title of the media container."""
view_group: str view_group: str
r"""Identifier for the view group layout.""" r"""Identifier for the view group layout."""
library_section_id: NotRequired[int]
r"""The unique identifier for the library section."""
library_section_title: NotRequired[str]
r"""The title of the library section."""
library_section_uuid: NotRequired[str] library_section_uuid: NotRequired[str]
r"""The universally unique identifier for the library section.""" r"""The universally unique identifier for the library section."""
meta: NotRequired[GetLibrarySectionsAllMetaTypedDict] meta: NotRequired[GetLibrarySectionsAllMetaTypedDict]
@@ -1498,12 +1485,6 @@ class GetLibrarySectionsAllMediaContainer(BaseModel):
identifier: str identifier: str
r"""An plugin identifier for the media container.""" r"""An plugin identifier for the media container."""
library_section_id: Annotated[int, pydantic.Field(alias="librarySectionID")]
r"""The unique identifier for the library section."""
library_section_title: Annotated[str, pydantic.Field(alias="librarySectionTitle")]
r"""The title of the library section."""
media_tag_prefix: Annotated[str, pydantic.Field(alias="mediaTagPrefix")] media_tag_prefix: Annotated[str, pydantic.Field(alias="mediaTagPrefix")]
r"""The prefix used for media tag resource paths.""" r"""The prefix used for media tag resource paths."""
@@ -1525,6 +1506,16 @@ class GetLibrarySectionsAllMediaContainer(BaseModel):
view_group: Annotated[str, pydantic.Field(alias="viewGroup")] view_group: Annotated[str, pydantic.Field(alias="viewGroup")]
r"""Identifier for the view group layout.""" r"""Identifier for the view group layout."""
library_section_id: Annotated[
Optional[int], pydantic.Field(alias="librarySectionID")
] = None
r"""The unique identifier for the library section."""
library_section_title: Annotated[
Optional[str], pydantic.Field(alias="librarySectionTitle")
] = None
r"""The title of the library section."""
library_section_uuid: Annotated[ library_section_uuid: Annotated[
Optional[str], pydantic.Field(alias="librarySectionUUID") Optional[str], pydantic.Field(alias="librarySectionUUID")
] = None ] = None

View File

@@ -10,11 +10,12 @@ from plex_api_client.utils import (
FieldMetadata, FieldMetadata,
PathParamMetadata, PathParamMetadata,
QueryParamMetadata, QueryParamMetadata,
validate_const,
validate_open_enum, validate_open_enum,
) )
import pydantic import pydantic
from pydantic.functional_validators import PlainValidator from pydantic.functional_validators import AfterValidator, PlainValidator
from typing import List, Optional, Union from typing import List, Literal, Optional, Union
from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
@@ -246,14 +247,18 @@ GetMediaMetaDataLibraryOptimizedForStreamingTypedDict = TypeAliasType(
"GetMediaMetaDataLibraryOptimizedForStreamingTypedDict", "GetMediaMetaDataLibraryOptimizedForStreamingTypedDict",
Union[GetMediaMetaDataOptimizedForStreamingLibrary1, bool], Union[GetMediaMetaDataOptimizedForStreamingLibrary1, bool],
) )
r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true""" r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
"""
GetMediaMetaDataLibraryOptimizedForStreaming = TypeAliasType( GetMediaMetaDataLibraryOptimizedForStreaming = TypeAliasType(
"GetMediaMetaDataLibraryOptimizedForStreaming", "GetMediaMetaDataLibraryOptimizedForStreaming",
Union[GetMediaMetaDataOptimizedForStreamingLibrary1, bool], Union[GetMediaMetaDataOptimizedForStreamingLibrary1, bool],
) )
r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true""" r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
"""
class GetMediaMetaDataHasThumbnail(str, Enum): class GetMediaMetaDataHasThumbnail(str, Enum):
@@ -263,39 +268,22 @@ class GetMediaMetaDataHasThumbnail(str, Enum):
TRUE = "1" TRUE = "1"
class GetMediaMetaDataStreamType(int, Enum, metaclass=utils.OpenEnumMeta):
r"""Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
"""
VIDEO = 1
AUDIO = 2
SUBTITLE = 3
class GetMediaMetaDataStreamTypedDict(TypedDict): class GetMediaMetaDataStreamTypedDict(TypedDict):
id: int id: int
r"""Unique stream identifier.""" r"""Unique stream identifier."""
stream_type: GetMediaMetaDataStreamType stream_type: Literal[1]
r"""Stream type: r"""Stream type:
- 1 = video - VIDEO = 1
- 2 = audio - AUDIO = 2
- 3 = subtitle - SUBTITLE = 3
""" """
codec: str
r"""Codec used by the stream."""
display_title: str
r"""Display title for the stream."""
extended_display_title: str
r"""Extended display title for the stream."""
format_: NotRequired[str] format_: NotRequired[str]
r"""Format of the stream (e.g., srt).""" r"""Format of the stream (e.g., srt)."""
default: NotRequired[bool] default: NotRequired[bool]
r"""Indicates if this stream is default.""" r"""Indicates if this stream is default."""
codec: NotRequired[str]
r"""Codec used by the stream."""
index: NotRequired[int] index: NotRequired[int]
r"""Index of the stream.""" r"""Index of the stream."""
bitrate: NotRequired[int] bitrate: NotRequired[int]
@@ -362,6 +350,10 @@ class GetMediaMetaDataStreamTypedDict(TypedDict):
r"""Number of reference frames.""" r"""Number of reference frames."""
width: NotRequired[int] width: NotRequired[int]
r"""Width of the video stream.""" r"""Width of the video stream."""
display_title: NotRequired[str]
r"""Display title for the stream."""
extended_display_title: NotRequired[str]
r"""Extended display title for the stream."""
selected: NotRequired[bool] selected: NotRequired[bool]
r"""Indicates if this stream is selected (applicable for audio streams).""" r"""Indicates if this stream is selected (applicable for audio streams)."""
forced: NotRequired[bool] forced: NotRequired[bool]
@@ -385,32 +377,26 @@ class GetMediaMetaDataStream(BaseModel):
id: int id: int
r"""Unique stream identifier.""" r"""Unique stream identifier."""
stream_type: Annotated[ STREAM_TYPE: Annotated[
Annotated[GetMediaMetaDataStreamType, PlainValidator(validate_open_enum(True))], Annotated[Literal[1], AfterValidator(validate_const(1))],
pydantic.Field(alias="streamType"), pydantic.Field(alias="streamType"),
] ] = 1
r"""Stream type: r"""Stream type:
- 1 = video - VIDEO = 1
- 2 = audio - AUDIO = 2
- 3 = subtitle - SUBTITLE = 3
""" """
codec: str
r"""Codec used by the stream."""
display_title: Annotated[str, pydantic.Field(alias="displayTitle")]
r"""Display title for the stream."""
extended_display_title: Annotated[str, pydantic.Field(alias="extendedDisplayTitle")]
r"""Extended display title for the stream."""
format_: Annotated[Optional[str], pydantic.Field(alias="format")] = None format_: Annotated[Optional[str], pydantic.Field(alias="format")] = None
r"""Format of the stream (e.g., srt).""" r"""Format of the stream (e.g., srt)."""
default: Optional[bool] = None default: Optional[bool] = None
r"""Indicates if this stream is default.""" r"""Indicates if this stream is default."""
codec: Optional[str] = None
r"""Codec used by the stream."""
index: Optional[int] = None index: Optional[int] = None
r"""Index of the stream.""" r"""Index of the stream."""
@@ -534,6 +520,14 @@ class GetMediaMetaDataStream(BaseModel):
width: Optional[int] = None width: Optional[int] = None
r"""Width of the video stream.""" r"""Width of the video stream."""
display_title: Annotated[Optional[str], pydantic.Field(alias="displayTitle")] = None
r"""Display title for the stream."""
extended_display_title: Annotated[
Optional[str], pydantic.Field(alias="extendedDisplayTitle")
] = None
r"""Extended display title for the stream."""
selected: Optional[bool] = None selected: Optional[bool] = None
r"""Indicates if this stream is selected (applicable for audio streams).""" r"""Indicates if this stream is selected (applicable for audio streams)."""
@@ -568,19 +562,19 @@ class GetMediaMetaDataStream(BaseModel):
class GetMediaMetaDataPartTypedDict(TypedDict): class GetMediaMetaDataPartTypedDict(TypedDict):
id: int id: int
r"""Unique part identifier.""" r"""Unique part identifier."""
key: str
r"""Key to access this part."""
file: str
r"""File path for the part."""
size: int
r"""File size in bytes."""
accessible: NotRequired[bool] accessible: NotRequired[bool]
r"""Indicates if the part is accessible.""" r"""Indicates if the part is accessible."""
exists: NotRequired[bool] exists: NotRequired[bool]
r"""Indicates if the part exists.""" r"""Indicates if the part exists."""
key: NotRequired[str]
r"""Key to access this part."""
indexes: NotRequired[str] indexes: NotRequired[str]
duration: NotRequired[int] duration: NotRequired[int]
r"""Duration of the part in milliseconds.""" r"""Duration of the part in milliseconds."""
file: NotRequired[str]
r"""File path for the part."""
size: NotRequired[int]
r"""File size in bytes."""
packet_length: NotRequired[int] packet_length: NotRequired[int]
container: NotRequired[str] container: NotRequired[str]
r"""Container format of the part.""" r"""Container format of the part."""
@@ -592,36 +586,37 @@ class GetMediaMetaDataPartTypedDict(TypedDict):
optimized_for_streaming: NotRequired[ optimized_for_streaming: NotRequired[
GetMediaMetaDataLibraryOptimizedForStreamingTypedDict GetMediaMetaDataLibraryOptimizedForStreamingTypedDict
] ]
r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true""" r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
"""
has_thumbnail: NotRequired[GetMediaMetaDataHasThumbnail] has_thumbnail: NotRequired[GetMediaMetaDataHasThumbnail]
stream: NotRequired[List[GetMediaMetaDataStreamTypedDict]] stream: NotRequired[List[GetMediaMetaDataStreamTypedDict]]
r"""An array of streams for this part."""
class GetMediaMetaDataPart(BaseModel): class GetMediaMetaDataPart(BaseModel):
id: int id: int
r"""Unique part identifier.""" r"""Unique part identifier."""
key: str
r"""Key to access this part."""
file: str
r"""File path for the part."""
size: int
r"""File size in bytes."""
accessible: Optional[bool] = None accessible: Optional[bool] = None
r"""Indicates if the part is accessible.""" r"""Indicates if the part is accessible."""
exists: Optional[bool] = None exists: Optional[bool] = None
r"""Indicates if the part exists.""" r"""Indicates if the part exists."""
key: Optional[str] = None
r"""Key to access this part."""
indexes: Optional[str] = None indexes: Optional[str] = None
duration: Optional[int] = None duration: Optional[int] = None
r"""Duration of the part in milliseconds.""" r"""Duration of the part in milliseconds."""
file: Optional[str] = None
r"""File path for the part."""
size: Optional[int] = None
r"""File size in bytes."""
packet_length: Annotated[Optional[int], pydantic.Field(alias="packetLength")] = None packet_length: Annotated[Optional[int], pydantic.Field(alias="packetLength")] = None
container: Optional[str] = None container: Optional[str] = None
@@ -641,7 +636,9 @@ class GetMediaMetaDataPart(BaseModel):
Optional[GetMediaMetaDataLibraryOptimizedForStreaming], Optional[GetMediaMetaDataLibraryOptimizedForStreaming],
pydantic.Field(alias="optimizedForStreaming"), pydantic.Field(alias="optimizedForStreaming"),
] = None ] = None
r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true""" r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
"""
has_thumbnail: Annotated[ has_thumbnail: Annotated[
Optional[GetMediaMetaDataHasThumbnail], pydantic.Field(alias="hasThumbnail") Optional[GetMediaMetaDataHasThumbnail], pydantic.Field(alias="hasThumbnail")
@@ -650,7 +647,6 @@ class GetMediaMetaDataPart(BaseModel):
stream: Annotated[ stream: Annotated[
Optional[List[GetMediaMetaDataStream]], pydantic.Field(alias="Stream") Optional[List[GetMediaMetaDataStream]], pydantic.Field(alias="Stream")
] = None ] = None
r"""An array of streams for this part."""
class GetMediaMetaDataMediaTypedDict(TypedDict): class GetMediaMetaDataMediaTypedDict(TypedDict):
@@ -676,7 +672,7 @@ class GetMediaMetaDataMediaTypedDict(TypedDict):
video_resolution: NotRequired[str] video_resolution: NotRequired[str]
r"""Video resolution (e.g., 4k).""" r"""Video resolution (e.g., 4k)."""
container: NotRequired[str] container: NotRequired[str]
r"""File container type.""" r"""Container format of the media."""
video_frame_rate: NotRequired[str] video_frame_rate: NotRequired[str]
r"""Frame rate of the video. Values found include NTSC, PAL, 24p r"""Frame rate of the video. Values found include NTSC, PAL, 24p
@@ -690,8 +686,11 @@ class GetMediaMetaDataMediaTypedDict(TypedDict):
optimized_for_streaming: NotRequired[GetMediaMetaDataOptimizedForStreamingTypedDict] optimized_for_streaming: NotRequired[GetMediaMetaDataOptimizedForStreamingTypedDict]
r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true""" r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true"""
has64bit_offsets: NotRequired[bool] has64bit_offsets: NotRequired[bool]
r"""Indicates whether the media has 64-bit offsets.
This is relevant for media files that may require larger offsets than what 32-bit integers can provide.
"""
part: NotRequired[List[GetMediaMetaDataPartTypedDict]] part: NotRequired[List[GetMediaMetaDataPartTypedDict]]
r"""An array of parts for this media item."""
class GetMediaMetaDataMedia(BaseModel): class GetMediaMetaDataMedia(BaseModel):
@@ -734,7 +733,7 @@ class GetMediaMetaDataMedia(BaseModel):
r"""Video resolution (e.g., 4k).""" r"""Video resolution (e.g., 4k)."""
container: Optional[str] = None container: Optional[str] = None
r"""File container type.""" r"""Container format of the media."""
video_frame_rate: Annotated[ video_frame_rate: Annotated[
Optional[str], pydantic.Field(alias="videoFrameRate") Optional[str], pydantic.Field(alias="videoFrameRate")
@@ -763,11 +762,14 @@ class GetMediaMetaDataMedia(BaseModel):
has64bit_offsets: Annotated[ has64bit_offsets: Annotated[
Optional[bool], pydantic.Field(alias="has64bitOffsets") Optional[bool], pydantic.Field(alias="has64bitOffsets")
] = None ] = None
r"""Indicates whether the media has 64-bit offsets.
This is relevant for media files that may require larger offsets than what 32-bit integers can provide.
"""
part: Annotated[ part: Annotated[
Optional[List[GetMediaMetaDataPart]], pydantic.Field(alias="Part") Optional[List[GetMediaMetaDataPart]], pydantic.Field(alias="Part")
] = None ] = None
r"""An array of parts for this media item."""
class GetMediaMetaDataGenreTypedDict(TypedDict): class GetMediaMetaDataGenreTypedDict(TypedDict):
@@ -972,7 +974,7 @@ class GetMediaMetaDataRole(BaseModel):
r"""The absolute URL of the thumbnail image for the actor.""" r"""The absolute URL of the thumbnail image for the actor."""
class RatingsTypedDict(TypedDict): class GetMediaMetaDataRatingsTypedDict(TypedDict):
image: str image: str
r"""The image or reference for the rating.""" r"""The image or reference for the rating."""
value: float value: float
@@ -981,7 +983,7 @@ class RatingsTypedDict(TypedDict):
r"""The type of rating (e.g., audience, critic).""" r"""The type of rating (e.g., audience, critic)."""
class Ratings(BaseModel): class GetMediaMetaDataRatings(BaseModel):
image: str image: str
r"""The image or reference for the rating.""" r"""The image or reference for the rating."""
@@ -1022,7 +1024,7 @@ class GetMediaMetaDataLocation(BaseModel):
r"""The file path for the location.""" r"""The file path for the location."""
class ChapterTypedDict(TypedDict): class GetMediaMetaDataChapterTypedDict(TypedDict):
r"""The thumbnail for the chapter""" r"""The thumbnail for the chapter"""
id: int id: int
@@ -1033,7 +1035,7 @@ class ChapterTypedDict(TypedDict):
thumb: str thumb: str
class Chapter(BaseModel): class GetMediaMetaDataChapter(BaseModel):
r"""The thumbnail for the chapter""" r"""The thumbnail for the chapter"""
id: int id: int
@@ -1049,7 +1051,7 @@ class Chapter(BaseModel):
thumb: str thumb: str
class AttributesTypedDict(TypedDict): class GetMediaMetaDataAttributesTypedDict(TypedDict):
r"""Attributes associated with the marker.""" r"""Attributes associated with the marker."""
id: int id: int
@@ -1058,7 +1060,7 @@ class AttributesTypedDict(TypedDict):
r"""The version number of the marker attributes.""" r"""The version number of the marker attributes."""
class Attributes(BaseModel): class GetMediaMetaDataAttributes(BaseModel):
r"""Attributes associated with the marker.""" r"""Attributes associated with the marker."""
id: int id: int
@@ -1068,7 +1070,7 @@ class Attributes(BaseModel):
r"""The version number of the marker attributes.""" r"""The version number of the marker attributes."""
class MarkerTypedDict(TypedDict): class GetMediaMetaDataMarkerTypedDict(TypedDict):
r"""The final status of the marker""" r"""The final status of the marker"""
id: int id: int
@@ -1076,11 +1078,11 @@ class MarkerTypedDict(TypedDict):
start_time_offset: int start_time_offset: int
end_time_offset: int end_time_offset: int
final: NotRequired[bool] final: NotRequired[bool]
attributes: NotRequired[AttributesTypedDict] attributes: NotRequired[GetMediaMetaDataAttributesTypedDict]
r"""Attributes associated with the marker.""" r"""Attributes associated with the marker."""
class Marker(BaseModel): class GetMediaMetaDataMarker(BaseModel):
r"""The final status of the marker""" r"""The final status of the marker"""
id: int id: int
@@ -1093,18 +1095,18 @@ class Marker(BaseModel):
final: Optional[bool] = None final: Optional[bool] = None
attributes: Annotated[Optional[Attributes], pydantic.Field(alias="Attributes")] = ( attributes: Annotated[
None Optional[GetMediaMetaDataAttributes], pydantic.Field(alias="Attributes")
) ] = None
r"""Attributes associated with the marker.""" r"""Attributes associated with the marker."""
class ExtrasTypedDict(TypedDict): class GetMediaMetaDataExtrasTypedDict(TypedDict):
size: NotRequired[int] size: NotRequired[int]
r"""The size of the extras.""" r"""The size of the extras."""
class Extras(BaseModel): class GetMediaMetaDataExtras(BaseModel):
size: Optional[int] = None size: Optional[int] = None
r"""The size of the extras.""" r"""The size of the extras."""
@@ -1147,15 +1149,7 @@ class GetMediaMetaDataMetadataTypedDict(TypedDict):
r"""The total number of seasons (for TV shows).""" r"""The total number of seasons (for TV shows)."""
duration: int duration: int
r"""The duration of the media item in milliseconds.""" r"""The duration of the media item in milliseconds."""
originally_available_at: date
r"""The original release date of the media item."""
added_at: int added_at: int
library_section_id: int
r"""The identifier for the library section."""
library_section_title: str
r"""The title of the library section."""
library_section_key: str
r"""The key corresponding to the library section."""
studio: NotRequired[str] studio: NotRequired[str]
r"""The studio that produced the media item.""" r"""The studio that produced the media item."""
content_rating: NotRequired[str] content_rating: NotRequired[str]
@@ -1166,6 +1160,8 @@ class GetMediaMetaDataMetadataTypedDict(TypedDict):
r"""The number of leaf items (end nodes) under this media item.""" r"""The number of leaf items (end nodes) under this media item."""
viewed_leaf_count: NotRequired[int] viewed_leaf_count: NotRequired[int]
r"""The number of leaf items that have been viewed.""" r"""The number of leaf items that have been viewed."""
originally_available_at: NotRequired[date]
r"""The original release date of the media item."""
updated_at: NotRequired[int] updated_at: NotRequired[int]
r"""Unix epoch datetime in seconds""" r"""Unix epoch datetime in seconds"""
audience_rating_image: NotRequired[str] audience_rating_image: NotRequired[str]
@@ -1226,6 +1222,12 @@ class GetMediaMetaDataMetadataTypedDict(TypedDict):
r"""The rating provided by a user for the item. This value is expressed as a decimal number.""" r"""The rating provided by a user for the item. This value is expressed as a decimal number."""
image: NotRequired[List[GetMediaMetaDataImageTypedDict]] image: NotRequired[List[GetMediaMetaDataImageTypedDict]]
ultra_blur_colors: NotRequired[GetMediaMetaDataUltraBlurColorsTypedDict] ultra_blur_colors: NotRequired[GetMediaMetaDataUltraBlurColorsTypedDict]
library_section_id: NotRequired[int]
r"""The identifier for the library section."""
library_section_title: NotRequired[str]
r"""The title of the library section."""
library_section_key: NotRequired[str]
r"""The key corresponding to the library section."""
guids: NotRequired[List[GetMediaMetaDataGuidsTypedDict]] guids: NotRequired[List[GetMediaMetaDataGuidsTypedDict]]
media: NotRequired[List[GetMediaMetaDataMediaTypedDict]] media: NotRequired[List[GetMediaMetaDataMediaTypedDict]]
genre: NotRequired[List[GetMediaMetaDataGenreTypedDict]] genre: NotRequired[List[GetMediaMetaDataGenreTypedDict]]
@@ -1234,12 +1236,12 @@ class GetMediaMetaDataMetadataTypedDict(TypedDict):
writer: NotRequired[List[GetMediaMetaDataWriterTypedDict]] writer: NotRequired[List[GetMediaMetaDataWriterTypedDict]]
producer: NotRequired[List[GetMediaMetaDataProducerTypedDict]] producer: NotRequired[List[GetMediaMetaDataProducerTypedDict]]
role: NotRequired[List[GetMediaMetaDataRoleTypedDict]] role: NotRequired[List[GetMediaMetaDataRoleTypedDict]]
ratings: NotRequired[List[RatingsTypedDict]] ratings: NotRequired[List[GetMediaMetaDataRatingsTypedDict]]
similar: NotRequired[List[GetMediaMetaDataSimilarTypedDict]] similar: NotRequired[List[GetMediaMetaDataSimilarTypedDict]]
location: NotRequired[List[GetMediaMetaDataLocationTypedDict]] location: NotRequired[List[GetMediaMetaDataLocationTypedDict]]
chapter: NotRequired[List[ChapterTypedDict]] chapter: NotRequired[List[GetMediaMetaDataChapterTypedDict]]
marker: NotRequired[List[MarkerTypedDict]] marker: NotRequired[List[GetMediaMetaDataMarkerTypedDict]]
extras: NotRequired[ExtrasTypedDict] extras: NotRequired[GetMediaMetaDataExtrasTypedDict]
class GetMediaMetaDataMetadata(BaseModel): class GetMediaMetaDataMetadata(BaseModel):
@@ -1298,22 +1300,8 @@ class GetMediaMetaDataMetadata(BaseModel):
duration: int duration: int
r"""The duration of the media item in milliseconds.""" r"""The duration of the media item in milliseconds."""
originally_available_at: Annotated[
date, pydantic.Field(alias="originallyAvailableAt")
]
r"""The original release date of the media item."""
added_at: Annotated[int, pydantic.Field(alias="addedAt")] added_at: Annotated[int, pydantic.Field(alias="addedAt")]
library_section_id: Annotated[int, pydantic.Field(alias="librarySectionID")]
r"""The identifier for the library section."""
library_section_title: Annotated[str, pydantic.Field(alias="librarySectionTitle")]
r"""The title of the library section."""
library_section_key: Annotated[str, pydantic.Field(alias="librarySectionKey")]
r"""The key corresponding to the library section."""
studio: Optional[str] = None studio: Optional[str] = None
r"""The studio that produced the media item.""" r"""The studio that produced the media item."""
@@ -1333,6 +1321,11 @@ class GetMediaMetaDataMetadata(BaseModel):
] = None ] = None
r"""The number of leaf items that have been viewed.""" r"""The number of leaf items that have been viewed."""
originally_available_at: Annotated[
Optional[date], pydantic.Field(alias="originallyAvailableAt")
] = None
r"""The original release date of the media item."""
updated_at: Annotated[Optional[int], pydantic.Field(alias="updatedAt")] = None updated_at: Annotated[Optional[int], pydantic.Field(alias="updatedAt")] = None
r"""Unix epoch datetime in seconds""" r"""Unix epoch datetime in seconds"""
@@ -1461,6 +1454,21 @@ class GetMediaMetaDataMetadata(BaseModel):
pydantic.Field(alias="UltraBlurColors"), pydantic.Field(alias="UltraBlurColors"),
] = None ] = None
library_section_id: Annotated[
Optional[int], pydantic.Field(alias="librarySectionID")
] = None
r"""The identifier for the library section."""
library_section_title: Annotated[
Optional[str], pydantic.Field(alias="librarySectionTitle")
] = None
r"""The title of the library section."""
library_section_key: Annotated[
Optional[str], pydantic.Field(alias="librarySectionKey")
] = None
r"""The key corresponding to the library section."""
guids: Annotated[ guids: Annotated[
Optional[List[GetMediaMetaDataGuids]], pydantic.Field(alias="Guid") Optional[List[GetMediaMetaDataGuids]], pydantic.Field(alias="Guid")
] = None ] = None
@@ -1493,7 +1501,9 @@ class GetMediaMetaDataMetadata(BaseModel):
Optional[List[GetMediaMetaDataRole]], pydantic.Field(alias="Role") Optional[List[GetMediaMetaDataRole]], pydantic.Field(alias="Role")
] = None ] = None
ratings: Annotated[Optional[List[Ratings]], pydantic.Field(alias="Rating")] = None ratings: Annotated[
Optional[List[GetMediaMetaDataRatings]], pydantic.Field(alias="Rating")
] = None
similar: Annotated[ similar: Annotated[
Optional[List[GetMediaMetaDataSimilar]], pydantic.Field(alias="Similar") Optional[List[GetMediaMetaDataSimilar]], pydantic.Field(alias="Similar")
@@ -1503,11 +1513,17 @@ class GetMediaMetaDataMetadata(BaseModel):
Optional[List[GetMediaMetaDataLocation]], pydantic.Field(alias="Location") Optional[List[GetMediaMetaDataLocation]], pydantic.Field(alias="Location")
] = None ] = None
chapter: Annotated[Optional[List[Chapter]], pydantic.Field(alias="Chapter")] = None chapter: Annotated[
Optional[List[GetMediaMetaDataChapter]], pydantic.Field(alias="Chapter")
] = None
marker: Annotated[Optional[List[Marker]], pydantic.Field(alias="Marker")] = None marker: Annotated[
Optional[List[GetMediaMetaDataMarker]], pydantic.Field(alias="Marker")
] = None
extras: Annotated[Optional[Extras], pydantic.Field(alias="Extras")] = None extras: Annotated[
Optional[GetMediaMetaDataExtras], pydantic.Field(alias="Extras")
] = None
class GetMediaMetaDataMediaContainerTypedDict(TypedDict): class GetMediaMetaDataMediaContainerTypedDict(TypedDict):
@@ -1517,16 +1533,16 @@ class GetMediaMetaDataMediaContainerTypedDict(TypedDict):
r"""Indicates whether syncing is allowed.""" r"""Indicates whether syncing is allowed."""
identifier: str identifier: str
r"""An plugin identifier for the media container.""" r"""An plugin identifier for the media container."""
library_section_id: int
r"""The unique identifier for the library section."""
library_section_title: str
r"""The title of the library section."""
media_tag_prefix: str media_tag_prefix: str
r"""The prefix used for media tag resource paths.""" r"""The prefix used for media tag resource paths."""
media_tag_version: int media_tag_version: int
r"""The version number for media tags.""" r"""The version number for media tags."""
metadata: List[GetMediaMetaDataMetadataTypedDict] metadata: List[GetMediaMetaDataMetadataTypedDict]
r"""An array of metadata items.""" r"""An array of metadata items."""
library_section_id: NotRequired[int]
r"""The unique identifier for the library section."""
library_section_title: NotRequired[str]
r"""The title of the library section."""
library_section_uuid: NotRequired[str] library_section_uuid: NotRequired[str]
r"""The universally unique identifier for the library section.""" r"""The universally unique identifier for the library section."""
@@ -1541,12 +1557,6 @@ class GetMediaMetaDataMediaContainer(BaseModel):
identifier: str identifier: str
r"""An plugin identifier for the media container.""" r"""An plugin identifier for the media container."""
library_section_id: Annotated[int, pydantic.Field(alias="librarySectionID")]
r"""The unique identifier for the library section."""
library_section_title: Annotated[str, pydantic.Field(alias="librarySectionTitle")]
r"""The title of the library section."""
media_tag_prefix: Annotated[str, pydantic.Field(alias="mediaTagPrefix")] media_tag_prefix: Annotated[str, pydantic.Field(alias="mediaTagPrefix")]
r"""The prefix used for media tag resource paths.""" r"""The prefix used for media tag resource paths."""
@@ -1558,6 +1568,16 @@ class GetMediaMetaDataMediaContainer(BaseModel):
] ]
r"""An array of metadata items.""" r"""An array of metadata items."""
library_section_id: Annotated[
Optional[int], pydantic.Field(alias="librarySectionID")
] = None
r"""The unique identifier for the library section."""
library_section_title: Annotated[
Optional[str], pydantic.Field(alias="librarySectionTitle")
] = None
r"""The title of the library section."""
library_section_uuid: Annotated[ library_section_uuid: Annotated[
Optional[str], pydantic.Field(alias="librarySectionUUID") Optional[str], pydantic.Field(alias="librarySectionUUID")
] = None ] = None

View File

@@ -6,10 +6,15 @@ from enum import Enum
import httpx import httpx
from plex_api_client import utils from plex_api_client import utils
from plex_api_client.types import BaseModel from plex_api_client.types import BaseModel
from plex_api_client.utils import FieldMetadata, QueryParamMetadata, validate_open_enum from plex_api_client.utils import (
FieldMetadata,
QueryParamMetadata,
validate_const,
validate_open_enum,
)
import pydantic import pydantic
from pydantic.functional_validators import PlainValidator from pydantic.functional_validators import AfterValidator, PlainValidator
from typing import List, Optional, Union from typing import List, Literal, Optional, Union
from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
@@ -433,35 +438,22 @@ class HasThumbnail(str, Enum):
TRUE = "1" TRUE = "1"
class StreamType(int, Enum, metaclass=utils.OpenEnumMeta):
r"""Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
"""
VIDEO = 1
AUDIO = 2
SUBTITLE = 3
class StreamTypedDict(TypedDict): class StreamTypedDict(TypedDict):
id: int id: int
r"""Unique stream identifier.""" r"""Unique stream identifier."""
stream_type: StreamType
r"""Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
"""
codec: str codec: str
r"""Codec used by the stream.""" r"""Codec used by the stream."""
display_title: str display_title: str
r"""Display title for the stream.""" r"""Display title for the stream."""
extended_display_title: str extended_display_title: str
r"""Extended display title for the stream.""" r"""Extended display title for the stream."""
stream_type: Literal[1]
r"""Stream type:
- VIDEO = 1
- AUDIO = 2
- SUBTITLE = 3
"""
format_: NotRequired[str] format_: NotRequired[str]
r"""Format of the stream (e.g., srt).""" r"""Format of the stream (e.g., srt)."""
default: NotRequired[bool] default: NotRequired[bool]
@@ -555,17 +547,6 @@ class Stream(BaseModel):
id: int id: int
r"""Unique stream identifier.""" r"""Unique stream identifier."""
stream_type: Annotated[
Annotated[StreamType, PlainValidator(validate_open_enum(True))],
pydantic.Field(alias="streamType"),
]
r"""Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
"""
codec: str codec: str
r"""Codec used by the stream.""" r"""Codec used by the stream."""
@@ -575,6 +556,17 @@ class Stream(BaseModel):
extended_display_title: Annotated[str, pydantic.Field(alias="extendedDisplayTitle")] extended_display_title: Annotated[str, pydantic.Field(alias="extendedDisplayTitle")]
r"""Extended display title for the stream.""" r"""Extended display title for the stream."""
STREAM_TYPE: Annotated[
Annotated[Literal[1], AfterValidator(validate_const(1))],
pydantic.Field(alias="streamType"),
] = 1
r"""Stream type:
- VIDEO = 1
- AUDIO = 2
- SUBTITLE = 3
"""
format_: Annotated[Optional[str], pydantic.Field(alias="format")] = None format_: Annotated[Optional[str], pydantic.Field(alias="format")] = None
r"""Format of the stream (e.g., srt).""" r"""Format of the stream (e.g., srt)."""
@@ -1212,14 +1204,6 @@ class GetRecentlyAddedMetadataTypedDict(TypedDict):
r"""The index position of the media item.""" r"""The index position of the media item."""
key: str key: str
r"""The unique key for the media item.""" r"""The unique key for the media item."""
library_section_id: int
r"""The identifier for the library section."""
library_section_key: str
r"""The key corresponding to the library section."""
library_section_title: str
r"""The title of the library section."""
originally_available_at: date
r"""The original release date of the media item."""
parent_studio: str parent_studio: str
r"""The studio of the parent media item.""" r"""The studio of the parent media item."""
parent_theme: str parent_theme: str
@@ -1277,8 +1261,16 @@ class GetRecentlyAddedMetadataTypedDict(TypedDict):
r"""Unix timestamp for when the media item was last viewed.""" r"""Unix timestamp for when the media item was last viewed."""
leaf_count: NotRequired[int] leaf_count: NotRequired[int]
r"""The number of leaf items (end nodes) under this media item.""" r"""The number of leaf items (end nodes) under this media item."""
library_section_id: NotRequired[int]
r"""The identifier for the library section."""
library_section_key: NotRequired[str]
r"""The key corresponding to the library section."""
library_section_title: NotRequired[str]
r"""The title of the library section."""
original_title: NotRequired[str] original_title: NotRequired[str]
r"""The original title of the media item (if different).""" r"""The original title of the media item (if different)."""
originally_available_at: NotRequired[date]
r"""The original release date of the media item."""
parent_guid: NotRequired[str] parent_guid: NotRequired[str]
r"""The GUID of the parent media item.""" r"""The GUID of the parent media item."""
parent_index: NotRequired[int] parent_index: NotRequired[int]
@@ -1359,20 +1351,6 @@ class GetRecentlyAddedMetadata(BaseModel):
key: str key: str
r"""The unique key for the media item.""" r"""The unique key for the media item."""
library_section_id: Annotated[int, pydantic.Field(alias="librarySectionID")]
r"""The identifier for the library section."""
library_section_key: Annotated[str, pydantic.Field(alias="librarySectionKey")]
r"""The key corresponding to the library section."""
library_section_title: Annotated[str, pydantic.Field(alias="librarySectionTitle")]
r"""The title of the library section."""
originally_available_at: Annotated[
date, pydantic.Field(alias="originallyAvailableAt")
]
r"""The original release date of the media item."""
parent_studio: Annotated[str, pydantic.Field(alias="parentStudio")] parent_studio: Annotated[str, pydantic.Field(alias="parentStudio")]
r"""The studio of the parent media item.""" r"""The studio of the parent media item."""
@@ -1487,11 +1465,31 @@ class GetRecentlyAddedMetadata(BaseModel):
leaf_count: Annotated[Optional[int], pydantic.Field(alias="leafCount")] = None leaf_count: Annotated[Optional[int], pydantic.Field(alias="leafCount")] = None
r"""The number of leaf items (end nodes) under this media item.""" r"""The number of leaf items (end nodes) under this media item."""
library_section_id: Annotated[
Optional[int], pydantic.Field(alias="librarySectionID")
] = None
r"""The identifier for the library section."""
library_section_key: Annotated[
Optional[str], pydantic.Field(alias="librarySectionKey")
] = None
r"""The key corresponding to the library section."""
library_section_title: Annotated[
Optional[str], pydantic.Field(alias="librarySectionTitle")
] = None
r"""The title of the library section."""
original_title: Annotated[Optional[str], pydantic.Field(alias="originalTitle")] = ( original_title: Annotated[Optional[str], pydantic.Field(alias="originalTitle")] = (
None None
) )
r"""The original title of the media item (if different).""" r"""The original title of the media item (if different)."""
originally_available_at: Annotated[
Optional[date], pydantic.Field(alias="originallyAvailableAt")
] = None
r"""The original release date of the media item."""
parent_guid: Annotated[Optional[str], pydantic.Field(alias="parentGuid")] = None parent_guid: Annotated[Optional[str], pydantic.Field(alias="parentGuid")] = None
r"""The GUID of the parent media item.""" r"""The GUID of the parent media item."""

Some files were not shown because too many files have changed in this diff Show More