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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.513.4

Browse Source
This commit is contained in:
speakeasybot
2025-03-10 00:02:43 +00:00
parent 9382496b13
commit 277b3890c7
72 changed files with 1671 additions and 2311 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
.speakeasy/gen.lock
View File

File diff suppressed because one or more lines are too long

2
.speakeasy/gen.yaml
View File

@@ -15,7 +15,7 @@ generation:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
python:
version: 0.24.0
version: 0.24.1
additionalDependencies:
dev: {}
main: {}

12
.speakeasy/workflow.lock
View File

@@ -8,19 +8,19 @@ sources:
- latest
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:bf7001af017ce5072c503bfbaf60793f94549163b517489dc53e4f7b685659c0
sourceBlobDigest: sha256:ed2b29043c84f32d2efa92a126083fd9a81644a7ce9c6ac86d9aeb3493cbd6f8
sourceRevisionDigest: sha256:2066ba94b55e21d651c79003e3cf402fb77c52a0969fc52310b3383fbed038f4
sourceBlobDigest: sha256:1737023e29cd9cf36c07ccd8c8c48c47e14f47ce22b4d6ba9ee241afbbd8f351
tags:
- latest
- speakeasy-sdk-regen-1741392085
- speakeasy-sdk-regen-1741564888
targets:
plexpy:
source: plexapi
sourceNamespace: plexapi
sourceRevisionDigest: sha256:bf7001af017ce5072c503bfbaf60793f94549163b517489dc53e4f7b685659c0
sourceBlobDigest: sha256:ed2b29043c84f32d2efa92a126083fd9a81644a7ce9c6ac86d9aeb3493cbd6f8
sourceRevisionDigest: sha256:2066ba94b55e21d651c79003e3cf402fb77c52a0969fc52310b3383fbed038f4
sourceBlobDigest: sha256:1737023e29cd9cf36c07ccd8c8c48c47e14f47ce22b4d6ba9ee241afbbd8f351
codeSamplesNamespace: code-samples-python-plexpy
codeSamplesRevisionDigest: sha256:409d05f3fbbabe4d7f85ab58a2f14287c524e610e99207650bdab9dc0f6ad72d
codeSamplesRevisionDigest: sha256:acbb4d2076c0f7319d1fd652e302723e8e6d7db2131bc721448e654c64f4b45c
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest

1
README.md
View File

@@ -227,7 +227,6 @@ asyncio.run(main())
* [get_media_meta_data](docs/sdks/library/README.md#get_media_meta_data) - Get Media Metadata
* [get_metadata_children](docs/sdks/library/README.md#get_metadata_children) - Get Items Children
* [get_top_watched_content](docs/sdks/library/README.md#get_top_watched_content) - Get Top Watched Content
* [get_on_deck](docs/sdks/library/README.md#get_on_deck) - Get On Deck
### [log](docs/sdks/log/README.md)

10
RELEASES.md
View File

@@ -959,3 +959,13 @@ Based on:
- [python v0.24.0] .
### Releases
- [PyPI v0.24.0] https://pypi.org/project/plex-api-client/0.24.0 - .
## 2025-03-10 00:01:12
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.513.4 (2.545.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v0.24.1] .
### Releases
- [PyPI v0.24.1] https://pypi.org/project/plex-api-client/0.24.1 - .

19
codeSamples.yaml
View File

@@ -637,25 +637,6 @@ actions:
# Handle response
print(res.response_stream)
- target: $["paths"]["/library/onDeck"]["get"]
update:
x-codeSamples:
- lang: python
label: getOnDeck
source: |-
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
res = plex_api.library.get_on_deck()
assert res.object is not None
# Handle response
print(res.object)
- target: $["paths"]["/library/recentlyAdded"]["get"]
update:
x-codeSamples:

11
docs/models/errors/getondeckbadrequest.md
View File

@@ -1,11 +0,0 @@
# GetOnDeckBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `errors` | List[[errors.GetOnDeckErrors](../../models/errors/getondeckerrors.md)] | :heavy_minus_sign: | N/A |
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

10
docs/models/errors/getondeckerrors.md
View File

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

10
docs/models/errors/getondecklibraryerrors.md
View File

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

11
docs/models/errors/getondeckunauthorized.md
View File

@@ -1,11 +0,0 @@
# GetOnDeckUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `errors` | List[[errors.GetOnDeckLibraryErrors](../../models/errors/getondecklibraryerrors.md)] | :heavy_minus_sign: | N/A |
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

4
docs/models/operations/collection.md
View File

@@ -4,5 +4,5 @@
## Fields
| 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 |

8
docs/models/operations/country.md
View File

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

4
docs/models/operations/director.md
View File

@@ -4,5 +4,5 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | James Cameron |
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
| `tag` | *str* | :heavy_check_mark: | The role of Director | Danny Boyle |

8
docs/models/operations/genre.md
View File

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

4
docs/models/operations/getallmedialibrarygenre.md
View File

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

8
docs/models/operations/getallmedialibraryguids.md Normal file
View File

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

4
docs/models/operations/getallmedialibrarymedia.md
View File

@@ -6,8 +6,6 @@
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `has_voice_activity` | *bool* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
| `part` | List[[operations.GetAllMediaLibraryPart](../../models/operations/getallmedialibrarypart.md)] | :heavy_check_mark: | An array of parts for this media item. | |
| `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 |
| `width` | *Optional[int]* | :heavy_minus_sign: | Video width in pixels. | 3840 |
@@ -21,6 +19,8 @@
| `container` | *Optional[str]* | :heavy_minus_sign: | File container type. | mkv |
| `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 |
| `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 |
| `optimized_for_streaming` | [Optional[operations.GetAllMediaLibraryOptimizedForStreaming]](../../models/operations/getallmedialibraryoptimizedforstreaming.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 |
| `part` | List[[operations.GetAllMediaLibraryPart](../../models/operations/getallmedialibrarypart.md)] | :heavy_minus_sign: | An array of parts for this media item. | |

4
docs/models/operations/getallmedialibrarymetadata.md
View File

@@ -18,7 +18,6 @@ Unknown
| `summary` | *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/> |
| `rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
| `audience_rating` | *float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `year` | *int* | :heavy_check_mark: | The release year of the media item. | 2022 |
| `tagline` | *str* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
| `thumb` | *str* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
| `art` | *str* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
@@ -31,6 +30,7 @@ Unknown
| `added_at` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `studio` | *Optional[str]* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
| `year` | *Optional[int]* | :heavy_minus_sign: | The release year of the media item. | 2022 |
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `viewed_leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
@@ -70,5 +70,5 @@ Unknown
| `director` | List[[operations.GetAllMediaLibraryDirector](../../models/operations/getallmedialibrarydirector.md)] | :heavy_minus_sign: | N/A | |
| `writer` | List[[operations.GetAllMediaLibraryWriter](../../models/operations/getallmedialibrarywriter.md)] | :heavy_minus_sign: | N/A | |
| `role` | List[[operations.GetAllMediaLibraryRole](../../models/operations/getallmedialibraryrole.md)] | :heavy_minus_sign: | N/A | |
| `guids` | List[[operations.Guids](../../models/operations/guids.md)] | :heavy_minus_sign: | N/A | |
| `guids` | List[[operations.GetAllMediaLibraryGuids](../../models/operations/getallmedialibraryguids.md)] | :heavy_minus_sign: | N/A | |
| `collection` | List[[operations.GetAllMediaLibraryCollection](../../models/operations/getallmedialibrarycollection.md)] | :heavy_minus_sign: | N/A | |

4
docs/models/operations/getallmedialibraryoptimizedforstreaming.md
View File

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

4
docs/models/operations/getallmedialibraryrole.md
View File

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

8
docs/models/operations/getallmedialibrarystream.md
View File

@@ -9,13 +9,13 @@
| `stream_type` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
| `codec` | *str* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
| `language` | *str* | :heavy_check_mark: | Language of the stream. | English |
| `language_tag` | *str* | :heavy_check_mark: | Language tag (e.g., en). | en |
| `language_code` | *str* | :heavy_check_mark: | ISO language code. | eng |
| `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) |
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `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_code` | *Optional[str]* | :heavy_minus_sign: | ISO language code. | eng |
| `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_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
@@ -30,6 +30,7 @@
| `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_width` | *Optional[int]* | :heavy_minus_sign: | Coded video width. | 3840 |
| `closed_captions` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `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_space` | *Optional[str]* | :heavy_minus_sign: | Color space. | bt2020nc |
@@ -41,6 +42,7 @@
| `has_scaling_matrix` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `profile` | *Optional[str]* | :heavy_minus_sign: | Video profile. | main 10 |
| `scan_type` | *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 |
| `width` | *Optional[int]* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `selected` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |

2
docs/models/operations/getallmedialibrarywriter.md
View File

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

11
docs/models/operations/getlibraryitemsenablecreditsmarkergeneration.md
View File

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

12
docs/models/operations/getlibraryitemsepisodesort.md
View File

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

12
docs/models/operations/getlibraryitemsflattenseasons.md
View File

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

8
docs/models/operations/getlibraryitemsmediaguid.md
View File

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

12
docs/models/operations/getlibraryitemsmetadata.md
View File

@@ -24,10 +24,10 @@
| `year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
| `season_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
| `tagline` | *Optional[str]* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `flatten_seasons` | [Optional[operations.GetLibraryItemsFlattenSeasons]](../../models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
| `episode_sort` | [Optional[operations.GetLibraryItemsEpisodeSort]](../../models/operations/getlibraryitemsepisodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
| `enable_credits_marker_generation` | [Optional[operations.GetLibraryItemsEnableCreditsMarkerGeneration]](../../models/operations/getlibraryitemsenablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
| `show_ordering` | [Optional[operations.GetLibraryItemsShowOrdering]](../../models/operations/getlibraryitemsshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
| `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 |
| `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 |
| `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 |
| `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 |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `banner` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
@@ -55,9 +55,9 @@
| `collection` | List[[operations.GetLibraryItemsCollection](../../models/operations/getlibraryitemscollection.md)] | :heavy_minus_sign: | N/A | |
| `role` | List[[operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)] | :heavy_minus_sign: | N/A | |
| `location` | List[[operations.GetLibraryItemsLocation](../../models/operations/getlibraryitemslocation.md)] | :heavy_minus_sign: | N/A | |
| `media_guid` | List[[operations.GetLibraryItemsMediaGUID](../../models/operations/getlibraryitemsmediaguid.md)] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `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/> | |
| `ultra_blur_colors` | [Optional[operations.GetLibraryItemsUltraBlurColors]](../../models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `meta_data_rating` | List[[operations.GetLibraryItemsMetaDataRating](../../models/operations/getlibraryitemsmetadatarating.md)] | :heavy_minus_sign: | N/A | |
| `meta_data_rating` | List[[operations.MetaDataRating](../../models/operations/metadatarating.md)] | :heavy_minus_sign: | N/A | |
| `image` | List[[operations.GetLibraryItemsImage](../../models/operations/getlibraryitemsimage.md)] | :heavy_minus_sign: | N/A | |
| `title_sort` | *Optional[str]* | :heavy_minus_sign: | N/A | Whale |
| `view_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |

10
docs/models/operations/getlibraryitemsmetadatarating.md
View File

@@ -1,10 +0,0 @@
# GetLibraryItemsMetaDataRating
## 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 |

20
docs/models/operations/getlibraryitemsshowordering.md
View File

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

4
docs/models/operations/getmediametadatalibraryoptimizedforstreaming.md
View File

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

4
docs/models/operations/getmediametadatamedia.md
View File

@@ -6,8 +6,6 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `has_voice_activity` | *bool* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
| `part` | List[[operations.GetMediaMetaDataPart](../../models/operations/getmediametadatapart.md)] | :heavy_check_mark: | An array of parts for this media item. | |
| `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 |
| `width` | *Optional[int]* | :heavy_minus_sign: | Video width in pixels. | 3840 |
@@ -21,6 +19,8 @@
| `container` | *Optional[str]* | :heavy_minus_sign: | File container type. | mkv |
| `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 |
| `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 |
| `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 |
| `part` | List[[operations.GetMediaMetaDataPart](../../models/operations/getmediametadatapart.md)] | :heavy_minus_sign: | An array of parts for this media item. | |

4
docs/models/operations/getmediametadatametadata.md
View File

@@ -63,6 +63,6 @@
| `role` | List[[operations.GetMediaMetaDataRole](../../models/operations/getmediametadatarole.md)] | :heavy_minus_sign: | An array of Actor roles. | |
| `director` | List[[operations.GetMediaMetaDataDirector](../../models/operations/getmediametadatadirector.md)] | :heavy_minus_sign: | An array of Director roles. | |
| `writer` | List[[operations.GetMediaMetaDataWriter](../../models/operations/getmediametadatawriter.md)] | :heavy_minus_sign: | An array of Writer roles. | |
| `producer` | List[[operations.Producer](../../models/operations/producer.md)] | :heavy_minus_sign: | An array of Writer roles. | |
| `similar` | List[[operations.Similar](../../models/operations/similar.md)] | :heavy_minus_sign: | An array of similar content objects. | |
| `producer` | List[[operations.GetMediaMetaDataProducer](../../models/operations/getmediametadataproducer.md)] | :heavy_minus_sign: | An array of Writer roles. | |
| `similar` | List[[operations.GetMediaMetaDataSimilar](../../models/operations/getmediametadatasimilar.md)] | :heavy_minus_sign: | An array of similar content objects. | |
| `location` | List[[operations.GetMediaMetaDataLocation](../../models/operations/getmediametadatalocation.md)] | :heavy_minus_sign: | An array of location objects. | |

4
docs/models/operations/getmediametadataoptimizedforstreaming.md
View File

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

9
docs/models/operations/getmediametadataoptimizedforstreaminglibrary1.md Normal file
View File

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

13
docs/models/operations/getmediametadataproducer.md Normal file
View File

@@ -0,0 +1,13 @@
# GetMediaMetaDataProducer
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique role identifier. | 109501 |
| `filter_` | *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 |

10
docs/models/operations/getmediametadatasimilar.md Normal file
View File

@@ -0,0 +1,10 @@
# GetMediaMetaDataSimilar
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique similar item identifier. | 26 |
| `filter_` | *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 |

8
docs/models/operations/getmediametadatastream.md
View File

@@ -9,13 +9,13 @@
| `stream_type` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
| `codec` | *str* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
| `language` | *str* | :heavy_check_mark: | Language of the stream. | English |
| `language_tag` | *str* | :heavy_check_mark: | Language tag (e.g., en). | en |
| `language_code` | *str* | :heavy_check_mark: | ISO language code. | eng |
| `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) |
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `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_code` | *Optional[str]* | :heavy_minus_sign: | ISO language code. | eng |
| `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_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
@@ -30,6 +30,7 @@
| `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_width` | *Optional[int]* | :heavy_minus_sign: | Coded video width. | 3840 |
| `closed_captions` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `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_space` | *Optional[str]* | :heavy_minus_sign: | Color space. | bt2020nc |
@@ -41,6 +42,7 @@
| `has_scaling_matrix` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `profile` | *Optional[str]* | :heavy_minus_sign: | Video profile. | main 10 |
| `scan_type` | *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 |
| `width` | *Optional[int]* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `selected` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |

8
docs/models/operations/getondeckguids.md
View File

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

22
docs/models/operations/getondeckmedia.md
View File

@@ -1,22 +0,0 @@
# GetOnDeckMedia
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `id` | *Optional[float]* | :heavy_minus_sign: | N/A | 80994 |
| `duration` | *Optional[float]* | :heavy_minus_sign: | N/A | 420080 |
| `bitrate` | *Optional[float]* | :heavy_minus_sign: | N/A | 1046 |
| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | 1920 |
| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | 1080 |
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | N/A | 1.78 |
| `audio_channels` | *Optional[float]* | :heavy_minus_sign: | N/A | 2 |
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | aac |
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | hevc |
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | N/A | 1080 |
| `container` | *Optional[str]* | :heavy_minus_sign: | N/A | mkv |
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | N/A | PAL |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | lc |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main |
| `part` | List[[operations.GetOnDeckPart](../../models/operations/getondeckpart.md)] | :heavy_minus_sign: | N/A | |

14
docs/models/operations/getondeckmediacontainer.md
View File

@@ -1,14 +0,0 @@
# GetOnDeckMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `size` | *Optional[float]* | :heavy_minus_sign: | N/A | 16 |
| `allow_sync` | *Optional[bool]* | :heavy_minus_sign: | N/A | |
| `identifier` | *Optional[str]* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `media_tag_prefix` | *Optional[str]* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `media_tag_version` | *Optional[float]* | :heavy_minus_sign: | N/A | 1680021154 |
| `mixed_parents` | *Optional[bool]* | :heavy_minus_sign: | N/A | |
| `metadata` | List[[operations.GetOnDeckMetadata](../../models/operations/getondeckmetadata.md)] | :heavy_minus_sign: | N/A | |

43
docs/models/operations/getondeckmetadata.md
View File

@@ -1,43 +0,0 @@
# GetOnDeckMetadata
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `allow_sync` | *Optional[bool]* | :heavy_minus_sign: | N/A | |
| `library_section_id` | *Optional[float]* | :heavy_minus_sign: | N/A | 2 |
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | N/A | TV Shows |
| `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | N/A | 4bb2521c-8ba9-459b-aaee-8ab8bc35eabd |
| `rating_key` | *Optional[float]* | :heavy_minus_sign: | N/A | 49564 |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/49564 |
| `parent_rating_key` | *Optional[float]* | :heavy_minus_sign: | N/A | 49557 |
| `grandparent_rating_key` | *Optional[float]* | :heavy_minus_sign: | N/A | 49556 |
| `guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://episode/5ea7d7402e7ab10042e74d4f |
| `parent_guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://season/602e754d67f4c8002ce54b3d |
| `grandparent_guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://show/5d9c090e705e7a001e6e94d8 |
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | episode |
| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Circus |
| `grandparent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/49556 |
| `parent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/49557 |
| `library_section_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/2 |
| `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Bluey (2018) |
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Season 2 |
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | N/A | TV-Y |
| `summary` | *Optional[str]* | :heavy_minus_sign: | N/A | Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy. |
| `index` | *Optional[float]* | :heavy_minus_sign: | N/A | 33 |
| `parent_index` | *Optional[float]* | :heavy_minus_sign: | N/A | 2 |
| `last_viewed_at` | *Optional[float]* | :heavy_minus_sign: | N/A | 1681908352 |
| `year` | *Optional[float]* | :heavy_minus_sign: | N/A | 2018 |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/49564/thumb/1654258204 |
| `art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/49556/art/1680939546 |
| `parent_thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/49557/thumb/1654258204 |
| `grandparent_thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/49556/thumb/1680939546 |
| `grandparent_art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/49556/art/1680939546 |
| `grandparent_theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/49556/theme/1680939546 |
| `duration` | *Optional[float]* | :heavy_minus_sign: | N/A | 420080 |
| `originally_available_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | 2020-10-31 00:00:00 +0000 UTC |
| `added_at` | *Optional[float]* | :heavy_minus_sign: | N/A | 1654258196 |
| `updated_at` | *Optional[float]* | :heavy_minus_sign: | N/A | 1654258204 |
| `media` | List[[operations.GetOnDeckMedia](../../models/operations/getondeckmedia.md)] | :heavy_minus_sign: | N/A | |
| `guids` | List[[operations.GetOnDeckGuids](../../models/operations/getondeckguids.md)] | :heavy_minus_sign: | N/A | |

16
docs/models/operations/getondeckpart.md
View File

@@ -1,16 +0,0 @@
# GetOnDeckPart
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| `id` | *Optional[float]* | :heavy_minus_sign: | N/A | 80994 |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/parts/80994/1655007810/file.mkv |
| `duration` | *Optional[float]* | :heavy_minus_sign: | N/A | 420080 |
| `file` | *Optional[str]* | :heavy_minus_sign: | N/A | /tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv |
| `size` | *Optional[float]* | :heavy_minus_sign: | N/A | 55148931 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | lc |
| `container` | *Optional[str]* | :heavy_minus_sign: | N/A | mkv |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main |
| `stream` | List[[operations.GetOnDeckStream](../../models/operations/getondeckstream.md)] | :heavy_minus_sign: | N/A | |

11
docs/models/operations/getondeckresponse.md
View File

@@ -1,11 +0,0 @@
# GetOnDeckResponse
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional[operations.GetOnDeckResponseBody]](../../models/operations/getondeckresponsebody.md) | :heavy_minus_sign: | The on Deck content |

10
docs/models/operations/getondeckresponsebody.md
View File

@@ -1,10 +0,0 @@
# GetOnDeckResponseBody
The on Deck content
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `media_container` | [Optional[operations.GetOnDeckMediaContainer]](../../models/operations/getondeckmediacontainer.md) | :heavy_minus_sign: | N/A |

30
docs/models/operations/getondeckstream.md
View File

@@ -1,30 +0,0 @@
# GetOnDeckStream
## Fields
| Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `id` | *Optional[float]* | :heavy_minus_sign: | N/A | 211234 |
| `stream_type` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 |
| `default` | *Optional[bool]* | :heavy_minus_sign: | N/A | |
| `codec` | *Optional[str]* | :heavy_minus_sign: | N/A | hevc |
| `index` | *Optional[float]* | :heavy_minus_sign: | N/A | 0 |
| `bitrate` | *Optional[float]* | :heavy_minus_sign: | N/A | 918 |
| `language` | *Optional[str]* | :heavy_minus_sign: | N/A | English |
| `language_tag` | *Optional[str]* | :heavy_minus_sign: | N/A | en |
| `language_code` | *Optional[str]* | :heavy_minus_sign: | N/A | eng |
| `bit_depth` | *Optional[float]* | :heavy_minus_sign: | N/A | 8 |
| `chroma_location` | *Optional[str]* | :heavy_minus_sign: | N/A | left |
| `chroma_subsampling` | *Optional[str]* | :heavy_minus_sign: | N/A | 4:2:0 |
| `coded_height` | *Optional[float]* | :heavy_minus_sign: | N/A | 1080 |
| `coded_width` | *Optional[float]* | :heavy_minus_sign: | N/A | 1920 |
| `color_range` | *Optional[str]* | :heavy_minus_sign: | N/A | tv |
| `frame_rate` | *Optional[float]* | :heavy_minus_sign: | N/A | 25 |
| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | 1080 |
| `level` | *Optional[float]* | :heavy_minus_sign: | N/A | 120 |
| `profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main |
| `ref_frames` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 |
| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | 1920 |
| `display_title` | *Optional[str]* | :heavy_minus_sign: | N/A | 1080p (HEVC Main) |
| `extended_display_title` | *Optional[str]* | :heavy_minus_sign: | N/A | 1080p (HEVC Main) |

12
docs/models/operations/getrecentlyaddedmediacontainer.md
View File

@@ -5,10 +5,10 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `size` | *int* | :heavy_check_mark: | N/A | 50 |
| `offset` | *Optional[int]* | :heavy_minus_sign: | N/A | |
| `total_size` | *Optional[int]* | :heavy_minus_sign: | N/A | |
| `identifier` | *Optional[str]* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `allow_sync` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `total_size` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
| `offset` | *int* | :heavy_check_mark: | Offset value for pagination. | 0 |
| `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 |
| `meta` | [Optional[operations.Meta]](../../models/operations/meta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
| `metadata` | List[[operations.GetRecentlyAddedMetadata](../../models/operations/getrecentlyaddedmetadata.md)] | :heavy_minus_sign: | N/A | |
| `metadata` | List[[operations.GetRecentlyAddedMetadata](../../models/operations/getrecentlyaddedmetadata.md)] | :heavy_minus_sign: | An array of metadata items. | |

142
docs/models/operations/getrecentlyaddedmetadata.md
View File

@@ -1,83 +1,85 @@
# GetRecentlyAddedMetadata
Unknown
## Fields
| 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 |
| `key` | *str* | :heavy_check_mark: | N/A | /library/metadata/58683 |
| `guid` | *str* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
| `type` | [operations.GetRecentlyAddedHubsType](../../models/operations/getrecentlyaddedhubstype.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `title` | *str* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `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. |
| `added_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `studio` | *Optional[str]* | :heavy_minus_sign: | N/A | 20th Century Studios |
| `skip_children` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Movies |
| `library_section_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `slug` | *Optional[str]* | :heavy_minus_sign: | N/A | 4-for-texas |
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | N/A | PG-13 |
| `rating` | *Optional[float]* | :heavy_minus_sign: | N/A | 7.6 |
| `audience_rating` | *Optional[float]* | :heavy_minus_sign: | N/A | 9.2 |
| `year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
| `season_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
| `tagline` | *Optional[str]* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `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 |
| `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 |
| `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 |
| `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 |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `banner` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
| `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 |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `added_at` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `art` | *str* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
| `audience_rating` | *float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `child_count` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
| `guid` | *str* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
| `index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
| `key` | *str* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
| `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 |
| `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 |
| `parent_studio` | *str* | :heavy_check_mark: | The studio of the parent media item. | UCP |
| `parent_theme` | *str* | :heavy_check_mark: | The theme URL for the parent media item. | /library/metadata/66/theme/1705716261 |
| `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 |
| `rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
| `season_count` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
| `slug` | *str* | :heavy_check_mark: | A URL‐friendly version of the media title. | 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/> |
| `tagline` | *str* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
| `theme` | *str* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
| `thumb` | *str* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
| `title_sort` | *str* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
| `title` | *str* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
| `type` | [operations.GetRecentlyAddedHubsType](../../models/operations/getrecentlyaddedhubstype.md) | :heavy_check_mark: | N/A | movie |
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
| `chapter_source` | *Optional[str]* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
| `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 |
| `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 |
| `grandparent_art` | *Optional[str]* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
| `grandparent_guid` | *Optional[str]* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparent_key` | *Optional[str]* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
| `grandparent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
| `grandparent_slug` | *Optional[str]* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
| `grandparent_theme` | *Optional[str]* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
| `grandparent_thumb` | *Optional[str]* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
| `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
| `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 |
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `original_title` | *Optional[str]* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
| `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_key` | *Optional[str]* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
| `parent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
| `parent_slug` | *Optional[str]* | :heavy_minus_sign: | The slug for the parent media item. | alice-in-borderland-2020 |
| `parent_thumb` | *Optional[str]* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
| `parent_year` | *Optional[int]* | :heavy_minus_sign: | The release year of the parent media item. | 2010 |
| `primary_extra_key` | *Optional[str]* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
| `rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
| `skip_count` | *Optional[int]* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
| `studio` | *Optional[str]* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `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 |
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `chapter_source` | *Optional[str]* | :heavy_minus_sign: | N/A | media |
| `primary_extra_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
| `rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
| `grandparent_rating_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 66 |
| `grandparent_guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66 |
| `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Caprica |
| `grandparent_thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `parent_slug` | *Optional[str]* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
| `grandparent_slug` | *Optional[str]* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
| `grandparent_art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
| `grandparent_theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
| `media` | List[[operations.Media](../../models/operations/media.md)] | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
| `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: | The number of times this media item has been viewed. | 1 |
| `view_offset` | *Optional[int]* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
| `viewed_leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
| `year` | *Optional[int]* | :heavy_minus_sign: | The release year of the media item. | 2022 |
| `image` | List[[operations.GetRecentlyAddedImage](../../models/operations/getrecentlyaddedimage.md)] | :heavy_minus_sign: | N/A | |
| `ultra_blur_colors` | [Optional[operations.UltraBlurColors]](../../models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `media` | List[[operations.Media](../../models/operations/media.md)] | :heavy_minus_sign: | N/A | |
| `genre` | List[[operations.Genre](../../models/operations/genre.md)] | :heavy_minus_sign: | N/A | |
| `country` | List[[operations.Country](../../models/operations/country.md)] | :heavy_minus_sign: | N/A | |
| `director` | List[[operations.Director](../../models/operations/director.md)] | :heavy_minus_sign: | N/A | |
| `writer` | List[[operations.Writer](../../models/operations/writer.md)] | :heavy_minus_sign: | N/A | |
| `collection` | List[[operations.Collection](../../models/operations/collection.md)] | :heavy_minus_sign: | N/A | |
| `role` | List[[operations.Role](../../models/operations/role.md)] | :heavy_minus_sign: | N/A | |
| `producer` | List[[operations.Producer](../../models/operations/producer.md)] | :heavy_minus_sign: | N/A | |
| `rating1` | List[[operations.Rating](../../models/operations/rating.md)] | :heavy_minus_sign: | N/A | |
| `similar` | List[[operations.Similar](../../models/operations/similar.md)] | :heavy_minus_sign: | N/A | |
| `location` | List[[operations.Location](../../models/operations/location.md)] | :heavy_minus_sign: | N/A | |
| `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/> | |
| `ultra_blur_colors` | [Optional[operations.UltraBlurColors]](../../models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `meta_data_rating` | List[[operations.MetaDataRating](../../models/operations/metadatarating.md)] | :heavy_minus_sign: | N/A | |
| `image` | List[[operations.GetRecentlyAddedImage](../../models/operations/getrecentlyaddedimage.md)] | :heavy_minus_sign: | N/A | |
| `title_sort` | *Optional[str]* | :heavy_minus_sign: | N/A | Whale |
| `view_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1682752242 |
| `original_title` | *Optional[str]* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
| `view_offset` | *Optional[int]* | :heavy_minus_sign: | N/A | 5222500 |
| `skip_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 14 |
| `viewed_leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 0 |
| `child_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `has_premium_extras` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
| `has_premium_primary_extra` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
| `parent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
| `parent_guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
| `parent_studio` | *Optional[str]* | :heavy_minus_sign: | N/A | UCP |
| `parent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66 |
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Caprica |
| `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 |
| `guids` | List[[operations.Guids](../../models/operations/guids.md)] | :heavy_minus_sign: | N/A | |
| `collection` | List[[operations.Collection](../../models/operations/collection.md)] | :heavy_minus_sign: | N/A | |

19
docs/models/operations/getrecentlyaddedoptimizedforstreaming.md Normal file
View File

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

9
docs/models/operations/getrecentlyaddedoptimizedforstreaming1.md Normal file
View File

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

2
docs/models/operations/hasthumbnail.md
View File

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

6
docs/models/operations/location.md
View File

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

35
docs/models/operations/media.md
View File

@@ -5,21 +5,22 @@
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
| `container` | *str* | :heavy_check_mark: | N/A | mkv |
| `part` | List[[operations.Part](../../models/operations/part.md)] | :heavy_check_mark: | N/A | |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | N/A | 25025 |
| `width` | *Optional[int]* | :heavy_minus_sign: | N/A | 3840 |
| `height` | *Optional[int]* | :heavy_minus_sign: | N/A | 2072 |
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | N/A | 1.85 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts |
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | N/A | 6 |
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | eac3 |
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | hevc |
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | N/A | 4k |
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | N/A | 24p |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main 10 |
| `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | [Optional[operations.OptimizedForStreaming]](../../models/operations/optimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `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 |
| `width` | *Optional[int]* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `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 |
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `display_offset` | *Optional[int]* | :heavy_minus_sign: | N/A | 50 |
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | Audio codec used. | eac3 |
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | Video codec used. | hevc |
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `container` | *Optional[str]* | :heavy_minus_sign: | File container type. | mkv |
| `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 |
| `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 |
| `optimized_for_streaming` | [Optional[operations.OptimizedForStreaming]](../../models/operations/optimizedforstreaming.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 |
| `part` | List[[operations.Part](../../models/operations/part.md)] | :heavy_minus_sign: | An array of parts for this media item. | |

20
docs/models/operations/optimizedforstreaming.md
View File

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

27
docs/models/operations/part.md
View File

@@ -4,17 +4,20 @@
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119542 |
| `key` | *str* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
| `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 |
| `size` | *int* | :heavy_check_mark: | N/A | 36158371307 |
| `container` | *str* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main 10 |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `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 |
| `file` | *str* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `accessible` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `exists` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
| `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `packet_length` | *Optional[int]* | :heavy_minus_sign: | N/A | 188 |
| `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 |
| `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.GetRecentlyAddedOptimizedForStreaming]](../../models/operations/getrecentlyaddedoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has_thumbnail` | [Optional[operations.HasThumbnail]](../../models/operations/hasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | List[[operations.Stream](../../models/operations/stream.md)] | :heavy_minus_sign: | N/A | |
| `stream` | List[[operations.Stream](../../models/operations/stream.md)] | :heavy_minus_sign: | An array of streams for this part. | |

13
docs/models/operations/producer.md
View File

@@ -4,10 +4,9 @@
## 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 |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique identifier for the producer. | 126522 |
| `filter_` | *str* | :heavy_check_mark: | The filter string used to query this producer. | producer=126522 |
| `tag` | *str* | :heavy_check_mark: | The name of the producer | Amelia Knapp |
| `tag_key` | *Optional[str]* | :heavy_minus_sign: | A unique key associated with the producer's tag, used for internal identification. | 5d77683d85719b001f3a535e |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |

12
docs/models/operations/rating.md Normal file
View File

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

14
docs/models/operations/role.md
View File

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

10
docs/models/operations/similar.md
View File

@@ -1,10 +1,12 @@
# Similar
The display tag for the similar item, typically the title.
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique similar item identifier. | 26 |
| `filter_` | *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 |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 259 |
| `filter_` | *str* | :heavy_check_mark: | N/A | similar=259 |
| `tag` | *str* | :heavy_check_mark: | N/A | Criss Angel Mindfreak |

89
docs/models/operations/stream.md
View File

@@ -4,42 +4,53 @@
## 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 |
| `codec` | *str* | :heavy_check_mark: | Codec used by the stream | h264 |
| `index` | *int* | :heavy_check_mark: | The index of the stream | 0 |
| `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 |
| `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 |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `stream_type` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
| `codec` | *str* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
| `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) |
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `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_code` | *Optional[str]* | :heavy_minus_sign: | ISO language code. | eng |
| `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_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 |
| `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_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 |
| `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 |
| `chroma_location` | *Optional[str]* | :heavy_minus_sign: | Chroma sample location. | topleft |
| `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_width` | *Optional[int]* | :heavy_minus_sign: | Coded video width. | 3840 |
| `closed_captions` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `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_space` | *Optional[str]* | :heavy_minus_sign: | Color space. | bt2020nc |
| `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 |
| `height` | *Optional[int]* | :heavy_minus_sign: | Height of the video stream. | 1602 |
| `level` | *Optional[int]* | :heavy_minus_sign: | Video level. | 150 |
| `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 |
| `profile` | *Optional[str]* | :heavy_minus_sign: | Video profile. | main 10 |
| `scan_type` | *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 |
| `width` | *Optional[int]* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `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 |
| `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) |
| `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 |
| `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 |
| `title` | *Optional[str]* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |

7
docs/models/operations/writer.md
View File

@@ -4,5 +4,8 @@
## Fields
| 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 |
| `filter_` | *str* | :heavy_check_mark: | The filter string used to query this writer. | writer=126522 |
| `tag` | *str* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
| `tag_key` | *Optional[str]* | :heavy_minus_sign: | A unique key associated with the writers tag, used for internal identification. | 5d77683d85719b001f3a535e |

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

@@ -24,7 +24,6 @@ API Calls interacting with Plex Media Server Libraries
* [get_media_meta_data](#get_media_meta_data) - Get Media Metadata
* [get_metadata_children](#get_metadata_children) - Get Items Children
* [get_top_watched_content](#get_top_watched_content) - Get Top Watched Content
* [get_on_deck](#get_on_deck) - Get On Deck
## get_file_hash
@@ -855,45 +854,3 @@ with PlexAPI(
| errors.GetTopWatchedContentBadRequest | 400 | application/json |
| errors.GetTopWatchedContentUnauthorized | 401 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## get_on_deck
This endpoint will return the on deck content.
### Example Usage
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
res = plex_api.library.get_on_deck()
assert res.object is not None
# Handle response
print(res.object)
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
### Response
**[operations.GetOnDeckResponse](../../models/operations/getondeckresponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ---------------------------- | ---------------------------- | ---------------------------- |
| errors.GetOnDeckBadRequest | 400 | application/json |
| errors.GetOnDeckUnauthorized | 401 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |

2
pyproject.toml
View File

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

4
src/plex_api_client/_version.py
View File

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

210
src/plex_api_client/library.py
View File

@@ -3814,213 +3814,3 @@ class Library(BaseSDK):
http_res_text,
http_res,
)
def get_on_deck(
self,
*,
retries: OptionalNullable[utils.RetryConfig] = UNSET,
server_url: Optional[str] = None,
timeout_ms: Optional[int] = None,
http_headers: Optional[Mapping[str, str]] = None,
) -> operations.GetOnDeckResponse:
r"""Get On Deck
This endpoint will return the on deck content.
:param retries: Override the default retry configuration for this method
:param server_url: Override the default server URL for this method
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
:param http_headers: Additional headers to set or replace on requests.
"""
base_url = None
url_variables = None
if timeout_ms is None:
timeout_ms = self.sdk_configuration.timeout_ms
if server_url is not None:
base_url = server_url
else:
base_url = self._get_url(base_url, url_variables)
req = self._build_request(
method="GET",
path="/library/onDeck",
base_url=base_url,
url_variables=url_variables,
request=None,
request_body_required=False,
request_has_path_params=False,
request_has_query_params=True,
user_agent_header="user-agent",
accept_header_value="application/json",
http_headers=http_headers,
security=self.sdk_configuration.security,
timeout_ms=timeout_ms,
)
if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config
retry_config = None
if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"])
http_res = self.do_request(
hook_ctx=HookContext(
base_url=base_url or "",
operation_id="getOnDeck",
oauth2_scopes=[],
security_source=self.sdk_configuration.security,
),
request=req,
error_status_codes=["400", "401", "4XX", "5XX"],
retry_config=retry_config,
)
response_data: Any = None
if utils.match_response(http_res, "200", "application/json"):
return operations.GetOnDeckResponse(
object=utils.unmarshal_json(
http_res.text, Optional[operations.GetOnDeckResponseBody]
),
status_code=http_res.status_code,
content_type=http_res.headers.get("Content-Type") or "",
raw_response=http_res,
)
if utils.match_response(http_res, "400", "application/json"):
response_data = utils.unmarshal_json(
http_res.text, errors.GetOnDeckBadRequestData
)
response_data.raw_response = http_res
raise errors.GetOnDeckBadRequest(data=response_data)
if utils.match_response(http_res, "401", "application/json"):
response_data = utils.unmarshal_json(
http_res.text, errors.GetOnDeckUnauthorizedData
)
response_data.raw_response = http_res
raise errors.GetOnDeckUnauthorized(data=response_data)
if utils.match_response(http_res, "4XX", "*"):
http_res_text = utils.stream_to_text(http_res)
raise errors.SDKError(
"API error occurred", http_res.status_code, http_res_text, http_res
)
if utils.match_response(http_res, "5XX", "*"):
http_res_text = utils.stream_to_text(http_res)
raise errors.SDKError(
"API error occurred", http_res.status_code, http_res_text, http_res
)
content_type = http_res.headers.get("Content-Type")
http_res_text = utils.stream_to_text(http_res)
raise errors.SDKError(
f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
http_res.status_code,
http_res_text,
http_res,
)
async def get_on_deck_async(
self,
*,
retries: OptionalNullable[utils.RetryConfig] = UNSET,
server_url: Optional[str] = None,
timeout_ms: Optional[int] = None,
http_headers: Optional[Mapping[str, str]] = None,
) -> operations.GetOnDeckResponse:
r"""Get On Deck
This endpoint will return the on deck content.
:param retries: Override the default retry configuration for this method
:param server_url: Override the default server URL for this method
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
:param http_headers: Additional headers to set or replace on requests.
"""
base_url = None
url_variables = None
if timeout_ms is None:
timeout_ms = self.sdk_configuration.timeout_ms
if server_url is not None:
base_url = server_url
else:
base_url = self._get_url(base_url, url_variables)
req = self._build_request_async(
method="GET",
path="/library/onDeck",
base_url=base_url,
url_variables=url_variables,
request=None,
request_body_required=False,
request_has_path_params=False,
request_has_query_params=True,
user_agent_header="user-agent",
accept_header_value="application/json",
http_headers=http_headers,
security=self.sdk_configuration.security,
timeout_ms=timeout_ms,
)
if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config
retry_config = None
if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"])
http_res = await self.do_request_async(
hook_ctx=HookContext(
base_url=base_url or "",
operation_id="getOnDeck",
oauth2_scopes=[],
security_source=self.sdk_configuration.security,
),
request=req,
error_status_codes=["400", "401", "4XX", "5XX"],
retry_config=retry_config,
)
response_data: Any = None
if utils.match_response(http_res, "200", "application/json"):
return operations.GetOnDeckResponse(
object=utils.unmarshal_json(
http_res.text, Optional[operations.GetOnDeckResponseBody]
),
status_code=http_res.status_code,
content_type=http_res.headers.get("Content-Type") or "",
raw_response=http_res,
)
if utils.match_response(http_res, "400", "application/json"):
response_data = utils.unmarshal_json(
http_res.text, errors.GetOnDeckBadRequestData
)
response_data.raw_response = http_res
raise errors.GetOnDeckBadRequest(data=response_data)
if utils.match_response(http_res, "401", "application/json"):
response_data = utils.unmarshal_json(
http_res.text, errors.GetOnDeckUnauthorizedData
)
response_data.raw_response = http_res
raise errors.GetOnDeckUnauthorized(data=response_data)
if utils.match_response(http_res, "4XX", "*"):
http_res_text = await utils.stream_to_text_async(http_res)
raise errors.SDKError(
"API error occurred", http_res.status_code, http_res_text, http_res
)
if utils.match_response(http_res, "5XX", "*"):
http_res_text = await utils.stream_to_text_async(http_res)
raise errors.SDKError(
"API error occurred", http_res.status_code, http_res_text, http_res
)
content_type = http_res.headers.get("Content-Type")
http_res_text = await utils.stream_to_text_async(http_res)
raise errors.SDKError(
f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
http_res.status_code,
http_res_text,
http_res,
)

18
src/plex_api_client/models/errors/__init__.py
View File

@@ -394,16 +394,6 @@ from .getmyplexaccount import (
GetMyPlexAccountUnauthorized,
GetMyPlexAccountUnauthorizedData,
)
from .getondeck import (
GetOnDeckBadRequest,
GetOnDeckBadRequestData,
GetOnDeckErrors,
GetOnDeckErrorsTypedDict,
GetOnDeckLibraryErrors,
GetOnDeckLibraryErrorsTypedDict,
GetOnDeckUnauthorized,
GetOnDeckUnauthorizedData,
)
from .getpin import (
GetPinBadRequest,
GetPinBadRequestData,
@@ -1044,14 +1034,6 @@ __all__ = [
"GetMyPlexAccountServerErrorsTypedDict",
"GetMyPlexAccountUnauthorized",
"GetMyPlexAccountUnauthorizedData",
"GetOnDeckBadRequest",
"GetOnDeckBadRequestData",
"GetOnDeckErrors",
"GetOnDeckErrorsTypedDict",
"GetOnDeckLibraryErrors",
"GetOnDeckLibraryErrorsTypedDict",
"GetOnDeckUnauthorized",
"GetOnDeckUnauthorizedData",
"GetPinBadRequest",
"GetPinBadRequestData",
"GetPinErrors",

79
src/plex_api_client/models/errors/getondeck.py
View File

@@ -1,79 +0,0 @@
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
from __future__ import annotations
import httpx
from plex_api_client import utils
from plex_api_client.types import BaseModel
import pydantic
from typing import List, Optional
from typing_extensions import Annotated, NotRequired, TypedDict
class GetOnDeckLibraryErrorsTypedDict(TypedDict):
code: NotRequired[int]
message: NotRequired[str]
status: NotRequired[int]
class GetOnDeckLibraryErrors(BaseModel):
code: Optional[int] = None
message: Optional[str] = None
status: Optional[int] = None
class GetOnDeckUnauthorizedData(BaseModel):
errors: Optional[List[GetOnDeckLibraryErrors]] = None
raw_response: Annotated[Optional[httpx.Response], pydantic.Field(exclude=True)] = (
None
)
r"""Raw HTTP response; suitable for custom response parsing"""
class GetOnDeckUnauthorized(Exception):
r"""Unauthorized - Returned if the X-Plex-Token is missing from the header or query."""
data: GetOnDeckUnauthorizedData
def __init__(self, data: GetOnDeckUnauthorizedData):
self.data = data
def __str__(self) -> str:
return utils.marshal_json(self.data, GetOnDeckUnauthorizedData)
class GetOnDeckErrorsTypedDict(TypedDict):
code: NotRequired[int]
message: NotRequired[str]
status: NotRequired[int]
class GetOnDeckErrors(BaseModel):
code: Optional[int] = None
message: Optional[str] = None
status: Optional[int] = None
class GetOnDeckBadRequestData(BaseModel):
errors: Optional[List[GetOnDeckErrors]] = None
raw_response: Annotated[Optional[httpx.Response], pydantic.Field(exclude=True)] = (
None
)
r"""Raw HTTP response; suitable for custom response parsing"""
class GetOnDeckBadRequest(Exception):
r"""Bad Request - A parameter was not specified, or was specified incorrectly."""
data: GetOnDeckBadRequestData
def __init__(self, data: GetOnDeckBadRequestData):
self.data = data
def __str__(self) -> str:
return utils.marshal_json(self.data, GetOnDeckBadRequestData)

108
src/plex_api_client/models/operations/__init__.py
View File

@@ -111,6 +111,8 @@ from .get_all_media_library import (
GetAllMediaLibraryFilterTypedDict,
GetAllMediaLibraryGenre,
GetAllMediaLibraryGenreTypedDict,
GetAllMediaLibraryGuids,
GetAllMediaLibraryGuidsTypedDict,
GetAllMediaLibraryHasThumbnail,
GetAllMediaLibraryImage,
GetAllMediaLibraryImageTypedDict,
@@ -153,10 +155,8 @@ from .get_all_media_library import (
GetAllMediaLibraryUltraBlurColorsTypedDict,
GetAllMediaLibraryWriter,
GetAllMediaLibraryWriterTypedDict,
Guids,
GuidsTypedDict,
IncludeAdvanced,
One,
OptimizedForStreaming1,
QueryParamIncludeCollections,
QueryParamIncludeExternalMedia,
QueryParamIncludeGuids,
@@ -219,6 +219,9 @@ from .get_library_details import (
IncludeDetails,
)
from .get_library_items import (
EnableCreditsMarkerGeneration,
EpisodeSort,
FlattenSeasons,
GetLibraryItemsActiveDirection,
GetLibraryItemsCollection,
GetLibraryItemsCollectionTypedDict,
@@ -227,15 +230,12 @@ from .get_library_items import (
GetLibraryItemsDefaultDirection,
GetLibraryItemsDirector,
GetLibraryItemsDirectorTypedDict,
GetLibraryItemsEnableCreditsMarkerGeneration,
GetLibraryItemsEpisodeSort,
GetLibraryItemsField,
GetLibraryItemsFieldType,
GetLibraryItemsFieldTypeTypedDict,
GetLibraryItemsFieldTypedDict,
GetLibraryItemsFilter,
GetLibraryItemsFilterTypedDict,
GetLibraryItemsFlattenSeasons,
GetLibraryItemsGenre,
GetLibraryItemsGenreTypedDict,
GetLibraryItemsHasThumbnail,
@@ -262,12 +262,8 @@ from .get_library_items import (
GetLibraryItemsMedia,
GetLibraryItemsMediaContainer,
GetLibraryItemsMediaContainerTypedDict,
GetLibraryItemsMediaGUID,
GetLibraryItemsMediaGUIDTypedDict,
GetLibraryItemsMediaTypedDict,
GetLibraryItemsMeta,
GetLibraryItemsMetaDataRating,
GetLibraryItemsMetaDataRatingTypedDict,
GetLibraryItemsMetaTypedDict,
GetLibraryItemsMetadata,
GetLibraryItemsMetadataTypedDict,
@@ -286,7 +282,6 @@ from .get_library_items import (
GetLibraryItemsResponseTypedDict,
GetLibraryItemsRole,
GetLibraryItemsRoleTypedDict,
GetLibraryItemsShowOrdering,
GetLibraryItemsSort,
GetLibraryItemsSortTypedDict,
GetLibraryItemsStream,
@@ -298,6 +293,11 @@ from .get_library_items import (
GetLibraryItemsWriter,
GetLibraryItemsWriterTypedDict,
IncludeGuids,
MediaGUID,
MediaGUIDTypedDict,
MetaDataRating,
MetaDataRatingTypedDict,
ShowOrdering,
Tag,
)
from .get_media_meta_data import (
@@ -324,9 +324,12 @@ from .get_media_meta_data import (
GetMediaMetaDataMetadataTypedDict,
GetMediaMetaDataOptimizedForStreaming,
GetMediaMetaDataOptimizedForStreaming1,
GetMediaMetaDataOptimizedForStreamingLibrary1,
GetMediaMetaDataOptimizedForStreamingTypedDict,
GetMediaMetaDataPart,
GetMediaMetaDataPartTypedDict,
GetMediaMetaDataProducer,
GetMediaMetaDataProducerTypedDict,
GetMediaMetaDataRequest,
GetMediaMetaDataRequestTypedDict,
GetMediaMetaDataResponse,
@@ -335,19 +338,16 @@ from .get_media_meta_data import (
GetMediaMetaDataResponseTypedDict,
GetMediaMetaDataRole,
GetMediaMetaDataRoleTypedDict,
GetMediaMetaDataSimilar,
GetMediaMetaDataSimilarTypedDict,
GetMediaMetaDataStream,
GetMediaMetaDataStreamTypedDict,
GetMediaMetaDataUltraBlurColors,
GetMediaMetaDataUltraBlurColorsTypedDict,
GetMediaMetaDataWriter,
GetMediaMetaDataWriterTypedDict,
OptimizedForStreaming1,
Producer,
ProducerTypedDict,
Ratings,
RatingsTypedDict,
Similar,
SimilarTypedDict,
)
from .get_media_providers import (
Action,
@@ -376,9 +376,6 @@ from .get_recently_added import (
CountryTypedDict,
Director,
DirectorTypedDict,
EnableCreditsMarkerGeneration,
EpisodeSort,
FlattenSeasons,
Genre,
GenreTypedDict,
GetRecentlyAddedActiveDirection,
@@ -399,6 +396,9 @@ from .get_recently_added import (
GetRecentlyAddedMetadataTypedDict,
GetRecentlyAddedOperator,
GetRecentlyAddedOperatorTypedDict,
GetRecentlyAddedOptimizedForStreaming,
GetRecentlyAddedOptimizedForStreaming1,
GetRecentlyAddedOptimizedForStreamingTypedDict,
GetRecentlyAddedRequest,
GetRecentlyAddedRequestTypedDict,
GetRecentlyAddedResponse,
@@ -409,24 +409,29 @@ from .get_recently_added import (
GetRecentlyAddedSortTypedDict,
GetRecentlyAddedType,
GetRecentlyAddedTypeTypedDict,
Guids,
GuidsTypedDict,
HasThumbnail,
IncludeMeta,
Location,
LocationTypedDict,
Media,
MediaGUID,
MediaGUIDTypedDict,
MediaTypedDict,
Meta,
MetaDataRating,
MetaDataRatingTypedDict,
MetaTypedDict,
One,
OptimizedForStreaming,
OptimizedForStreamingTypedDict,
Part,
PartTypedDict,
Producer,
ProducerTypedDict,
Rating,
RatingTypedDict,
Role,
RoleTypedDict,
ShowOrdering,
Similar,
SimilarTypedDict,
Stream,
StreamTypedDict,
Type,
@@ -760,24 +765,6 @@ from .getmyplexaccount import (
MyPlex,
MyPlexTypedDict,
)
from .getondeck import (
GetOnDeckGuids,
GetOnDeckGuidsTypedDict,
GetOnDeckMedia,
GetOnDeckMediaContainer,
GetOnDeckMediaContainerTypedDict,
GetOnDeckMediaTypedDict,
GetOnDeckMetadata,
GetOnDeckMetadataTypedDict,
GetOnDeckPart,
GetOnDeckPartTypedDict,
GetOnDeckResponse,
GetOnDeckResponseBody,
GetOnDeckResponseBodyTypedDict,
GetOnDeckResponseTypedDict,
GetOnDeckStream,
GetOnDeckStreamTypedDict,
)
from .getpin import (
GET_PIN_SERVERS,
GeoData,
@@ -1362,6 +1349,8 @@ __all__ = [
"GetAllMediaLibraryFilterTypedDict",
"GetAllMediaLibraryGenre",
"GetAllMediaLibraryGenreTypedDict",
"GetAllMediaLibraryGuids",
"GetAllMediaLibraryGuidsTypedDict",
"GetAllMediaLibraryHasThumbnail",
"GetAllMediaLibraryImage",
"GetAllMediaLibraryImageTypedDict",
@@ -1538,15 +1527,12 @@ __all__ = [
"GetLibraryItemsDefaultDirection",
"GetLibraryItemsDirector",
"GetLibraryItemsDirectorTypedDict",
"GetLibraryItemsEnableCreditsMarkerGeneration",
"GetLibraryItemsEpisodeSort",
"GetLibraryItemsField",
"GetLibraryItemsFieldType",
"GetLibraryItemsFieldTypeTypedDict",
"GetLibraryItemsFieldTypedDict",
"GetLibraryItemsFilter",
"GetLibraryItemsFilterTypedDict",
"GetLibraryItemsFlattenSeasons",
"GetLibraryItemsGenre",
"GetLibraryItemsGenreTypedDict",
"GetLibraryItemsHasThumbnail",
@@ -1573,12 +1559,8 @@ __all__ = [
"GetLibraryItemsMedia",
"GetLibraryItemsMediaContainer",
"GetLibraryItemsMediaContainerTypedDict",
"GetLibraryItemsMediaGUID",
"GetLibraryItemsMediaGUIDTypedDict",
"GetLibraryItemsMediaTypedDict",
"GetLibraryItemsMeta",
"GetLibraryItemsMetaDataRating",
"GetLibraryItemsMetaDataRatingTypedDict",
"GetLibraryItemsMetaTypedDict",
"GetLibraryItemsMetadata",
"GetLibraryItemsMetadataTypedDict",
@@ -1597,7 +1579,6 @@ __all__ = [
"GetLibraryItemsResponseTypedDict",
"GetLibraryItemsRole",
"GetLibraryItemsRoleTypedDict",
"GetLibraryItemsShowOrdering",
"GetLibraryItemsSort",
"GetLibraryItemsSortTypedDict",
"GetLibraryItemsStream",
@@ -1631,9 +1612,12 @@ __all__ = [
"GetMediaMetaDataMetadataTypedDict",
"GetMediaMetaDataOptimizedForStreaming",
"GetMediaMetaDataOptimizedForStreaming1",
"GetMediaMetaDataOptimizedForStreamingLibrary1",
"GetMediaMetaDataOptimizedForStreamingTypedDict",
"GetMediaMetaDataPart",
"GetMediaMetaDataPartTypedDict",
"GetMediaMetaDataProducer",
"GetMediaMetaDataProducerTypedDict",
"GetMediaMetaDataRequest",
"GetMediaMetaDataRequestTypedDict",
"GetMediaMetaDataResponse",
@@ -1642,6 +1626,8 @@ __all__ = [
"GetMediaMetaDataResponseTypedDict",
"GetMediaMetaDataRole",
"GetMediaMetaDataRoleTypedDict",
"GetMediaMetaDataSimilar",
"GetMediaMetaDataSimilarTypedDict",
"GetMediaMetaDataStream",
"GetMediaMetaDataStreamTypedDict",
"GetMediaMetaDataUltraBlurColors",
@@ -1674,22 +1660,6 @@ __all__ = [
"GetMyPlexAccountResponseBody",
"GetMyPlexAccountResponseBodyTypedDict",
"GetMyPlexAccountResponseTypedDict",
"GetOnDeckGuids",
"GetOnDeckGuidsTypedDict",
"GetOnDeckMedia",
"GetOnDeckMediaContainer",
"GetOnDeckMediaContainerTypedDict",
"GetOnDeckMediaTypedDict",
"GetOnDeckMetadata",
"GetOnDeckMetadataTypedDict",
"GetOnDeckPart",
"GetOnDeckPartTypedDict",
"GetOnDeckResponse",
"GetOnDeckResponseBody",
"GetOnDeckResponseBodyTypedDict",
"GetOnDeckResponseTypedDict",
"GetOnDeckStream",
"GetOnDeckStreamTypedDict",
"GetPinAuthPinContainer",
"GetPinAuthPinContainerTypedDict",
"GetPinRequest",
@@ -1787,6 +1757,9 @@ __all__ = [
"GetRecentlyAddedMetadataTypedDict",
"GetRecentlyAddedOperator",
"GetRecentlyAddedOperatorTypedDict",
"GetRecentlyAddedOptimizedForStreaming",
"GetRecentlyAddedOptimizedForStreaming1",
"GetRecentlyAddedOptimizedForStreamingTypedDict",
"GetRecentlyAddedRequest",
"GetRecentlyAddedRequestTypedDict",
"GetRecentlyAddedResponse",
@@ -2113,6 +2086,7 @@ __all__ = [
"OperatorTypedDict",
"OptimizedForStreaming",
"OptimizedForStreaming1",
"OptimizedForStreamingTypedDict",
"Owned",
"POST_USERS_SIGN_IN_DATA_SERVERS",
"Part",
@@ -2178,6 +2152,8 @@ __all__ = [
"QueryParamOnlyTransient",
"QueryParamSmart",
"QueryParamType",
"Rating",
"RatingTypedDict",
"Ratings",
"RatingsTypedDict",
"Release",

103
src/plex_api_client/models/operations/get_all_media_library.py
View File

@@ -412,19 +412,20 @@ class GetAllMediaLibraryUltraBlurColors(BaseModel):
bottom_left: Annotated[str, pydantic.Field(alias="bottomLeft")]
class One(int, Enum):
class OptimizedForStreaming1(int, Enum):
ZERO = 0
ONE = 1
GetAllMediaLibraryOptimizedForStreamingTypedDict = TypeAliasType(
"GetAllMediaLibraryOptimizedForStreamingTypedDict", Union[One, bool]
"GetAllMediaLibraryOptimizedForStreamingTypedDict",
Union[OptimizedForStreaming1, bool],
)
r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true"""
GetAllMediaLibraryOptimizedForStreaming = TypeAliasType(
"GetAllMediaLibraryOptimizedForStreaming", Union[One, bool]
"GetAllMediaLibraryOptimizedForStreaming", Union[OptimizedForStreaming1, bool]
)
r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true"""
@@ -464,12 +465,6 @@ class GetAllMediaLibraryStreamTypedDict(TypedDict):
r"""Codec used by the stream."""
index: int
r"""Index of the stream."""
language: str
r"""Language of the stream."""
language_tag: str
r"""Language tag (e.g., en)."""
language_code: str
r"""ISO language code."""
display_title: str
r"""Display title for the stream."""
extended_display_title: str
@@ -478,6 +473,12 @@ class GetAllMediaLibraryStreamTypedDict(TypedDict):
r"""Indicates if this stream is default."""
bitrate: NotRequired[int]
r"""Bitrate of the stream."""
language: NotRequired[str]
r"""Language of the stream."""
language_tag: NotRequired[str]
r"""Language tag (e.g., en)."""
language_code: NotRequired[str]
r"""ISO language code."""
header_compression: NotRequired[bool]
r"""Indicates whether header compression is enabled."""
dovibl_compat_id: NotRequired[int]
@@ -506,6 +507,7 @@ class GetAllMediaLibraryStreamTypedDict(TypedDict):
r"""Coded video height."""
coded_width: NotRequired[int]
r"""Coded video width."""
closed_captions: NotRequired[bool]
color_primaries: NotRequired[str]
r"""Color primaries used."""
color_range: NotRequired[str]
@@ -526,6 +528,7 @@ class GetAllMediaLibraryStreamTypedDict(TypedDict):
profile: NotRequired[str]
r"""Video profile."""
scan_type: NotRequired[str]
embedded_in_video: NotRequired[str]
ref_frames: NotRequired[int]
r"""Number of reference frames."""
width: NotRequired[int]
@@ -562,15 +565,6 @@ class GetAllMediaLibraryStream(BaseModel):
index: int
r"""Index of the stream."""
language: str
r"""Language of the stream."""
language_tag: Annotated[str, pydantic.Field(alias="languageTag")]
r"""Language tag (e.g., en)."""
language_code: Annotated[str, pydantic.Field(alias="languageCode")]
r"""ISO language code."""
display_title: Annotated[str, pydantic.Field(alias="displayTitle")]
r"""Display title for the stream."""
@@ -583,6 +577,15 @@ class GetAllMediaLibraryStream(BaseModel):
bitrate: Optional[int] = None
r"""Bitrate of the stream."""
language: Optional[str] = None
r"""Language of the stream."""
language_tag: Annotated[Optional[str], pydantic.Field(alias="languageTag")] = None
r"""Language tag (e.g., en)."""
language_code: Annotated[Optional[str], pydantic.Field(alias="languageCode")] = None
r"""ISO language code."""
header_compression: Annotated[
Optional[bool], pydantic.Field(alias="headerCompression")
] = None
@@ -639,6 +642,10 @@ class GetAllMediaLibraryStream(BaseModel):
coded_width: Annotated[Optional[int], pydantic.Field(alias="codedWidth")] = None
r"""Coded video width."""
closed_captions: Annotated[
Optional[bool], pydantic.Field(alias="closedCaptions")
] = None
color_primaries: Annotated[
Optional[str], pydantic.Field(alias="colorPrimaries")
] = None
@@ -674,6 +681,10 @@ class GetAllMediaLibraryStream(BaseModel):
scan_type: Annotated[Optional[str], pydantic.Field(alias="scanType")] = None
embedded_in_video: Annotated[
Optional[str], pydantic.Field(alias="embeddedInVideo")
] = None
ref_frames: Annotated[Optional[int], pydantic.Field(alias="refFrames")] = None
r"""Number of reference frames."""
@@ -802,10 +813,6 @@ class GetAllMediaLibraryPart(BaseModel):
class GetAllMediaLibraryMediaTypedDict(TypedDict):
id: int
r"""Unique media identifier."""
has_voice_activity: bool
r"""Indicates whether voice activity is detected."""
part: List[GetAllMediaLibraryPartTypedDict]
r"""An array of parts for this media item."""
duration: NotRequired[int]
r"""Duration of the media in milliseconds."""
bitrate: NotRequired[int]
@@ -833,6 +840,8 @@ class GetAllMediaLibraryMediaTypedDict(TypedDict):
"""
video_profile: NotRequired[str]
r"""Video profile (e.g., main 10)."""
has_voice_activity: NotRequired[bool]
r"""Indicates whether voice activity is detected."""
audio_profile: NotRequired[str]
r"""The audio profile used for the media (e.g., DTS, Dolby Digital, etc.)."""
optimized_for_streaming: NotRequired[
@@ -840,18 +849,14 @@ class GetAllMediaLibraryMediaTypedDict(TypedDict):
]
r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true"""
has64bit_offsets: NotRequired[bool]
part: NotRequired[List[GetAllMediaLibraryPartTypedDict]]
r"""An array of parts for this media item."""
class GetAllMediaLibraryMedia(BaseModel):
id: int
r"""Unique media identifier."""
has_voice_activity: Annotated[bool, pydantic.Field(alias="hasVoiceActivity")]
r"""Indicates whether voice activity is detected."""
part: Annotated[List[GetAllMediaLibraryPart], pydantic.Field(alias="Part")]
r"""An array of parts for this media item."""
duration: Optional[int] = None
r"""Duration of the media in milliseconds."""
@@ -900,6 +905,11 @@ class GetAllMediaLibraryMedia(BaseModel):
video_profile: Annotated[Optional[str], pydantic.Field(alias="videoProfile")] = None
r"""Video profile (e.g., main 10)."""
has_voice_activity: Annotated[
Optional[bool], pydantic.Field(alias="hasVoiceActivity")
] = None
r"""Indicates whether voice activity is detected."""
audio_profile: Annotated[Optional[str], pydantic.Field(alias="audioProfile")] = None
r"""The audio profile used for the media (e.g., DTS, Dolby Digital, etc.)."""
@@ -913,15 +923,24 @@ class GetAllMediaLibraryMedia(BaseModel):
Optional[bool], pydantic.Field(alias="has64bitOffsets")
] = None
part: Annotated[
Optional[List[GetAllMediaLibraryPart]], pydantic.Field(alias="Part")
] = None
r"""An array of parts for this media item."""
class GetAllMediaLibraryGenreTypedDict(TypedDict):
tag: str
r"""The country of origin of this media item"""
r"""The genre name of this media-item
"""
class GetAllMediaLibraryGenre(BaseModel):
tag: str
r"""The country of origin of this media item"""
r"""The genre name of this media-item
"""
class GetAllMediaLibraryCountryTypedDict(TypedDict):
@@ -956,22 +975,22 @@ class GetAllMediaLibraryWriter(BaseModel):
class GetAllMediaLibraryRoleTypedDict(TypedDict):
tag: str
r"""The name of the actor for this role"""
r"""The display tag for the actor (typically the actor's name)."""
class GetAllMediaLibraryRole(BaseModel):
tag: str
r"""The name of the actor for this role"""
r"""The display tag for the actor (typically the actor's name)."""
class GuidsTypedDict(TypedDict):
class GetAllMediaLibraryGuidsTypedDict(TypedDict):
id: NotRequired[str]
r"""The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337
"""
class Guids(BaseModel):
class GetAllMediaLibraryGuids(BaseModel):
id: Optional[str] = None
r"""The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337
@@ -1010,8 +1029,6 @@ class GetAllMediaLibraryMetadataTypedDict(TypedDict):
r"""The critic rating for the media item."""
audience_rating: float
r"""The audience rating for the media item."""
year: int
r"""The release year of the media item."""
tagline: str
r"""A brief tagline for the media item."""
thumb: str
@@ -1035,6 +1052,8 @@ class GetAllMediaLibraryMetadataTypedDict(TypedDict):
r"""The studio that produced the media item."""
content_rating: NotRequired[str]
r"""The content rating for the media item."""
year: NotRequired[int]
r"""The release year of the media item."""
leaf_count: NotRequired[int]
r"""The number of leaf items (end nodes) under this media item."""
viewed_leaf_count: NotRequired[int]
@@ -1105,7 +1124,7 @@ class GetAllMediaLibraryMetadataTypedDict(TypedDict):
director: NotRequired[List[GetAllMediaLibraryDirectorTypedDict]]
writer: NotRequired[List[GetAllMediaLibraryWriterTypedDict]]
role: NotRequired[List[GetAllMediaLibraryRoleTypedDict]]
guids: NotRequired[List[GuidsTypedDict]]
guids: NotRequired[List[GetAllMediaLibraryGuidsTypedDict]]
collection: NotRequired[List[GetAllMediaLibraryCollectionTypedDict]]
@@ -1141,9 +1160,6 @@ class GetAllMediaLibraryMetadata(BaseModel):
audience_rating: Annotated[float, pydantic.Field(alias="audienceRating")]
r"""The audience rating for the media item."""
year: int
r"""The release year of the media item."""
tagline: str
r"""A brief tagline for the media item."""
@@ -1183,6 +1199,9 @@ class GetAllMediaLibraryMetadata(BaseModel):
)
r"""The content rating for the media item."""
year: Optional[int] = None
r"""The release year of the media item."""
leaf_count: Annotated[Optional[int], pydantic.Field(alias="leafCount")] = None
r"""The number of leaf items (end nodes) under this media item."""
@@ -1343,7 +1362,9 @@ class GetAllMediaLibraryMetadata(BaseModel):
Optional[List[GetAllMediaLibraryRole]], pydantic.Field(alias="Role")
] = None
guids: Annotated[Optional[List[Guids]], pydantic.Field(alias="Guid")] = None
guids: Annotated[
Optional[List[GetAllMediaLibraryGuids]], pydantic.Field(alias="Guid")
] = None
collection: Annotated[
Optional[List[GetAllMediaLibraryCollection]], pydantic.Field(alias="Collection")

46
src/plex_api_client/models/operations/get_library_items.py
View File

@@ -345,7 +345,7 @@ class GetLibraryItemsLibraryType(str, Enum):
ALBUM = "album"
class GetLibraryItemsFlattenSeasons(str, Enum):
class FlattenSeasons(str, Enum):
r"""Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show)."""
LIBRARY_DEFAULT = "-1"
@@ -353,7 +353,7 @@ class GetLibraryItemsFlattenSeasons(str, Enum):
SHOW = "1"
class GetLibraryItemsEpisodeSort(str, Enum):
class EpisodeSort(str, Enum):
r"""Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first)."""
LIBRARY_DEFAULT = "-1"
@@ -361,14 +361,14 @@ class GetLibraryItemsEpisodeSort(str, Enum):
NEWEST_FIRST = "1"
class GetLibraryItemsEnableCreditsMarkerGeneration(str, Enum):
class EnableCreditsMarkerGeneration(str, Enum):
r"""Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled)."""
LIBRARY_DEFAULT = "-1"
DISABLED = "0"
class GetLibraryItemsShowOrdering(str, Enum):
class ShowOrdering(str, Enum):
r"""Setting that indicates the episode ordering for the show.
None = Library default,
tmdbAiring = The Movie Database (Aired),
@@ -815,7 +815,7 @@ class GetLibraryItemsLocation(BaseModel):
path: Optional[str] = None
class GetLibraryItemsMediaGUIDTypedDict(TypedDict):
class MediaGUIDTypedDict(TypedDict):
id: str
r"""Can be one of the following formats:
imdb://tt13015952, tmdb://2434012, tvdb://7945991
@@ -823,7 +823,7 @@ class GetLibraryItemsMediaGUIDTypedDict(TypedDict):
"""
class GetLibraryItemsMediaGUID(BaseModel):
class MediaGUID(BaseModel):
id: str
r"""Can be one of the following formats:
imdb://tt13015952, tmdb://2434012, tvdb://7945991
@@ -848,7 +848,7 @@ class GetLibraryItemsUltraBlurColors(BaseModel):
bottom_left: Annotated[str, pydantic.Field(alias="bottomLeft")]
class GetLibraryItemsMetaDataRatingTypedDict(TypedDict):
class MetaDataRatingTypedDict(TypedDict):
image: str
r"""A URI or path to the rating image."""
value: float
@@ -857,7 +857,7 @@ class GetLibraryItemsMetaDataRatingTypedDict(TypedDict):
r"""The type of rating (e.g., audience, critic)."""
class GetLibraryItemsMetaDataRating(BaseModel):
class MetaDataRating(BaseModel):
image: str
r"""A URI or path to the rating image."""
@@ -917,15 +917,13 @@ class GetLibraryItemsMetadataTypedDict(TypedDict):
year: NotRequired[int]
season_count: NotRequired[int]
tagline: NotRequired[str]
flatten_seasons: NotRequired[GetLibraryItemsFlattenSeasons]
flatten_seasons: NotRequired[FlattenSeasons]
r"""Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show)."""
episode_sort: NotRequired[GetLibraryItemsEpisodeSort]
episode_sort: NotRequired[EpisodeSort]
r"""Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first)."""
enable_credits_marker_generation: NotRequired[
GetLibraryItemsEnableCreditsMarkerGeneration
]
enable_credits_marker_generation: NotRequired[EnableCreditsMarkerGeneration]
r"""Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled)."""
show_ordering: NotRequired[GetLibraryItemsShowOrdering]
show_ordering: NotRequired[ShowOrdering]
r"""Setting that indicates the episode ordering for the show.
None = Library default,
tmdbAiring = The Movie Database (Aired),
@@ -965,12 +963,12 @@ class GetLibraryItemsMetadataTypedDict(TypedDict):
collection: NotRequired[List[GetLibraryItemsCollectionTypedDict]]
role: NotRequired[List[GetLibraryItemsRoleTypedDict]]
location: NotRequired[List[GetLibraryItemsLocationTypedDict]]
media_guid: NotRequired[List[GetLibraryItemsMediaGUIDTypedDict]]
media_guid: NotRequired[List[MediaGUIDTypedDict]]
r"""The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.
"""
ultra_blur_colors: NotRequired[GetLibraryItemsUltraBlurColorsTypedDict]
meta_data_rating: NotRequired[List[GetLibraryItemsMetaDataRatingTypedDict]]
meta_data_rating: NotRequired[List[MetaDataRatingTypedDict]]
image: NotRequired[List[GetLibraryItemsImageTypedDict]]
title_sort: NotRequired[str]
view_count: NotRequired[int]
@@ -1059,23 +1057,23 @@ class GetLibraryItemsMetadata(BaseModel):
tagline: Optional[str] = None
flatten_seasons: Annotated[
Optional[GetLibraryItemsFlattenSeasons], pydantic.Field(alias="flattenSeasons")
Optional[FlattenSeasons], pydantic.Field(alias="flattenSeasons")
] = None
r"""Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show)."""
episode_sort: Annotated[
Optional[GetLibraryItemsEpisodeSort], pydantic.Field(alias="episodeSort")
Optional[EpisodeSort], pydantic.Field(alias="episodeSort")
] = None
r"""Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first)."""
enable_credits_marker_generation: Annotated[
Optional[GetLibraryItemsEnableCreditsMarkerGeneration],
Optional[EnableCreditsMarkerGeneration],
pydantic.Field(alias="enableCreditsMarkerGeneration"),
] = None
r"""Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled)."""
show_ordering: Annotated[
Optional[GetLibraryItemsShowOrdering], pydantic.Field(alias="showOrdering")
Optional[ShowOrdering], pydantic.Field(alias="showOrdering")
] = None
r"""Setting that indicates the episode ordering for the show.
None = Library default,
@@ -1184,9 +1182,9 @@ class GetLibraryItemsMetadata(BaseModel):
Optional[List[GetLibraryItemsLocation]], pydantic.Field(alias="Location")
] = None
media_guid: Annotated[
Optional[List[GetLibraryItemsMediaGUID]], pydantic.Field(alias="Guid")
] = None
media_guid: Annotated[Optional[List[MediaGUID]], pydantic.Field(alias="Guid")] = (
None
)
r"""The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.
"""
@@ -1197,7 +1195,7 @@ class GetLibraryItemsMetadata(BaseModel):
] = None
meta_data_rating: Annotated[
Optional[List[GetLibraryItemsMetaDataRating]], pydantic.Field(alias="Rating")
Optional[List[MetaDataRating]], pydantic.Field(alias="Rating")
] = None
image: Annotated[

99
src/plex_api_client/models/operations/get_media_meta_data.py
View File

@@ -142,39 +142,40 @@ class GetMediaMetaDataRequest(BaseModel):
r"""Trigger asynchronous refresh of the local media agent."""
class OptimizedForStreaming1(int, Enum):
class GetMediaMetaDataOptimizedForStreaming1(int, Enum):
ZERO = 0
ONE = 1
GetMediaMetaDataOptimizedForStreamingTypedDict = TypeAliasType(
"GetMediaMetaDataOptimizedForStreamingTypedDict",
Union[OptimizedForStreaming1, bool],
Union[GetMediaMetaDataOptimizedForStreaming1, bool],
)
r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true"""
GetMediaMetaDataOptimizedForStreaming = TypeAliasType(
"GetMediaMetaDataOptimizedForStreaming", Union[OptimizedForStreaming1, bool]
"GetMediaMetaDataOptimizedForStreaming",
Union[GetMediaMetaDataOptimizedForStreaming1, bool],
)
r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true"""
class GetMediaMetaDataOptimizedForStreaming1(int, Enum):
class GetMediaMetaDataOptimizedForStreamingLibrary1(int, Enum):
ZERO = 0
ONE = 1
GetMediaMetaDataLibraryOptimizedForStreamingTypedDict = TypeAliasType(
"GetMediaMetaDataLibraryOptimizedForStreamingTypedDict",
Union[GetMediaMetaDataOptimizedForStreaming1, bool],
Union[GetMediaMetaDataOptimizedForStreamingLibrary1, bool],
)
r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true"""
GetMediaMetaDataLibraryOptimizedForStreaming = TypeAliasType(
"GetMediaMetaDataLibraryOptimizedForStreaming",
Union[GetMediaMetaDataOptimizedForStreaming1, bool],
Union[GetMediaMetaDataOptimizedForStreamingLibrary1, bool],
)
r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true"""
@@ -195,12 +196,6 @@ class GetMediaMetaDataStreamTypedDict(TypedDict):
r"""Codec used by the stream."""
index: int
r"""Index of the stream."""
language: str
r"""Language of the stream."""
language_tag: str
r"""Language tag (e.g., en)."""
language_code: str
r"""ISO language code."""
display_title: str
r"""Display title for the stream."""
extended_display_title: str
@@ -209,6 +204,12 @@ class GetMediaMetaDataStreamTypedDict(TypedDict):
r"""Indicates if this stream is default."""
bitrate: NotRequired[int]
r"""Bitrate of the stream."""
language: NotRequired[str]
r"""Language of the stream."""
language_tag: NotRequired[str]
r"""Language tag (e.g., en)."""
language_code: NotRequired[str]
r"""ISO language code."""
header_compression: NotRequired[bool]
r"""Indicates whether header compression is enabled."""
dovibl_compat_id: NotRequired[int]
@@ -237,6 +238,7 @@ class GetMediaMetaDataStreamTypedDict(TypedDict):
r"""Coded video height."""
coded_width: NotRequired[int]
r"""Coded video width."""
closed_captions: NotRequired[bool]
color_primaries: NotRequired[str]
r"""Color primaries used."""
color_range: NotRequired[str]
@@ -257,6 +259,7 @@ class GetMediaMetaDataStreamTypedDict(TypedDict):
profile: NotRequired[str]
r"""Video profile."""
scan_type: NotRequired[str]
embedded_in_video: NotRequired[str]
ref_frames: NotRequired[int]
r"""Number of reference frames."""
width: NotRequired[int]
@@ -293,15 +296,6 @@ class GetMediaMetaDataStream(BaseModel):
index: int
r"""Index of the stream."""
language: str
r"""Language of the stream."""
language_tag: Annotated[str, pydantic.Field(alias="languageTag")]
r"""Language tag (e.g., en)."""
language_code: Annotated[str, pydantic.Field(alias="languageCode")]
r"""ISO language code."""
display_title: Annotated[str, pydantic.Field(alias="displayTitle")]
r"""Display title for the stream."""
@@ -314,6 +308,15 @@ class GetMediaMetaDataStream(BaseModel):
bitrate: Optional[int] = None
r"""Bitrate of the stream."""
language: Optional[str] = None
r"""Language of the stream."""
language_tag: Annotated[Optional[str], pydantic.Field(alias="languageTag")] = None
r"""Language tag (e.g., en)."""
language_code: Annotated[Optional[str], pydantic.Field(alias="languageCode")] = None
r"""ISO language code."""
header_compression: Annotated[
Optional[bool], pydantic.Field(alias="headerCompression")
] = None
@@ -370,6 +373,10 @@ class GetMediaMetaDataStream(BaseModel):
coded_width: Annotated[Optional[int], pydantic.Field(alias="codedWidth")] = None
r"""Coded video width."""
closed_captions: Annotated[
Optional[bool], pydantic.Field(alias="closedCaptions")
] = None
color_primaries: Annotated[
Optional[str], pydantic.Field(alias="colorPrimaries")
] = None
@@ -405,6 +412,10 @@ class GetMediaMetaDataStream(BaseModel):
scan_type: Annotated[Optional[str], pydantic.Field(alias="scanType")] = None
embedded_in_video: Annotated[
Optional[str], pydantic.Field(alias="embeddedInVideo")
] = None
ref_frames: Annotated[Optional[int], pydantic.Field(alias="refFrames")] = None
r"""Number of reference frames."""
@@ -533,10 +544,6 @@ class GetMediaMetaDataPart(BaseModel):
class GetMediaMetaDataMediaTypedDict(TypedDict):
id: int
r"""Unique media identifier."""
has_voice_activity: bool
r"""Indicates whether voice activity is detected."""
part: List[GetMediaMetaDataPartTypedDict]
r"""An array of parts for this media item."""
duration: NotRequired[int]
r"""Duration of the media in milliseconds."""
bitrate: NotRequired[int]
@@ -564,23 +571,21 @@ class GetMediaMetaDataMediaTypedDict(TypedDict):
"""
video_profile: NotRequired[str]
r"""Video profile (e.g., main 10)."""
has_voice_activity: NotRequired[bool]
r"""Indicates whether voice activity is detected."""
audio_profile: NotRequired[str]
r"""The audio profile used for the media (e.g., DTS, Dolby Digital, etc.)."""
optimized_for_streaming: NotRequired[GetMediaMetaDataOptimizedForStreamingTypedDict]
r"""Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true"""
has64bit_offsets: NotRequired[bool]
part: NotRequired[List[GetMediaMetaDataPartTypedDict]]
r"""An array of parts for this media item."""
class GetMediaMetaDataMedia(BaseModel):
id: int
r"""Unique media identifier."""
has_voice_activity: Annotated[bool, pydantic.Field(alias="hasVoiceActivity")]
r"""Indicates whether voice activity is detected."""
part: Annotated[List[GetMediaMetaDataPart], pydantic.Field(alias="Part")]
r"""An array of parts for this media item."""
duration: Optional[int] = None
r"""Duration of the media in milliseconds."""
@@ -629,6 +634,11 @@ class GetMediaMetaDataMedia(BaseModel):
video_profile: Annotated[Optional[str], pydantic.Field(alias="videoProfile")] = None
r"""Video profile (e.g., main 10)."""
has_voice_activity: Annotated[
Optional[bool], pydantic.Field(alias="hasVoiceActivity")
] = None
r"""Indicates whether voice activity is detected."""
audio_profile: Annotated[Optional[str], pydantic.Field(alias="audioProfile")] = None
r"""The audio profile used for the media (e.g., DTS, Dolby Digital, etc.)."""
@@ -642,6 +652,11 @@ class GetMediaMetaDataMedia(BaseModel):
Optional[bool], pydantic.Field(alias="has64bitOffsets")
] = None
part: Annotated[
Optional[List[GetMediaMetaDataPart]], pydantic.Field(alias="Part")
] = None
r"""An array of parts for this media item."""
class GetMediaMetaDataImageTypedDict(TypedDict):
alt: str
@@ -863,7 +878,7 @@ class GetMediaMetaDataWriter(BaseModel):
r"""URL for the role thumbnail image."""
class ProducerTypedDict(TypedDict):
class GetMediaMetaDataProducerTypedDict(TypedDict):
id: int
r"""The unique role identifier."""
filter_: str
@@ -878,7 +893,7 @@ class ProducerTypedDict(TypedDict):
r"""URL for the role thumbnail image."""
class Producer(BaseModel):
class GetMediaMetaDataProducer(BaseModel):
id: int
r"""The unique role identifier."""
@@ -898,7 +913,7 @@ class Producer(BaseModel):
r"""URL for the role thumbnail image."""
class SimilarTypedDict(TypedDict):
class GetMediaMetaDataSimilarTypedDict(TypedDict):
id: int
r"""The unique similar item identifier."""
filter_: str
@@ -907,7 +922,7 @@ class SimilarTypedDict(TypedDict):
r"""The tag or title of the similar content."""
class Similar(BaseModel):
class GetMediaMetaDataSimilar(BaseModel):
id: int
r"""The unique similar item identifier."""
@@ -1039,9 +1054,9 @@ class GetMediaMetaDataMetadataTypedDict(TypedDict):
r"""An array of Director roles."""
writer: NotRequired[List[GetMediaMetaDataWriterTypedDict]]
r"""An array of Writer roles."""
producer: NotRequired[List[ProducerTypedDict]]
producer: NotRequired[List[GetMediaMetaDataProducerTypedDict]]
r"""An array of Writer roles."""
similar: NotRequired[List[SimilarTypedDict]]
similar: NotRequired[List[GetMediaMetaDataSimilarTypedDict]]
r"""An array of similar content objects."""
location: NotRequired[List[GetMediaMetaDataLocationTypedDict]]
r"""An array of location objects."""
@@ -1266,12 +1281,14 @@ class GetMediaMetaDataMetadata(BaseModel):
] = None
r"""An array of Writer roles."""
producer: Annotated[Optional[List[Producer]], pydantic.Field(alias="Producer")] = (
None
)
producer: Annotated[
Optional[List[GetMediaMetaDataProducer]], pydantic.Field(alias="Producer")
] = None
r"""An array of Writer roles."""
similar: Annotated[Optional[List[Similar]], pydantic.Field(alias="Similar")] = None
similar: Annotated[
Optional[List[GetMediaMetaDataSimilar]], pydantic.Field(alias="Similar")
] = None
r"""An array of similar content objects."""
location: Annotated[

1908
src/plex_api_client/models/operations/get_recently_added.py
View File

File diff suppressed because it is too large Load Diff

407
src/plex_api_client/models/operations/getondeck.py
View File

@@ -1,407 +0,0 @@
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
from __future__ import annotations
from datetime import datetime
import httpx
from plex_api_client.types import BaseModel
import pydantic
from typing import List, Optional
from typing_extensions import Annotated, NotRequired, TypedDict
class GetOnDeckStreamTypedDict(TypedDict):
id: NotRequired[float]
stream_type: NotRequired[float]
default: NotRequired[bool]
codec: NotRequired[str]
index: NotRequired[float]
bitrate: NotRequired[float]
language: NotRequired[str]
language_tag: NotRequired[str]
language_code: NotRequired[str]
bit_depth: NotRequired[float]
chroma_location: NotRequired[str]
chroma_subsampling: NotRequired[str]
coded_height: NotRequired[float]
coded_width: NotRequired[float]
color_range: NotRequired[str]
frame_rate: NotRequired[float]
height: NotRequired[float]
level: NotRequired[float]
profile: NotRequired[str]
ref_frames: NotRequired[float]
width: NotRequired[float]
display_title: NotRequired[str]
extended_display_title: NotRequired[str]
class GetOnDeckStream(BaseModel):
id: Optional[float] = None
stream_type: Annotated[Optional[float], pydantic.Field(alias="streamType")] = None
default: Optional[bool] = None
codec: Optional[str] = None
index: Optional[float] = None
bitrate: Optional[float] = None
language: Optional[str] = None
language_tag: Annotated[Optional[str], pydantic.Field(alias="languageTag")] = None
language_code: Annotated[Optional[str], pydantic.Field(alias="languageCode")] = None
bit_depth: Annotated[Optional[float], pydantic.Field(alias="bitDepth")] = None
chroma_location: Annotated[
Optional[str], pydantic.Field(alias="chromaLocation")
] = None
chroma_subsampling: Annotated[
Optional[str], pydantic.Field(alias="chromaSubsampling")
] = None
coded_height: Annotated[Optional[float], pydantic.Field(alias="codedHeight")] = None
coded_width: Annotated[Optional[float], pydantic.Field(alias="codedWidth")] = None
color_range: Annotated[Optional[str], pydantic.Field(alias="colorRange")] = None
frame_rate: Annotated[Optional[float], pydantic.Field(alias="frameRate")] = None
height: Optional[float] = None
level: Optional[float] = None
profile: Optional[str] = None
ref_frames: Annotated[Optional[float], pydantic.Field(alias="refFrames")] = None
width: Optional[float] = None
display_title: Annotated[Optional[str], pydantic.Field(alias="displayTitle")] = None
extended_display_title: Annotated[
Optional[str], pydantic.Field(alias="extendedDisplayTitle")
] = None
class GetOnDeckPartTypedDict(TypedDict):
id: NotRequired[float]
key: NotRequired[str]
duration: NotRequired[float]
file: NotRequired[str]
size: NotRequired[float]
audio_profile: NotRequired[str]
container: NotRequired[str]
video_profile: NotRequired[str]
stream: NotRequired[List[GetOnDeckStreamTypedDict]]
class GetOnDeckPart(BaseModel):
id: Optional[float] = None
key: Optional[str] = None
duration: Optional[float] = None
file: Optional[str] = None
size: Optional[float] = None
audio_profile: Annotated[Optional[str], pydantic.Field(alias="audioProfile")] = None
container: Optional[str] = None
video_profile: Annotated[Optional[str], pydantic.Field(alias="videoProfile")] = None
stream: Annotated[
Optional[List[GetOnDeckStream]], pydantic.Field(alias="Stream")
] = None
class GetOnDeckMediaTypedDict(TypedDict):
id: NotRequired[float]
duration: NotRequired[float]
bitrate: NotRequired[float]
width: NotRequired[float]
height: NotRequired[float]
aspect_ratio: NotRequired[float]
audio_channels: NotRequired[float]
audio_codec: NotRequired[str]
video_codec: NotRequired[str]
video_resolution: NotRequired[str]
container: NotRequired[str]
video_frame_rate: NotRequired[str]
audio_profile: NotRequired[str]
video_profile: NotRequired[str]
part: NotRequired[List[GetOnDeckPartTypedDict]]
class GetOnDeckMedia(BaseModel):
id: Optional[float] = None
duration: Optional[float] = None
bitrate: Optional[float] = None
width: Optional[float] = None
height: Optional[float] = None
aspect_ratio: Annotated[Optional[float], pydantic.Field(alias="aspectRatio")] = None
audio_channels: Annotated[
Optional[float], pydantic.Field(alias="audioChannels")
] = None
audio_codec: Annotated[Optional[str], pydantic.Field(alias="audioCodec")] = None
video_codec: Annotated[Optional[str], pydantic.Field(alias="videoCodec")] = None
video_resolution: Annotated[
Optional[str], pydantic.Field(alias="videoResolution")
] = None
container: Optional[str] = None
video_frame_rate: Annotated[
Optional[str], pydantic.Field(alias="videoFrameRate")
] = None
audio_profile: Annotated[Optional[str], pydantic.Field(alias="audioProfile")] = None
video_profile: Annotated[Optional[str], pydantic.Field(alias="videoProfile")] = None
part: Annotated[Optional[List[GetOnDeckPart]], pydantic.Field(alias="Part")] = None
class GetOnDeckGuidsTypedDict(TypedDict):
id: NotRequired[str]
class GetOnDeckGuids(BaseModel):
id: Optional[str] = None
class GetOnDeckMetadataTypedDict(TypedDict):
allow_sync: NotRequired[bool]
library_section_id: NotRequired[float]
library_section_title: NotRequired[str]
library_section_uuid: NotRequired[str]
rating_key: NotRequired[float]
key: NotRequired[str]
parent_rating_key: NotRequired[float]
grandparent_rating_key: NotRequired[float]
guid: NotRequired[str]
parent_guid: NotRequired[str]
grandparent_guid: NotRequired[str]
type: NotRequired[str]
title: NotRequired[str]
grandparent_key: NotRequired[str]
parent_key: NotRequired[str]
library_section_key: NotRequired[str]
grandparent_title: NotRequired[str]
parent_title: NotRequired[str]
content_rating: NotRequired[str]
summary: NotRequired[str]
index: NotRequired[float]
parent_index: NotRequired[float]
last_viewed_at: NotRequired[float]
year: NotRequired[float]
thumb: NotRequired[str]
art: NotRequired[str]
parent_thumb: NotRequired[str]
grandparent_thumb: NotRequired[str]
grandparent_art: NotRequired[str]
grandparent_theme: NotRequired[str]
duration: NotRequired[float]
originally_available_at: NotRequired[datetime]
added_at: NotRequired[float]
updated_at: NotRequired[float]
media: NotRequired[List[GetOnDeckMediaTypedDict]]
guids: NotRequired[List[GetOnDeckGuidsTypedDict]]
class GetOnDeckMetadata(BaseModel):
allow_sync: Annotated[Optional[bool], pydantic.Field(alias="allowSync")] = None
library_section_id: Annotated[
Optional[float], pydantic.Field(alias="librarySectionID")
] = None
library_section_title: Annotated[
Optional[str], pydantic.Field(alias="librarySectionTitle")
] = None
library_section_uuid: Annotated[
Optional[str], pydantic.Field(alias="librarySectionUUID")
] = None
rating_key: Annotated[Optional[float], pydantic.Field(alias="ratingKey")] = None
key: Optional[str] = None
parent_rating_key: Annotated[
Optional[float], pydantic.Field(alias="parentRatingKey")
] = None
grandparent_rating_key: Annotated[
Optional[float], pydantic.Field(alias="grandparentRatingKey")
] = None
guid: Optional[str] = None
parent_guid: Annotated[Optional[str], pydantic.Field(alias="parentGuid")] = None
grandparent_guid: Annotated[
Optional[str], pydantic.Field(alias="grandparentGuid")
] = None
type: Optional[str] = None
title: Optional[str] = None
grandparent_key: Annotated[
Optional[str], pydantic.Field(alias="grandparentKey")
] = None
parent_key: Annotated[Optional[str], pydantic.Field(alias="parentKey")] = None
library_section_key: Annotated[
Optional[str], pydantic.Field(alias="librarySectionKey")
] = None
grandparent_title: Annotated[
Optional[str], pydantic.Field(alias="grandparentTitle")
] = None
parent_title: Annotated[Optional[str], pydantic.Field(alias="parentTitle")] = None
content_rating: Annotated[Optional[str], pydantic.Field(alias="contentRating")] = (
None
)
summary: Optional[str] = None
index: Optional[float] = None
parent_index: Annotated[Optional[float], pydantic.Field(alias="parentIndex")] = None
last_viewed_at: Annotated[Optional[float], pydantic.Field(alias="lastViewedAt")] = (
None
)
year: Optional[float] = None
thumb: Optional[str] = None
art: Optional[str] = None
parent_thumb: Annotated[Optional[str], pydantic.Field(alias="parentThumb")] = None
grandparent_thumb: Annotated[
Optional[str], pydantic.Field(alias="grandparentThumb")
] = None
grandparent_art: Annotated[
Optional[str], pydantic.Field(alias="grandparentArt")
] = None
grandparent_theme: Annotated[
Optional[str], pydantic.Field(alias="grandparentTheme")
] = None
duration: Optional[float] = None
originally_available_at: Annotated[
Optional[datetime], pydantic.Field(alias="originallyAvailableAt")
] = None
added_at: Annotated[Optional[float], pydantic.Field(alias="addedAt")] = None
updated_at: Annotated[Optional[float], pydantic.Field(alias="updatedAt")] = None
media: Annotated[Optional[List[GetOnDeckMedia]], pydantic.Field(alias="Media")] = (
None
)
guids: Annotated[Optional[List[GetOnDeckGuids]], pydantic.Field(alias="Guid")] = (
None
)
class GetOnDeckMediaContainerTypedDict(TypedDict):
size: NotRequired[float]
allow_sync: NotRequired[bool]
identifier: NotRequired[str]
media_tag_prefix: NotRequired[str]
media_tag_version: NotRequired[float]
mixed_parents: NotRequired[bool]
metadata: NotRequired[List[GetOnDeckMetadataTypedDict]]
class GetOnDeckMediaContainer(BaseModel):
size: Optional[float] = None
allow_sync: Annotated[Optional[bool], pydantic.Field(alias="allowSync")] = None
identifier: Optional[str] = None
media_tag_prefix: Annotated[
Optional[str], pydantic.Field(alias="mediaTagPrefix")
] = None
media_tag_version: Annotated[
Optional[float], pydantic.Field(alias="mediaTagVersion")
] = None
mixed_parents: Annotated[Optional[bool], pydantic.Field(alias="mixedParents")] = (
None
)
metadata: Annotated[
Optional[List[GetOnDeckMetadata]], pydantic.Field(alias="Metadata")
] = None
class GetOnDeckResponseBodyTypedDict(TypedDict):
r"""The on Deck content"""
media_container: NotRequired[GetOnDeckMediaContainerTypedDict]
class GetOnDeckResponseBody(BaseModel):
r"""The on Deck content"""
media_container: Annotated[
Optional[GetOnDeckMediaContainer], pydantic.Field(alias="MediaContainer")
] = None
class GetOnDeckResponseTypedDict(TypedDict):
content_type: str
r"""HTTP response content type for this operation"""
status_code: int
r"""HTTP response status code for this operation"""
raw_response: httpx.Response
r"""Raw HTTP response; suitable for custom response parsing"""
object: NotRequired[GetOnDeckResponseBodyTypedDict]
r"""The on Deck content"""
class GetOnDeckResponse(BaseModel):
content_type: str
r"""HTTP response content type for this operation"""
status_code: int
r"""HTTP response status code for this operation"""
raw_response: httpx.Response
r"""Raw HTTP response; suitable for custom response parsing"""
object: Optional[GetOnDeckResponseBody] = None
r"""The on Deck content"""