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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.529.1

Browse Source
This commit is contained in:
speakeasybot
2025-04-07 00:02:40 +00:00
parent d81e7dd3dc
commit 8e469e991a
78 changed files with 503 additions and 427 deletions
Download Patch File Download Diff File Expand all files Collapse all files

271
.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.25.0
version: 0.25.1
additionalDependencies:
dev: {}
main: {}

14
.speakeasy/workflow.lock
View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.528.1
speakeasyVersion: 1.529.1
sources:
my-source:
sourceNamespace: my-source
@@ -8,19 +8,19 @@ sources:
- latest
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:b5580df6ec4a386e12249ff13f35b916fe5559e101de4a816b53e47d6947f1a5
sourceBlobDigest: sha256:6108b6c35fbe7e9163ffe0c804170f5e3a6edb63b8e745454ea8ee249bd790c3
sourceRevisionDigest: sha256:ea508e3da23b283f47aeb4384d6b3ab374a27bdffb8d8d8376cedbad3ad77a06
sourceBlobDigest: sha256:c210adbd02b0213b9e6f95ffc27f60ec38f8f9040137d55ccf2b650d92ab0ff5
tags:
- latest
- speakeasy-sdk-regen-1743724902
- speakeasy-sdk-regen-1743984085
targets:
plexpy:
source: plexapi
sourceNamespace: plexapi
sourceRevisionDigest: sha256:b5580df6ec4a386e12249ff13f35b916fe5559e101de4a816b53e47d6947f1a5
sourceBlobDigest: sha256:6108b6c35fbe7e9163ffe0c804170f5e3a6edb63b8e745454ea8ee249bd790c3
sourceRevisionDigest: sha256:ea508e3da23b283f47aeb4384d6b3ab374a27bdffb8d8d8376cedbad3ad77a06
sourceBlobDigest: sha256:c210adbd02b0213b9e6f95ffc27f60ec38f8f9040137d55ccf2b650d92ab0ff5
codeSamplesNamespace: code-samples-python-plexpy
codeSamplesRevisionDigest: sha256:a778abbffccd815f66b90209260b64dfecf0e7d4fb1d145cec800eabe371a550
codeSamplesRevisionDigest: sha256:becefa6564b0a13a97916bdfc86713452a5c35db61fce13ac595ad52ec18a8c3
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest

12
RELEASES.md
View File

@@ -988,4 +988,14 @@ Based on:
### Generated
- [python v0.25.0] .
### Releases
- [PyPI v0.25.0] https://pypi.org/project/plex-api-client/0.25.0 - .
- [PyPI v0.25.0] https://pypi.org/project/plex-api-client/0.25.0 - .
## 2025-04-07 00:01:08
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.529.1 (2.566.5) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v0.25.1] .
### Releases
- [PyPI v0.25.1] https://pypi.org/project/plex-api-client/0.25.1 - .

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

@@ -5,8 +5,8 @@
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `type` | *str* | :heavy_check_mark: | N/A | |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | |
| `type` | *str* | :heavy_check_mark: | N/A | |
| `flavor` | *Optional[str]* | :heavy_minus_sign: | N/A | global |
| `scrobble_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /:/scrobble/new |
| `unscrobble_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /:/unscrobble/new |

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

@@ -9,11 +9,11 @@
| `friendly_name` | *Nullable[str]* | :heavy_check_mark: | The account full name | exampleUser |
| `home` | *bool* | :heavy_check_mark: | If the account is a Plex Home user | |
| `id` | *int* | :heavy_check_mark: | The Plex account ID | |
| `restricted` | *Optional[bool]* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
| `shared_servers` | List[[operations.SharedServers](../../models/operations/sharedservers.md)] | :heavy_check_mark: | N/A | |
| `shared_sources` | List[[operations.SharedSources](../../models/operations/sharedsources.md)] | :heavy_check_mark: | N/A | |
| `status` | [operations.Status](../../models/operations/status.md) | :heavy_check_mark: | Current friend request status | accepted |
| `thumb` | *str* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578 |
| `title` | *str* | :heavy_check_mark: | The title of the account (username or friendly name) | username123 |
| `username` | *str* | :heavy_check_mark: | The account username | username123 |
| `uuid` | *str* | :heavy_check_mark: | The account Universally Unique Identifier (UUID) | 7d1916e0d8f6e76b |
| `restricted` | *Optional[bool]* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
| `uuid` | *str* | :heavy_check_mark: | The account Universally Unique Identifier (UUID) | 7d1916e0d8f6e76b |

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

@@ -11,10 +11,10 @@ Geo location data
| `continent_code` | *str* | :heavy_check_mark: | The continent code where the country is located. | NA |
| `country` | *str* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands |
| `city` | *str* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `european_union_member` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
| `time_zone` | *str* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `postal_code` | *str* | :heavy_check_mark: | The postal code of the location. | 802 |
| `subdivisions` | *str* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `coordinates` | *str* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |
| `european_union_member` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
| `in_privacy_restricted_country` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
| `in_privacy_restricted_region` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
| `in_privacy_restricted_region` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
| `subdivisions` | *str* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `coordinates` | *str* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |

36
docs/models/operations/getalllibrariesdirectory.md
View File

@@ -5,24 +5,24 @@
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `allow_sync` | *bool* | :heavy_check_mark: | N/A | true |
| `art` | *str* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
| `composite` | *str* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
| `filters` | *bool* | :heavy_check_mark: | N/A | true |
| `refreshing` | *bool* | :heavy_check_mark: | N/A | false |
| `thumb` | *str* | :heavy_check_mark: | N/A | /:/resources/movie.png |
| `key` | *str* | :heavy_check_mark: | N/A | 1 |
| `type` | *str* | :heavy_check_mark: | N/A | movie |
| `title` | *str* | :heavy_check_mark: | N/A | Movies |
| `agent` | *str* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
| `scanner` | *str* | :heavy_check_mark: | N/A | Plex Movie |
| `language` | *str* | :heavy_check_mark: | N/A | en-US |
| `uuid` | *str* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `allow_sync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `art` | *str* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `composite` | *str* | :heavy_check_mark: | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
| `filters` | *bool* | :heavy_check_mark: | UNKNOWN | true |
| `refreshing` | *bool* | :heavy_check_mark: | Indicates whether the library is currently being refreshed or updated | true |
| `thumb` | *str* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `key` | *str* | :heavy_check_mark: | The library key representing the unique identifier | 1 |
| `type` | [operations.GetAllLibrariesType](../../models/operations/getalllibrariestype.md) | :heavy_check_mark: | N/A | movie |
| `title` | *str* | :heavy_check_mark: | The title of the library | Movies |
| `agent` | *str* | :heavy_check_mark: | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
| `scanner` | *str* | :heavy_check_mark: | UNKNOWN | Plex Movie |
| `language` | *str* | :heavy_check_mark: | The Plex library language that has been set | en-US |
| `uuid` | *str* | :heavy_check_mark: | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-01e7d3cc34d6 |
| `updated_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `created_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `created_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1556281940 |
| `scanned_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `content` | *bool* | :heavy_check_mark: | N/A | true |
| `directory` | *bool* | :heavy_check_mark: | N/A | true |
| `content_changed_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `hidden` | *int* | :heavy_check_mark: | N/A | 0 |
| `content` | *bool* | :heavy_check_mark: | UNKNOWN | true |
| `directory` | *bool* | :heavy_check_mark: | UNKNOWN | true |
| `content_changed_at` | *int* | :heavy_check_mark: | The number of seconds since the content was last changed relative to now. | 9173960 |
| `hidden` | [Optional[operations.Hidden]](../../models/operations/hidden.md) | :heavy_minus_sign: | N/A | 1 |
| `location` | List[[operations.GetAllLibrariesLocation](../../models/operations/getalllibrarieslocation.md)] | :heavy_check_mark: | N/A | |

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

@@ -3,7 +3,7 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *int* | :heavy_check_mark: | N/A | 1 |
| `path` | *str* | :heavy_check_mark: | N/A | /movies |
| Field | Type | Required | Description | Example |
| --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- |
| `id` | *int* | :heavy_check_mark: | The ID of the location. | 1 |
| `path` | *str* | :heavy_check_mark: | The path to the media item. | /Movies |

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

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `size` | *int* | :heavy_check_mark: | N/A | 5 |
| `allow_sync` | *bool* | :heavy_check_mark: | N/A | false |
| `title1` | *str* | :heavy_check_mark: | N/A | Plex Library |
| `directory` | List[[operations.GetAllLibrariesDirectory](../../models/operations/getalllibrariesdirectory.md)] | :heavy_check_mark: | N/A | |
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `allow_sync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `title1` | *str* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `directory` | List[[operations.GetAllLibrariesDirectory](../../models/operations/getalllibrariesdirectory.md)] | :heavy_minus_sign: | N/A | |

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

@@ -5,6 +5,6 @@ The libraries available on the Server
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `media_container` | [operations.GetAllLibrariesMediaContainer](../../models/operations/getalllibrariesmediacontainer.md) | :heavy_check_mark: | N/A |
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `media_container` | [Optional[operations.GetAllLibrariesMediaContainer]](../../models/operations/getalllibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |

15
docs/models/operations/getalllibrariestype.md Normal file
View File

@@ -0,0 +1,15 @@
# GetAllLibrariesType
The library type
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | movie |
| `TV_SHOW` | show |
| `SEASON` | season |
| `EPISODE` | episode |
| `ARTIST` | artist |
| `ALBUM` | album |

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

@@ -14,6 +14,7 @@
| `identifier` | *str* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `library_section_id` | *int* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
| `library_section_title` | *str* | :heavy_check_mark: | The title of the library section. | TV Series |
| `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
| `media_tag_prefix` | *str* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `media_tag_version` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `thumb` | *str* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
@@ -21,6 +22,5 @@
| `title1` | *str* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `title2` | *str* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
| `view_group` | *str* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
| `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
| `meta` | [Optional[operations.GetAllMediaLibraryMeta]](../../models/operations/getallmedialibrarymeta.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.GetAllMediaLibraryMetadata](../../models/operations/getallmedialibrarymetadata.md)] | :heavy_minus_sign: | An array of metadata items. | |

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

@@ -12,27 +12,27 @@ Unknown
| `key` | *str* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
| `guid` | *str* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
| `slug` | *str* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
| `studio` | *Optional[str]* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `type` | [operations.GetAllMediaLibraryLibraryType](../../models/operations/getallmedialibrarylibrarytype.md) | :heavy_check_mark: | N/A | movie |
| `title` | *str* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
| `title_sort` | *str* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
| `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` | *Optional[int]* | :heavy_minus_sign: | 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 |
| `theme` | *str* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
| `index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
| `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 |
| `child_count` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
| `season_count` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
| `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 |
| `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 |

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

@@ -5,14 +5,14 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `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 |
| `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 |
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
| `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `file` | *str* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `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 |

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

@@ -5,11 +5,11 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `key` | *str* | :heavy_check_mark: | N/A | titleSort |
| `title` | *str* | :heavy_check_mark: | N/A | Title |
| `default` | *Optional[str]* | :heavy_minus_sign: | N/A | asc |
| `active` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `active_direction` | [Optional[operations.GetAllMediaLibraryActiveDirection]](../../models/operations/getallmedialibraryactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `default_direction` | [Optional[operations.GetAllMediaLibraryDefaultDirection]](../../models/operations/getallmedialibrarydefaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `desc_key` | *Optional[str]* | :heavy_minus_sign: | N/A | titleSort:desc |
| `first_character_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `first_character_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `key` | *str* | :heavy_check_mark: | N/A | titleSort |
| `title` | *str* | :heavy_check_mark: | N/A | Title |

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

@@ -7,11 +7,9 @@
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `stream_type` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `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 |
@@ -45,6 +43,8 @@
| `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 |
| `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) |
| `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 |

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

@@ -7,9 +7,9 @@
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `key` | *str* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *str* | :heavy_check_mark: | N/A | filter |
| `subtype` | *Optional[str]* | :heavy_minus_sign: | N/A | clip |
| `title` | *str* | :heavy_check_mark: | N/A | TV Shows |
| `active` | *bool* | :heavy_check_mark: | N/A | false |
| `subtype` | *Optional[str]* | :heavy_minus_sign: | N/A | clip |
| `filter_` | List[[operations.GetAllMediaLibraryFilter](../../models/operations/getallmedialibraryfilter.md)] | :heavy_minus_sign: | N/A | |
| `sort` | List[[operations.GetAllMediaLibrarySort](../../models/operations/getallmedialibrarysort.md)] | :heavy_minus_sign: | N/A | |
| `field` | List[[operations.GetAllMediaLibraryField](../../models/operations/getallmedialibraryfield.md)] | :heavy_minus_sign: | N/A | |

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

@@ -8,5 +8,5 @@
| `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 |
| `headers` | Dict[str, List[*str*]] | :heavy_check_mark: | N/A |
| `response_stream` | *Optional[httpx.Response]* | :heavy_minus_sign: | Successful response returning an image |
| `response_stream` | *Optional[httpx.Response]* | :heavy_minus_sign: | Successful response returning an image |
| `headers` | Dict[str, List[*str*]] | :heavy_check_mark: | N/A |

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

@@ -11,10 +11,10 @@ Geo location data
| `continent_code` | *str* | :heavy_check_mark: | The continent code where the country is located. | NA |
| `country` | *str* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands |
| `city` | *str* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `european_union_member` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
| `time_zone` | *str* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `postal_code` | *str* | :heavy_check_mark: | The postal code of the location. | 802 |
| `subdivisions` | *str* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `coordinates` | *str* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |
| `european_union_member` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
| `in_privacy_restricted_country` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
| `in_privacy_restricted_region` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
| `in_privacy_restricted_region` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
| `subdivisions` | *str* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `coordinates` | *str* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |

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

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `section_key` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `include_details` | [Optional[operations.IncludeDetails]](../../models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
| `include_details` | [Optional[operations.IncludeDetails]](../../models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
| `section_key` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |

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

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

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

@@ -6,8 +6,6 @@
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
| `container` | *str* | :heavy_check_mark: | N/A | mkv |
| `part` | List[[operations.GetLibraryItemsPart](../../models/operations/getlibraryitemspart.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 |
@@ -18,8 +16,10 @@
| `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 |
| `container` | *str* | :heavy_check_mark: | N/A | mkv |
| `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.GetLibraryItemsOptimizedForStreaming]](../../models/operations/getlibraryitemsoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `part` | List[[operations.GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md)] | :heavy_check_mark: | N/A | |

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

@@ -8,11 +8,14 @@ The Meta object is only included in the response if the `includeMeta` parameter
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `type` | List[[operations.GetLibraryItemsType](../../models/operations/getlibraryitemstype.md)] | :heavy_minus_sign: | N/A | |
| `field_type` | List[[operations.GetLibraryItemsFieldType](../../models/operations/getlibraryitemsfieldtype.md)] | :heavy_minus_sign: | N/A | |
| `size` | *int* | :heavy_check_mark: | N/A | 70 |
| `total_size` | *int* | :heavy_check_mark: | N/A | 170 |
| `offset` | *int* | :heavy_check_mark: | N/A | 0 |
| `content` | *str* | :heavy_check_mark: | N/A | secondary |
| `allow_sync` | *bool* | :heavy_check_mark: | N/A | true |
| `nocache` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `art` | *str* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
| `identifier` | *str* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
| `library_section_id` | *int* | :heavy_check_mark: | N/A | 1 |
@@ -24,9 +27,6 @@ The Meta object is only included in the response if the `includeMeta` parameter
| `title1` | *str* | :heavy_check_mark: | N/A | Movies |
| `title2` | *str* | :heavy_check_mark: | N/A | Recently Released |
| `view_group` | *str* | :heavy_check_mark: | N/A | movie |
| `type` | List[[operations.GetLibraryItemsType](../../models/operations/getlibraryitemstype.md)] | :heavy_minus_sign: | N/A | |
| `field_type` | List[[operations.GetLibraryItemsFieldType](../../models/operations/getlibraryitemsfieldtype.md)] | :heavy_minus_sign: | N/A | |
| `nocache` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `view_mode` | *Optional[int]* | :heavy_minus_sign: | N/A | 65592 |
| `mixed_parents` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `metadata` | List[[operations.GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md)] | :heavy_minus_sign: | N/A | |

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

@@ -8,17 +8,16 @@
| `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.GetLibraryItemsLibraryType](../../models/operations/getlibraryitemslibrarytype.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 |
| `type` | [operations.GetLibraryItemsLibraryType](../../models/operations/getlibraryitemslibrarytype.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `title` | *str* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `slug` | *Optional[str]* | :heavy_minus_sign: | N/A | 4-for-texas |
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | N/A | PG-13 |
| `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. |
| `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 |
@@ -33,6 +32,7 @@
| `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: | Unix epoch datetime in seconds | 1556281940 |
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `chapter_source` | *Optional[str]* | :heavy_minus_sign: | N/A | media |

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

@@ -7,10 +7,10 @@
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119542 |
| `key` | *str* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
| `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 |

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

@@ -6,9 +6,9 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tag` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
| `include_guids` | [Optional[operations.IncludeGuids]](../../models/operations/includeguids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `type` | [operations.GetLibraryItemsQueryParamType](../../models/operations/getlibraryitemsqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `section_key` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `include_guids` | [Optional[operations.IncludeGuids]](../../models/operations/includeguids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `include_meta` | [Optional[operations.GetLibraryItemsQueryParamIncludeMeta]](../../models/operations/getlibraryitemsqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `x_plex_container_start` | *Optional[int]* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `x_plex_container_size` | *Optional[int]* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |

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

@@ -5,11 +5,11 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `key` | *str* | :heavy_check_mark: | N/A | titleSort |
| `title` | *str* | :heavy_check_mark: | N/A | Title |
| `default` | *Optional[str]* | :heavy_minus_sign: | N/A | asc |
| `active` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `active_direction` | [Optional[operations.GetLibraryItemsActiveDirection]](../../models/operations/getlibraryitemsactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `default_direction` | [Optional[operations.GetLibraryItemsDefaultDirection]](../../models/operations/getlibraryitemsdefaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `desc_key` | *Optional[str]* | :heavy_minus_sign: | N/A | titleSort:desc |
| `first_character_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `first_character_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `key` | *str* | :heavy_check_mark: | N/A | titleSort |
| `title` | *str* | :heavy_check_mark: | N/A | Title |

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

@@ -7,10 +7,10 @@
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `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 |
| `codec` | *str* | :heavy_check_mark: | Codec used by the stream | h264 |
| `index` | *int* | :heavy_check_mark: | The index of the stream | 0 |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
| `color_primaries` | *Optional[str]* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
| `color_range` | *Optional[str]* | :heavy_minus_sign: | The color range of the video stream | tv |

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

@@ -7,9 +7,9 @@
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `key` | *str* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *str* | :heavy_check_mark: | N/A | filter |
| `subtype` | *Optional[str]* | :heavy_minus_sign: | N/A | clip |
| `title` | *str* | :heavy_check_mark: | N/A | TV Shows |
| `active` | *bool* | :heavy_check_mark: | N/A | false |
| `subtype` | *Optional[str]* | :heavy_minus_sign: | N/A | clip |
| `filter_` | List[[operations.GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md)] | :heavy_minus_sign: | N/A | |
| `sort` | List[[operations.GetLibraryItemsSort](../../models/operations/getlibraryitemssort.md)] | :heavy_minus_sign: | N/A | |
| `field` | List[[operations.GetLibraryItemsField](../../models/operations/getlibraryitemsfield.md)] | :heavy_minus_sign: | N/A | |

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

@@ -6,7 +6,7 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `key` | *str* | :heavy_check_mark: | The URL of the artwork. | https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg |
| `provider` | *Optional[str]* | :heavy_minus_sign: | The provider of the artwork. | tmdb |
| `rating_key` | *str* | :heavy_check_mark: | The URL of the artwork. | https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg |
| `selected` | *bool* | :heavy_check_mark: | Whether this is the selected artwork. | true |
| `thumb` | *str* | :heavy_check_mark: | The URL of the artwork thumbnail. | https://images.plex.tv/photo?height=270&width=480&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FixgFmf1X59PUZam2qbAfskx2gQr%2Ejpg |
| `provider` | *Optional[str]* | :heavy_minus_sign: | The provider of the artwork. | tmdb |
| `thumb` | *str* | :heavy_check_mark: | The URL of the artwork thumbnail. | https://images.plex.tv/photo?height=270&width=480&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FixgFmf1X59PUZam2qbAfskx2gQr%2Ejpg |

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

@@ -10,7 +10,7 @@
| `identifier` | *str* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `library_section_id` | *int* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
| `library_section_title` | *str* | :heavy_check_mark: | The title of the library section. | TV Series |
| `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
| `media_tag_prefix` | *str* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `media_tag_version` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `metadata` | List[[operations.GetMediaMetaDataMetadata](../../models/operations/getmediametadatametadata.md)] | :heavy_check_mark: | An array of metadata items. | |
| `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
| `metadata` | List[[operations.GetMediaMetaDataMetadata](../../models/operations/getmediametadatametadata.md)] | :heavy_check_mark: | An array of metadata items. | |

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

@@ -6,22 +6,6 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rating_key` | *str* | :heavy_check_mark: | The rating key of the metadata item. | 44288 |
| `key` | *str* | :heavy_check_mark: | The API key to access metadata details. | /library/metadata/44288/children |
| `guid` | *str* | :heavy_check_mark: | The globally unique identifier for the item. | plex://show/5d9c08254eefaa001f5d6dcb |
| `type` | *str* | :heavy_check_mark: | The type of content (e.g., show, movie). | show |
| `title` | *str* | :heavy_check_mark: | The title of the content. | Better Call Saul |
| `library_section_title` | *str* | :heavy_check_mark: | The title of the library section. | TV Series |
| `library_section_id` | *int* | :heavy_check_mark: | The ID of the library section. | 2 |
| `library_section_key` | *str* | :heavy_check_mark: | The key of the library section. | /library/sections/2 |
| `summary` | *str* | :heavy_check_mark: | A summary of the content. | Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to "Breaking Bad" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman. |
| `year` | *int* | :heavy_check_mark: | The release year. | 2015 |
| `thumb` | *str* | :heavy_check_mark: | URL of the thumbnail image. | /library/metadata/44288/thumb/1736487993 |
| `art` | *str* | :heavy_check_mark: | URL of the art image. | /library/metadata/44288/art/1736487993 |
| `duration` | *int* | :heavy_check_mark: | Duration of the content in milliseconds. | 2700000 |
| `added_at` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `updated_at` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `image` | List[[operations.GetMediaMetaDataImage](../../models/operations/getmediametadataimage.md)] | :heavy_check_mark: | An array of image objects. | |
| `ultra_blur_colors` | [operations.GetMediaMetaDataUltraBlurColors](../../models/operations/getmediametadataultrablurcolors.md) | :heavy_check_mark: | N/A | |
| `parent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the parent of this metadata item. | 48047 |
| `grandparent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the grandparent of this metadata item. | 45520 |
| `parent_guid` | *Optional[str]* | :heavy_minus_sign: | A GUID identifying the parent entity (e.g., season) for the item. | plex://season/618b89208dde18df707ad15c |
@@ -29,10 +13,18 @@
| `grandparent_slug` | *Optional[str]* | :heavy_minus_sign: | A URL-friendly identifier (slug) for the grandparent entity. | alice-in-borderland-2020 |
| `grandparent_key` | *Optional[str]* | :heavy_minus_sign: | A key identifying the grandparent metadata in the library. | /library/metadata/45520 |
| `parent_key` | *Optional[str]* | :heavy_minus_sign: | A key identifying the parent metadata in the library. | /library/metadata/48047 |
| `key` | *str* | :heavy_check_mark: | The API key to access metadata details. | /library/metadata/44288/children |
| `guid` | *str* | :heavy_check_mark: | The globally unique identifier for the item. | plex://show/5d9c08254eefaa001f5d6dcb |
| `slug` | *Optional[str]* | :heavy_minus_sign: | A URL-friendly identifier for the item. | better-call-saul |
| `studio` | *Optional[str]* | :heavy_minus_sign: | The studio that produced the content. | Sony Pictures Television |
| `type` | *str* | :heavy_check_mark: | The type of content (e.g., show, movie). | show |
| `title` | *str* | :heavy_check_mark: | The title of the content. | Better Call Saul |
| `original_title` | *Optional[str]* | :heavy_minus_sign: | The original title of the content. | Wicked: Part I |
| `library_section_title` | *str* | :heavy_check_mark: | The title of the library section. | TV Series |
| `library_section_id` | *int* | :heavy_check_mark: | The ID of the library section. | 2 |
| `library_section_key` | *str* | :heavy_check_mark: | The key of the library section. | /library/sections/2 |
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | The content rating (e.g., TV-MA). | TV-MA |
| `summary` | *str* | :heavy_check_mark: | A summary of the content. | Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to "Breaking Bad" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman. |
| `index` | *Optional[int]* | :heavy_minus_sign: | The index or order of the item. | 1 |
| `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | The title of the grandparent entity (typically the show's title). | Alice in Borderland |
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | The title of the parent entity (typically the season's title). | Season 2 |
@@ -40,22 +32,30 @@
| `view_count` | *Optional[int]* | :heavy_minus_sign: | The number of times the item has been viewed. | 4 |
| `skip_count` | *Optional[int]* | :heavy_minus_sign: | The number of times the item has been skipped. | 1 |
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp of when the item was last viewed. | 1625764795 |
| `year` | *int* | :heavy_check_mark: | The release year. | 2015 |
| `rating` | *Optional[float]* | :heavy_minus_sign: | The general rating | 6 |
| `rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL or identifier for the rating image (e.g., Rotten Tomatoes rating image). | rottentomatoes://image.rating.ripe |
| `tagline` | *Optional[str]* | :heavy_minus_sign: | The tagline of the content. | Make the call |
| `chapter_source` | *Optional[str]* | :heavy_minus_sign: | N/A | media |
| `primary_extra_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/134704 |
| `thumb` | *str* | :heavy_check_mark: | URL of the thumbnail image. | /library/metadata/44288/thumb/1736487993 |
| `art` | *str* | :heavy_check_mark: | URL of the art image. | /library/metadata/44288/art/1736487993 |
| `theme` | *Optional[str]* | :heavy_minus_sign: | URL of the theme image. | /library/metadata/44288/theme/1736487993 |
| `duration` | *int* | :heavy_check_mark: | Duration of the content in milliseconds. | 2700000 |
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The original release date. | 2015-02-08 |
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | The total number of episodes (or leaves). | 63 |
| `viewed_leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of episodes that have been viewed. | 4 |
| `child_count` | *Optional[int]* | :heavy_minus_sign: | The number of child items. | 6 |
| `added_at` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `updated_at` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the audience rating image. | themoviedb://image.rating |
| `parent_index` | *Optional[int]* | :heavy_minus_sign: | The index number of the parent entity, which could indicate its order or position. | 2 |
| `parent_thumb` | *Optional[str]* | :heavy_minus_sign: | The URL of the parent's thumbnail image. | /library/metadata/48047/thumb/1671800243 |
| `grandparent_thumb` | *Optional[str]* | :heavy_minus_sign: | The URL of the grandparent's thumbnail image. | /library/metadata/45520/thumb/1736488003 |
| `grandparent_art` | *Optional[str]* | :heavy_minus_sign: | The URL of the grandparent's art image. | /library/metadata/45520/art/1736488003 |
| `media` | List[[operations.GetMediaMetaDataMedia](../../models/operations/getmediametadatamedia.md)] | :heavy_minus_sign: | N/A | |
| `image` | List[[operations.GetMediaMetaDataImage](../../models/operations/getmediametadataimage.md)] | :heavy_check_mark: | An array of image objects. | |
| `ultra_blur_colors` | [operations.GetMediaMetaDataUltraBlurColors](../../models/operations/getmediametadataultrablurcolors.md) | :heavy_check_mark: | N/A | |
| `genre` | List[[operations.GetMediaMetaDataGenre](../../models/operations/getmediametadatagenre.md)] | :heavy_minus_sign: | An array of genre tags. | |
| `country` | List[[operations.GetMediaMetaDataCountry](../../models/operations/getmediametadatacountry.md)] | :heavy_minus_sign: | An array of country tags. | |
| `guids` | List[[operations.GetMediaMetaDataGuids](../../models/operations/getmediametadataguids.md)] | :heavy_minus_sign: | An array of GUID objects. | |

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

@@ -5,14 +5,14 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `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 |
| `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 |
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
| `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `file` | *str* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `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 |

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

@@ -7,11 +7,9 @@
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `stream_type` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `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 |
@@ -45,6 +43,8 @@
| `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 |
| `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) |
| `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 |

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

@@ -6,7 +6,7 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `key` | *str* | :heavy_check_mark: | The URL of the poster. | https://image.tmdb.org/t/p/original/hntBJjqbv4m0Iyniqaztv9xaudI.jpg |
| `provider` | *Optional[str]* | :heavy_minus_sign: | The provider of the poster. | tmdb |
| `rating_key` | *str* | :heavy_check_mark: | The URL of the poster. | https://image.tmdb.org/t/p/original/hntBJjqbv4m0Iyniqaztv9xaudI.jpg |
| `selected` | *bool* | :heavy_check_mark: | Whether this is the selected poster. | true |
| `thumb` | *str* | :heavy_check_mark: | The URL of the poster thumbnail. | https://images.plex.tv/photo?height=336&width=225&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FhntBJjqbv4m0Iyniqaztv9xaudI%2Ejpg |
| `provider` | *Optional[str]* | :heavy_minus_sign: | The provider of the poster. | tmdb |
| `thumb` | *str* | :heavy_check_mark: | The URL of the poster thumbnail. | https://images.plex.tv/photo?height=336&width=225&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FhntBJjqbv4m0Iyniqaztv9xaudI%2Ejpg |

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

@@ -10,12 +10,12 @@ Requests a new pin id used in the authentication flow
| `id` | *int* | :heavy_check_mark: | N/A | 308667304 |
| `code` | *str* | :heavy_check_mark: | N/A | 7RQZ |
| `product` | *str* | :heavy_check_mark: | N/A | Tautulli |
| `trusted` | *Optional[bool]* | :heavy_minus_sign: | N/A | |
| `qr` | *str* | :heavy_check_mark: | N/A | https://plex.tv/api/v2/pins/qr/7RQZ |
| `client_identifier` | *str* | :heavy_check_mark: | The X-Client-Identifier used in the request | Tautulli |
| `location` | [operations.GeoData](../../models/operations/geodata.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} |
| `expires_in` | *Optional[int]* | :heavy_minus_sign: | The number of seconds this pin expires, by default 900 seconds | 876 |
| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z |
| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z |
| `trusted` | *Optional[bool]* | :heavy_minus_sign: | N/A | |
| `expires_in` | *Optional[int]* | :heavy_minus_sign: | The number of seconds this pin expires, by default 900 seconds | 876 |
| `auth_token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | gcgzw5rz2xovp84b4vha3a40 |
| `new_registration` | *OptionalNullable[Any]* | :heavy_minus_sign: | N/A | |

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

@@ -5,8 +5,8 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `client_id` | *str* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `strong` | *Optional[bool]* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
| `client_id` | *str* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `client_name` | *Optional[str]* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `device_nickname` | *Optional[str]* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `client_version` | *Optional[str]* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |

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

@@ -5,10 +5,10 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | [operations.QueryParamType](../../models/operations/queryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `content_directory_id` | *Optional[int]* | :heavy_minus_sign: | N/A | 2 |
| `pinned_content_directory_id` | List[*int*] | :heavy_minus_sign: | N/A | [<br/>3,<br/>5,<br/>7,<br/>13,<br/>12,<br/>1,<br/>6,<br/>14,<br/>2,<br/>10,<br/>16,<br/>17<br/>] |
| `section_id` | *Optional[int]* | :heavy_minus_sign: | The library section ID for filtering content. | 2 |
| `type` | [operations.QueryParamType](../../models/operations/queryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `include_meta` | [Optional[operations.QueryParamIncludeMeta]](../../models/operations/queryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `x_plex_container_start` | *Optional[int]* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `x_plex_container_size` | *Optional[int]* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |

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

@@ -7,9 +7,9 @@
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `key` | *str* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *str* | :heavy_check_mark: | N/A | filter |
| `subtype` | *Optional[str]* | :heavy_minus_sign: | N/A | clip |
| `title` | *str* | :heavy_check_mark: | N/A | TV Shows |
| `active` | *bool* | :heavy_check_mark: | N/A | false |
| `subtype` | *Optional[str]* | :heavy_minus_sign: | N/A | clip |
| `filter_` | List[[operations.GetRecentlyAddedLibraryFilter](../../models/operations/getrecentlyaddedlibraryfilter.md)] | :heavy_minus_sign: | N/A | |
| `sort` | List[[operations.Sort](../../models/operations/sort.md)] | :heavy_minus_sign: | N/A | |
| `field` | List[[operations.FieldT](../../models/operations/fieldt.md)] | :heavy_minus_sign: | N/A | |

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

@@ -10,34 +10,14 @@ Unknown
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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 |
| `audience_rating` | *float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `chapter_source` | *Optional[str]* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
| `child_count` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
| `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 |
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
| `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 |
@@ -46,23 +26,43 @@ Unknown
| `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 |
| `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 |
| `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 |
| `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 |
| `original_title` | *Optional[str]* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
| `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_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 |
| `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 |
| `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 |
| `skip_count` | *Optional[int]* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
| `slug` | *str* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
| `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 |
| `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 |
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `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 |

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

@@ -6,9 +6,9 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `content_directory_id` | *int* | :heavy_check_mark: | The content directory ID. | |
| `type` | [operations.Type](../../models/operations/type.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `pinned_content_directory_id` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of pinned content directory IDs. | |
| `section_id` | *Optional[int]* | :heavy_minus_sign: | The library section ID for filtering content. | 2 |
| `type` | [operations.Type](../../models/operations/type.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `include_meta` | [Optional[operations.IncludeMeta]](../../models/operations/includemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `x_plex_container_start` | *Optional[int]* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `x_plex_container_size` | *Optional[int]* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |

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

@@ -5,11 +5,11 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `key` | *str* | :heavy_check_mark: | N/A | titleSort |
| `title` | *str* | :heavy_check_mark: | N/A | Title |
| `default` | *Optional[str]* | :heavy_minus_sign: | N/A | asc |
| `active` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `active_direction` | [Optional[operations.GetRecentlyAddedActiveDirection]](../../models/operations/getrecentlyaddedactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `default_direction` | [Optional[operations.GetRecentlyAddedDefaultDirection]](../../models/operations/getrecentlyaddeddefaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `desc_key` | *Optional[str]* | :heavy_minus_sign: | N/A | titleSort:desc |
| `first_character_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `first_character_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `key` | *str* | :heavy_check_mark: | N/A | titleSort |
| `title` | *str* | :heavy_check_mark: | N/A | Title |

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

@@ -7,9 +7,9 @@
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `key` | *str* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *str* | :heavy_check_mark: | N/A | filter |
| `subtype` | *Optional[str]* | :heavy_minus_sign: | N/A | clip |
| `title` | *str* | :heavy_check_mark: | N/A | TV Shows |
| `active` | *bool* | :heavy_check_mark: | N/A | false |
| `subtype` | *Optional[str]* | :heavy_minus_sign: | N/A | clip |
| `filter_` | List[[operations.GetRecentlyAddedFilter](../../models/operations/getrecentlyaddedfilter.md)] | :heavy_minus_sign: | N/A | |
| `sort` | List[[operations.GetRecentlyAddedSort](../../models/operations/getrecentlyaddedsort.md)] | :heavy_minus_sign: | N/A | |
| `field` | List[[operations.GetRecentlyAddedField](../../models/operations/getrecentlyaddedfield.md)] | :heavy_minus_sign: | N/A | |

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

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `section_key` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `force` | [Optional[operations.Force]](../../models/operations/force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |
| `force` | [Optional[operations.Force]](../../models/operations/force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |
| `section_key` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |

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

@@ -7,8 +7,8 @@
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `width` | *float* | :heavy_check_mark: | The width for the resized photo | 110 |
| `height` | *float* | :heavy_check_mark: | The height for the resized photo | 165 |
| `opacity` | *int* | :heavy_check_mark: | The opacity for the resized photo | |
| `blur` | *float* | :heavy_check_mark: | The width for the resized photo | 0 |
| `min_size` | [operations.MinSize](../../models/operations/minsize.md) | :heavy_check_mark: | images are always scaled proportionally. A value of '1' in minSize will make the smaller native dimension the dimension resized against. | |
| `upscale` | [operations.Upscale](../../models/operations/upscale.md) | :heavy_check_mark: | allow images to be resized beyond native dimensions. | |
| `url` | *str* | :heavy_check_mark: | path to image within Plex | /library/metadata/49564/thumb/1654258204 |
| `opacity` | *int* | :heavy_check_mark: | The opacity for the resized photo | |
| `url` | *str* | :heavy_check_mark: | path to image within Plex | /library/metadata/49564/thumb/1654258204 |

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

@@ -6,8 +6,6 @@
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
| `container` | *str* | :heavy_check_mark: | N/A | mkv |
| `part` | List[[operations.GetSearchAllLibrariesPart](../../models/operations/getsearchalllibrariespart.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 |
@@ -18,8 +16,10 @@
| `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 |
| `container` | *str* | :heavy_check_mark: | N/A | mkv |
| `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.GetSearchAllLibrariesOptimizedForStreaming]](../../models/operations/getsearchalllibrariesoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `part` | List[[operations.GetSearchAllLibrariesPart](../../models/operations/getsearchalllibrariespart.md)] | :heavy_check_mark: | N/A | |

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

@@ -8,17 +8,16 @@
| `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.GetSearchAllLibrariesType](../../models/operations/getsearchalllibrariestype.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 |
| `type` | [operations.GetSearchAllLibrariesType](../../models/operations/getsearchalllibrariestype.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `title` | *str* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `slug` | *Optional[str]* | :heavy_minus_sign: | N/A | 4-for-texas |
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | N/A | PG-13 |
| `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. |
| `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 |
@@ -33,6 +32,7 @@
| `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: | Unix epoch datetime in seconds | 1556281940 |
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `chapter_source` | *Optional[str]* | :heavy_minus_sign: | N/A | media |

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

@@ -7,10 +7,10 @@
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119542 |
| `key` | *str* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
| `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 |

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

@@ -7,10 +7,10 @@
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `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 |
| `codec` | *str* | :heavy_check_mark: | Codec used by the stream | h264 |
| `index` | *int* | :heavy_check_mark: | The index of the stream | 0 |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
| `color_primaries` | *Optional[str]* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
| `color_range` | *Optional[str]* | :heavy_minus_sign: | The color range of the video stream | tv |

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

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `client_id` | *str* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `include_https` | [Optional[operations.IncludeHTTPS]](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `include_relay` | [Optional[operations.IncludeRelay]](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `include_i_pv6` | [Optional[operations.IncludeIPv6]](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `include_i_pv6` | [Optional[operations.IncludeIPv6]](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `client_id` | *str* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |

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

@@ -8,5 +8,5 @@
| `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 |
| `headers` | Dict[str, List[*str*]] | :heavy_check_mark: | N/A |
| `response_stream` | *Optional[httpx.Response]* | :heavy_minus_sign: | Successful response returning an image |
| `response_stream` | *Optional[httpx.Response]* | :heavy_minus_sign: | Successful response returning an image |
| `headers` | Dict[str, List[*str*]] | :heavy_check_mark: | N/A |

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

@@ -10,12 +10,12 @@ The Pin with a non-null authToken when it has been verified by the user
| `id` | *int* | :heavy_check_mark: | N/A | 308667304 |
| `code` | *str* | :heavy_check_mark: | N/A | 7RQZ |
| `product` | *str* | :heavy_check_mark: | N/A | Tautulli |
| `trusted` | *Optional[bool]* | :heavy_minus_sign: | N/A | |
| `qr` | *str* | :heavy_check_mark: | N/A | https://plex.tv/api/v2/pins/qr/7RQZ |
| `client_identifier` | *str* | :heavy_check_mark: | The X-Client-Identifier used in the request | Tautulli |
| `location` | [operations.GetTokenByPinIDGeoData](../../models/operations/gettokenbypinidgeodata.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} |
| `expires_in` | *Optional[int]* | :heavy_minus_sign: | The number of seconds this pin expires, by default 900 seconds | 876 |
| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z |
| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z |
| `trusted` | *Optional[bool]* | :heavy_minus_sign: | N/A | |
| `expires_in` | *Optional[int]* | :heavy_minus_sign: | The number of seconds this pin expires, by default 900 seconds | 876 |
| `auth_token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | gcgzw5rz2xovp84b4vha3a40 |
| `new_registration` | *OptionalNullable[Any]* | :heavy_minus_sign: | N/A | |

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

@@ -11,10 +11,10 @@ Geo location data
| `continent_code` | *str* | :heavy_check_mark: | The continent code where the country is located. | NA |
| `country` | *str* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands |
| `city` | *str* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `european_union_member` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
| `time_zone` | *str* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `postal_code` | *str* | :heavy_check_mark: | The postal code of the location. | 802 |
| `subdivisions` | *str* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `coordinates` | *str* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |
| `european_union_member` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
| `in_privacy_restricted_country` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
| `in_privacy_restricted_region` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
| `in_privacy_restricted_region` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
| `subdivisions` | *str* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `coordinates` | *str* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |

46
docs/models/operations/gettokendetailsuserplexaccount.md
View File

@@ -10,41 +10,41 @@ Logged in user details
| `ads_consent` | *Nullable[bool]* | :heavy_check_mark: | Unknown | |
| `ads_consent_reminder_at` | *Nullable[int]* | :heavy_check_mark: | N/A | 1556281940 |
| `ads_consent_set_at` | *Nullable[int]* | :heavy_check_mark: | N/A | 1556281940 |
| `auth_token` | *str* | :heavy_check_mark: | The account token | CxoUzBTSV5hsxjTpFKaf |
| `country` | *str* | :heavy_check_mark: | The account country | US |
| `email` | *str* | :heavy_check_mark: | The account email address | username@email.com |
| `friendly_name` | *str* | :heavy_check_mark: | Your account full name | friendlyUsername |
| `entitlements` | List[*str*] | :heavy_check_mark: | List of devices your allowed to use with this account | |
| `home_size` | *int* | :heavy_check_mark: | The number of accounts in the Plex Home | 1 |
| `id` | *int* | :heavy_check_mark: | The Plex account ID | 13692262 |
| `joined_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `locale` | *Nullable[str]* | :heavy_check_mark: | The account locale | |
| `mailing_list_status` | [operations.MailingListStatus](../../models/operations/mailingliststatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active |
| `max_home_size` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
| `profile` | [operations.UserProfile](../../models/operations/userprofile.md) | :heavy_check_mark: | N/A | |
| `remember_expires_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `scrobble_types` | *str* | :heavy_check_mark: | Unknown | |
| `services` | List[[operations.Services](../../models/operations/services.md)] | :heavy_check_mark: | N/A | |
| `subscription` | [operations.Subscription](../../models/operations/subscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
| `subscription_description` | *Nullable[str]* | :heavy_check_mark: | Description of the Plex Pass subscription | |
| `thumb` | *str* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101 |
| `title` | *str* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
| `username` | *str* | :heavy_check_mark: | The account username | Username |
| `uuid` | *str* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
| `attribution_partner` | *Nullable[str]* | :heavy_check_mark: | N/A | <nil> |
| `anonymous` | *OptionalNullable[bool]* | :heavy_minus_sign: | Unknown | |
| `auth_token` | *str* | :heavy_check_mark: | The account token | CxoUzBTSV5hsxjTpFKaf |
| `backup_codes_created` | *Optional[bool]* | :heavy_minus_sign: | If the two-factor authentication backup codes have been created | |
| `confirmed` | *Optional[bool]* | :heavy_minus_sign: | If the account has been confirmed | |
| `country` | *str* | :heavy_check_mark: | The account country | US |
| `email` | *str* | :heavy_check_mark: | The account email address | username@email.com |
| `email_only_auth` | *Optional[bool]* | :heavy_minus_sign: | If login with email only is enabled | |
| `experimental_features` | *Optional[bool]* | :heavy_minus_sign: | If experimental features are enabled | |
| `friendly_name` | *str* | :heavy_check_mark: | Your account full name | friendlyUsername |
| `entitlements` | List[*str*] | :heavy_check_mark: | List of devices your allowed to use with this account | |
| `guest` | *Optional[bool]* | :heavy_minus_sign: | If the account is a Plex Home guest user | |
| `has_password` | *Optional[bool]* | :heavy_minus_sign: | If the account has a password | |
| `home` | *Optional[bool]* | :heavy_minus_sign: | If the account is a Plex Home user | |
| `home_admin` | *Optional[bool]* | :heavy_minus_sign: | If the account is the Plex Home admin | |
| `home_size` | *int* | :heavy_check_mark: | The number of accounts in the Plex Home | 1 |
| `id` | *int* | :heavy_check_mark: | The Plex account ID | 13692262 |
| `joined_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `locale` | *Nullable[str]* | :heavy_check_mark: | The account locale | |
| `mailing_list_active` | *Optional[bool]* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
| `mailing_list_status` | [operations.MailingListStatus](../../models/operations/mailingliststatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active |
| `max_home_size` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
| ~~`pin`~~ | *Optional[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
| `profile` | [operations.UserProfile](../../models/operations/userprofile.md) | :heavy_check_mark: | N/A | |
| `protected` | *Optional[bool]* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
| `remember_expires_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `restricted` | *Optional[bool]* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
| `roles` | List[*str*] | :heavy_minus_sign: | [Might be removed] List of account roles. Plexpass membership listed here | |
| `scrobble_types` | *str* | :heavy_check_mark: | Unknown | |
| `services` | List[[operations.Services](../../models/operations/services.md)] | :heavy_check_mark: | N/A | |
| `subscription` | [operations.Subscription](../../models/operations/subscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
| `subscription_description` | *Nullable[str]* | :heavy_check_mark: | Description of the Plex Pass subscription | |
| `subscriptions` | List[[operations.GetTokenDetailsSubscription](../../models/operations/gettokendetailssubscription.md)] | :heavy_minus_sign: | N/A | |
| `two_factor_enabled` | *Optional[bool]* | :heavy_minus_sign: | If two-factor authentication is enabled | |
| `thumb` | *str* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101 |
| `title` | *str* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
| `two_factor_enabled` | *Optional[bool]* | :heavy_minus_sign: | If two-factor authentication is enabled | |
| `username` | *str* | :heavy_check_mark: | The account username | Username |
| `uuid` | *str* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
| `attribution_partner` | *Nullable[str]* | :heavy_check_mark: | N/A | <nil> |

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

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | [operations.GetTopWatchedContentQueryParamType](../../models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `include_guids` | *Optional[int]* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `include_guids` | *Optional[int]* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `type` | [operations.GetTopWatchedContentQueryParamType](../../models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

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

@@ -6,7 +6,6 @@
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `client_id` | *str* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `x_plex_token` | *str* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
| `client_name` | *Optional[str]* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `device_nickname` | *Optional[str]* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `device_name` | *Optional[str]* | :heavy_minus_sign: | The name of the device the client application is running on. This is used to track the client application and its usage. (Chrome, Safari, etc.) | Chrome |
@@ -17,4 +16,5 @@
| `model` | *Optional[str]* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `x_plex_session_id` | *Optional[str]* | :heavy_minus_sign: | The session ID of the client application. This is used to track the client application and its usage. (97e136ef-4ddd-4ff3-89a7-a5820c96c2ca) | 97e136ef-4ddd-4ff3-89a7-a5820c96c2ca |
| `x_plex_language` | *Optional[str]* | :heavy_minus_sign: | The language of the client application. | en |
| `platform_version` | *Optional[str]* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `platform_version` | *Optional[str]* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `x_plex_token` | *str* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

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

@@ -6,11 +6,11 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filter_` | [operations.Filter](../../models/operations/filter_.md) | :heavy_check_mark: | Filter | |
| `x_plex_token` | *str* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
| `sort` | *Optional[str]* | :heavy_minus_sign: | In the format "field:dir". Available fields are "watchlistedAt" (Added At),<br/>"titleSort" (Title), "originallyAvailableAt" (Release Date), or "rating" (Critic Rating).<br/>"dir" can be "asc" or "desc"<br/> | |
| `libtype` | [Optional[operations.Libtype]](../../models/operations/libtype.md) | :heavy_minus_sign: | The type of library to filter. Can be "movie" or "show", or all if not present.<br/> | |
| `maxresults` | *Optional[int]* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/> | |
| `include_collections` | [Optional[operations.IncludeCollections]](../../models/operations/includecollections.md) | :heavy_minus_sign: | include collections in the results<br/> | |
| `include_external_media` | [Optional[operations.IncludeExternalMedia]](../../models/operations/includeexternalmedia.md) | :heavy_minus_sign: | include external media in the results<br/> | |
| `x_plex_container_start` | *Optional[int]* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `x_plex_container_size` | *Optional[int]* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
| `x_plex_container_size` | *Optional[int]* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
| `x_plex_token` | *str* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

11
docs/models/operations/hidden.md Normal file
View File

@@ -0,0 +1,11 @@
# Hidden
UNKNOWN
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

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

@@ -5,14 +5,14 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `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 |
| `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 |
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
| `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `file` | *str* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `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 |

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

@@ -9,14 +9,14 @@
| `mode` | *Nullable[str]* | :heavy_check_mark: | N/A | |
| `renews_at` | *Nullable[int]* | :heavy_check_mark: | N/A | 1556281940 |
| `ends_at` | *Nullable[int]* | :heavy_check_mark: | N/A | 1556281940 |
| `type` | *str* | :heavy_check_mark: | N/A | plexpass |
| `transfer` | *Nullable[str]* | :heavy_check_mark: | N/A | |
| `state` | [operations.PostUsersSignInDataState](../../models/operations/postuserssignindatastate.md) | :heavy_check_mark: | N/A | ended |
| `billing` | [operations.Billing](../../models/operations/billing.md) | :heavy_check_mark: | N/A | |
| `canceled` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `grace_period` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `on_hold` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `can_reactivate` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `can_upgrade` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `can_downgrade` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `can_convert` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `can_convert` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `type` | *str* | :heavy_check_mark: | N/A | plexpass |
| `transfer` | *Nullable[str]* | :heavy_check_mark: | N/A | |
| `state` | [operations.PostUsersSignInDataState](../../models/operations/postuserssignindatastate.md) | :heavy_check_mark: | N/A | ended |
| `billing` | [operations.Billing](../../models/operations/billing.md) | :heavy_check_mark: | N/A | |

50
docs/models/operations/postuserssignindatauserplexaccount.md
View File

@@ -10,43 +10,43 @@ Returns the user account data with a valid auth token
| `ads_consent` | *Nullable[bool]* | :heavy_check_mark: | Unknown | |
| `ads_consent_reminder_at` | *Nullable[int]* | :heavy_check_mark: | N/A | 1556281940 |
| `ads_consent_set_at` | *Nullable[int]* | :heavy_check_mark: | N/A | 1556281940 |
| `auth_token` | *str* | :heavy_check_mark: | The account token | CxoUzBTSV5hsxjTpFKaf |
| `country` | *str* | :heavy_check_mark: | The account country | US |
| `email` | *str* | :heavy_check_mark: | The account email address | username@email.com |
| `friendly_name` | *str* | :heavy_check_mark: | Your account full name | friendlyUsername |
| `entitlements` | List[*str*] | :heavy_check_mark: | List of devices your allowed to use with this account | |
| `home_size` | *int* | :heavy_check_mark: | The number of accounts in the Plex Home | 1 |
| `id` | *int* | :heavy_check_mark: | The Plex account ID | 13692262 |
| `joined_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `locale` | *Nullable[str]* | :heavy_check_mark: | The account locale | |
| `mailing_list_status` | [operations.PostUsersSignInDataMailingListStatus](../../models/operations/postuserssignindatamailingliststatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active |
| `max_home_size` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
| `profile` | [operations.PostUsersSignInDataUserProfile](../../models/operations/postuserssignindatauserprofile.md) | :heavy_check_mark: | N/A | |
| `remember_expires_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `scrobble_types` | *str* | :heavy_check_mark: | Unknown | |
| `services` | List[[operations.PostUsersSignInDataServices](../../models/operations/postuserssignindataservices.md)] | :heavy_check_mark: | N/A | |
| `subscription` | [operations.PostUsersSignInDataSubscription](../../models/operations/postuserssignindatasubscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
| `subscription_description` | *Nullable[str]* | :heavy_check_mark: | Description of the Plex Pass subscription | |
| `thumb` | *str* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101 |
| `title` | *str* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
| `username` | *str* | :heavy_check_mark: | The account username | Username |
| `uuid` | *str* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
| `attribution_partner` | *Nullable[str]* | :heavy_check_mark: | N/A | <nil> |
| `past_subscriptions` | List[[operations.PastSubscription](../../models/operations/pastsubscription.md)] | :heavy_check_mark: | N/A | |
| `trials` | List[[operations.Trials](../../models/operations/trials.md)] | :heavy_check_mark: | N/A | |
| `anonymous` | *OptionalNullable[bool]* | :heavy_minus_sign: | Unknown | |
| `auth_token` | *str* | :heavy_check_mark: | The account token | CxoUzBTSV5hsxjTpFKaf |
| `backup_codes_created` | *Optional[bool]* | :heavy_minus_sign: | If the two-factor authentication backup codes have been created | |
| `confirmed` | *Optional[bool]* | :heavy_minus_sign: | If the account has been confirmed | |
| `country` | *str* | :heavy_check_mark: | The account country | US |
| `email` | *str* | :heavy_check_mark: | The account email address | username@email.com |
| `email_only_auth` | *Optional[bool]* | :heavy_minus_sign: | If login with email only is enabled | |
| `experimental_features` | *Optional[bool]* | :heavy_minus_sign: | If experimental features are enabled | |
| `friendly_name` | *str* | :heavy_check_mark: | Your account full name | friendlyUsername |
| `entitlements` | List[*str*] | :heavy_check_mark: | List of devices your allowed to use with this account | |
| `guest` | *Optional[bool]* | :heavy_minus_sign: | If the account is a Plex Home guest user | |
| `has_password` | *Optional[bool]* | :heavy_minus_sign: | If the account has a password | |
| `home` | *Optional[bool]* | :heavy_minus_sign: | If the account is a Plex Home user | |
| `home_admin` | *Optional[bool]* | :heavy_minus_sign: | If the account is the Plex Home admin | |
| `home_size` | *int* | :heavy_check_mark: | The number of accounts in the Plex Home | 1 |
| `id` | *int* | :heavy_check_mark: | The Plex account ID | 13692262 |
| `joined_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `locale` | *Nullable[str]* | :heavy_check_mark: | The account locale | |
| `mailing_list_active` | *Optional[bool]* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
| `mailing_list_status` | [operations.PostUsersSignInDataMailingListStatus](../../models/operations/postuserssignindatamailingliststatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active |
| `max_home_size` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
| ~~`pin`~~ | *Optional[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
| `profile` | [operations.PostUsersSignInDataUserProfile](../../models/operations/postuserssignindatauserprofile.md) | :heavy_check_mark: | N/A | |
| `protected` | *Optional[bool]* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
| `remember_expires_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `restricted` | *Optional[bool]* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
| `roles` | List[*str*] | :heavy_minus_sign: | [Might be removed] List of account roles. Plexpass membership listed here | |
| `scrobble_types` | *str* | :heavy_check_mark: | Unknown | |
| `services` | List[[operations.PostUsersSignInDataServices](../../models/operations/postuserssignindataservices.md)] | :heavy_check_mark: | N/A | |
| `subscription` | [operations.PostUsersSignInDataSubscription](../../models/operations/postuserssignindatasubscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
| `subscription_description` | *Nullable[str]* | :heavy_check_mark: | Description of the Plex Pass subscription | |
| `subscriptions` | List[[operations.PostUsersSignInDataAuthenticationSubscription](../../models/operations/postuserssignindataauthenticationsubscription.md)] | :heavy_minus_sign: | N/A | |
| `two_factor_enabled` | *Optional[bool]* | :heavy_minus_sign: | If two-factor authentication is enabled | |
| `thumb` | *str* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101 |
| `title` | *str* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
| `two_factor_enabled` | *Optional[bool]* | :heavy_minus_sign: | If two-factor authentication is enabled | |
| `username` | *str* | :heavy_check_mark: | The account username | Username |
| `uuid` | *str* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
| `attribution_partner` | *Nullable[str]* | :heavy_check_mark: | N/A | <nil> |
| `past_subscriptions` | List[[operations.PastSubscription](../../models/operations/pastsubscription.md)] | :heavy_check_mark: | N/A | |
| `trials` | List[[operations.Trials](../../models/operations/trials.md)] | :heavy_check_mark: | N/A | |

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

@@ -5,9 +5,9 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `auto_select_audio` | *Optional[bool]* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
| `default_audio_language` | *Nullable[str]* | :heavy_check_mark: | The preferred audio language for the account | ja |
| `default_subtitle_language` | *Nullable[str]* | :heavy_check_mark: | The preferred subtitle language for the account | en |
| `auto_select_audio` | *Optional[bool]* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
| `auto_select_subtitle` | [Optional[operations.PostUsersSignInDataAutoSelectSubtitle]](../../models/operations/postuserssignindataautoselectsubtitle.md) | :heavy_minus_sign: | N/A | 1 |
| `default_subtitle_accessibility` | [Optional[operations.PostUsersSignInDataDefaultSubtitleAccessibility]](../../models/operations/postuserssignindatadefaultsubtitleaccessibility.md) | :heavy_minus_sign: | N/A | 1 |
| `default_subtitle_forced` | [Optional[operations.PostUsersSignInDataDefaultSubtitleForced]](../../models/operations/postuserssignindatadefaultsubtitleforced.md) | :heavy_minus_sign: | N/A | 1 |

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

@@ -5,11 +5,11 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `key` | *str* | :heavy_check_mark: | N/A | titleSort |
| `title` | *str* | :heavy_check_mark: | N/A | Title |
| `default` | *Optional[str]* | :heavy_minus_sign: | N/A | asc |
| `active` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `active_direction` | [Optional[operations.ActiveDirection]](../../models/operations/activedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `default_direction` | [Optional[operations.DefaultDirection]](../../models/operations/defaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `desc_key` | *Optional[str]* | :heavy_minus_sign: | N/A | titleSort:desc |
| `first_character_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `first_character_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `key` | *str* | :heavy_check_mark: | N/A | titleSort |
| `title` | *str* | :heavy_check_mark: | N/A | Title |

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

@@ -7,11 +7,9 @@
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `stream_type` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `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 |
@@ -45,6 +43,8 @@
| `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 |
| `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) |
| `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 |

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

@@ -9,9 +9,8 @@
| `title` | *str* | :heavy_check_mark: | User's display name. | Plex User |
| `username` | *str* | :heavy_check_mark: | User's username. | zgfuc7krcqfimrmb9lsl5j |
| `email` | *str* | :heavy_check_mark: | User's email address. | zgfuc7krcqfimrmb9lsl5j@protonmail.com |
| `thumb` | *str* | :heavy_check_mark: | URL to the user's avatar image. | https://plex.tv/users/3346028014e93acd/avatar?c=1731605021 |
| `server` | List[[operations.GetUsersServer](../../models/operations/getusersserver.md)] | :heavy_check_mark: | List of servers owned by the user. | |
| `recommendations_playlist_id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID of the user's recommendation playlist. | |
| `thumb` | *str* | :heavy_check_mark: | URL to the user's avatar image. | https://plex.tv/users/3346028014e93acd/avatar?c=1731605021 |
| `protected` | [Optional[operations.Protected]](../../models/operations/protected.md) | :heavy_minus_sign: | N/A | 1 |
| `home` | [Optional[operations.Home]](../../models/operations/home.md) | :heavy_minus_sign: | N/A | 1 |
| `allow_tuners` | [Optional[operations.AllowTuners]](../../models/operations/allowtuners.md) | :heavy_minus_sign: | N/A | 1 |
@@ -24,4 +23,5 @@
| `filter_music` | *OptionalNullable[str]* | :heavy_minus_sign: | Filters applied for music. | |
| `filter_photos` | *OptionalNullable[str]* | :heavy_minus_sign: | Filters applied for photos. | |
| `filter_television` | *Optional[str]* | :heavy_minus_sign: | Filters applied for television. | |
| `restricted` | [Optional[operations.Restricted]](../../models/operations/restricted.md) | :heavy_minus_sign: | N/A | 1 |
| `restricted` | [Optional[operations.Restricted]](../../models/operations/restricted.md) | :heavy_minus_sign: | N/A | 1 |
| `server` | List[[operations.GetUsersServer](../../models/operations/getusersserver.md)] | :heavy_check_mark: | List of servers owned by the user. | |

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

@@ -5,9 +5,9 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `auto_select_audio` | *Optional[bool]* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
| `default_audio_language` | *Nullable[str]* | :heavy_check_mark: | The preferred audio language for the account | ja |
| `default_subtitle_language` | *Nullable[str]* | :heavy_check_mark: | The preferred subtitle language for the account | en |
| `auto_select_audio` | *Optional[bool]* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
| `auto_select_subtitle` | [Optional[operations.AutoSelectSubtitle]](../../models/operations/autoselectsubtitle.md) | :heavy_minus_sign: | N/A | 1 |
| `default_subtitle_accessibility` | [Optional[operations.DefaultSubtitleAccessibility]](../../models/operations/defaultsubtitleaccessibility.md) | :heavy_minus_sign: | N/A | 1 |
| `default_subtitle_forced` | [Optional[operations.DefaultSubtitleForced]](../../models/operations/defaultsubtitleforced.md) | :heavy_minus_sign: | N/A | 1 |

2
docs/sdks/hubs/README.md
View File

@@ -73,8 +73,8 @@ with PlexAPI(
res = plex_api.hubs.get_recently_added(request={
"content_directory_id": 470161,
"type": operations.Type.TV_SHOW,
"section_id": 2,
"type": operations.Type.TV_SHOW,
})
assert res.object is not None

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

@@ -89,7 +89,6 @@ with PlexAPI(
) as plex_api:
res = plex_api.library.get_recently_added_library(request={
"type": operations.QueryParamType.TV_SHOW,
"content_directory_id": 2,
"pinned_content_directory_id": [
3,
@@ -106,6 +105,7 @@ with PlexAPI(
17,
],
"section_id": 2,
"type": operations.QueryParamType.TV_SHOW,
})
assert res.object is not None

2
docs/sdks/server/README.md
View File

@@ -280,11 +280,11 @@ with PlexAPI(
res = plex_api.server.get_resized_photo(request={
"width": 110,
"height": 165,
"opacity": 100,
"blur": 0,
"min_size": operations.MinSize.ONE,
"upscale": operations.Upscale.ONE,
"url": "/library/metadata/49564/thumb/1654258204",
"opacity": 100,
})
assert res is not None

2
docs/sdks/users/README.md
View File

@@ -21,7 +21,6 @@ with PlexAPI() as plex_api:
res = plex_api.users.get_users(request={
"client_id": "3381b62b-9ab7-4e37-827b-203e9809eb58",
"x_plex_token": "CV5xoxjTpFKUzBTShsaf",
"client_name": "Plex for Roku",
"device_nickname": "Roku 3",
"device_name": "Chrome",
@@ -33,6 +32,7 @@ with PlexAPI() as plex_api:
"x_plex_session_id": "97e136ef-4ddd-4ff3-89a7-a5820c96c2ca",
"x_plex_language": "en",
"platform_version": "4.3 build 1057",
"x_plex_token": "CV5xoxjTpFKUzBTShsaf",
})
assert res.body is not None

6
pylintrc
View File

@@ -188,10 +188,10 @@ good-names=i,
Run,
_,
e,
ip,
at,
id,
qr,
at
ip,
qr
# Good variable names regexes, separated by a comma. If names match any regex,
# they will always be accepted

2
pyproject.toml
View File

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

6
src/plex_api_client/_version.py
View File

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

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

@@ -93,6 +93,8 @@ from .get_all_libraries import (
GetAllLibrariesResponseBody,
GetAllLibrariesResponseBodyTypedDict,
GetAllLibrariesResponseTypedDict,
GetAllLibrariesType,
Hidden,
)
from .get_all_media_library import (
GetAllMediaLibraryActiveDirection,
@@ -1369,6 +1371,7 @@ __all__ = [
"GetAllLibrariesResponseBody",
"GetAllLibrariesResponseBodyTypedDict",
"GetAllLibrariesResponseTypedDict",
"GetAllLibrariesType",
"GetAllMediaLibraryActiveDirection",
"GetAllMediaLibraryCollection",
"GetAllMediaLibraryCollectionTypedDict",
@@ -2083,6 +2086,7 @@ __all__ = [
"Guids",
"GuidsTypedDict",
"HasThumbnail",
"Hidden",
"Home",
"Hub",
"HubTypedDict",

91
src/plex_api_client/models/operations/get_all_libraries.py
View File

@@ -1,6 +1,7 @@
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
from __future__ import annotations
from enum import Enum
import httpx
from plex_api_client.types import BaseModel
import pydantic
@@ -8,124 +9,178 @@ from typing import List, Optional
from typing_extensions import Annotated, NotRequired, TypedDict
class GetAllLibrariesType(str, Enum):
r"""The library type"""
MOVIE = "movie"
TV_SHOW = "show"
SEASON = "season"
EPISODE = "episode"
ARTIST = "artist"
ALBUM = "album"
class Hidden(int, Enum):
r"""UNKNOWN"""
DISABLE = 0
ENABLE = 1
class GetAllLibrariesLocationTypedDict(TypedDict):
id: int
r"""The ID of the location."""
path: str
r"""The path to the media item."""
class GetAllLibrariesLocation(BaseModel):
id: int
r"""The ID of the location."""
path: str
r"""The path to the media item."""
class GetAllLibrariesDirectoryTypedDict(TypedDict):
allow_sync: bool
r"""Indicates whether syncing is allowed."""
art: str
r"""URL for the background artwork of the media container."""
composite: str
r"""The relative path to the composite media item."""
filters: bool
r"""UNKNOWN"""
refreshing: bool
r"""Indicates whether the library is currently being refreshed or updated"""
thumb: str
r"""URL for the thumbnail image of the media container."""
key: str
type: str
r"""The library key representing the unique identifier"""
type: GetAllLibrariesType
title: str
r"""The title of the library"""
agent: str
r"""The Plex agent used to match and retrieve media metadata."""
scanner: str
r"""UNKNOWN"""
language: str
r"""The Plex library language that has been set"""
uuid: str
r"""The universally unique identifier for the library."""
updated_at: int
r"""Unix epoch datetime in seconds"""
created_at: int
r"""Unix epoch datetime in seconds"""
scanned_at: int
r"""Unix epoch datetime in seconds"""
content: bool
r"""UNKNOWN"""
directory: bool
r"""UNKNOWN"""
content_changed_at: int
r"""Unix epoch datetime in seconds"""
hidden: int
r"""The number of seconds since the content was last changed relative to now."""
location: List[GetAllLibrariesLocationTypedDict]
created_at: NotRequired[int]
hidden: NotRequired[Hidden]
class GetAllLibrariesDirectory(BaseModel):
allow_sync: Annotated[bool, pydantic.Field(alias="allowSync")]
r"""Indicates whether syncing is allowed."""
art: str
r"""URL for the background artwork of the media container."""
composite: str
r"""The relative path to the composite media item."""
filters: bool
r"""UNKNOWN"""
refreshing: bool
r"""Indicates whether the library is currently being refreshed or updated"""
thumb: str
r"""URL for the thumbnail image of the media container."""
key: str
r"""The library key representing the unique identifier"""
type: str
type: GetAllLibrariesType
title: str
r"""The title of the library"""
agent: str
r"""The Plex agent used to match and retrieve media metadata."""
scanner: str
r"""UNKNOWN"""
language: str
r"""The Plex library language that has been set"""
uuid: str
r"""The universally unique identifier for the library."""
updated_at: Annotated[int, pydantic.Field(alias="updatedAt")]
r"""Unix epoch datetime in seconds"""
created_at: Annotated[int, pydantic.Field(alias="createdAt")]
r"""Unix epoch datetime in seconds"""
scanned_at: Annotated[int, pydantic.Field(alias="scannedAt")]
r"""Unix epoch datetime in seconds"""
content: bool
r"""UNKNOWN"""
directory: bool
r"""UNKNOWN"""
content_changed_at: Annotated[int, pydantic.Field(alias="contentChangedAt")]
r"""Unix epoch datetime in seconds"""
hidden: int
r"""The number of seconds since the content was last changed relative to now."""
location: Annotated[List[GetAllLibrariesLocation], pydantic.Field(alias="Location")]
created_at: Annotated[Optional[int], pydantic.Field(alias="createdAt")] = None
hidden: Optional[Hidden] = Hidden.DISABLE
class GetAllLibrariesMediaContainerTypedDict(TypedDict):
size: int
r"""Number of media items returned in this response."""
allow_sync: bool
r"""Indicates whether syncing is allowed."""
title1: str
directory: List[GetAllLibrariesDirectoryTypedDict]
r"""The primary title of the media container."""
directory: NotRequired[List[GetAllLibrariesDirectoryTypedDict]]
class GetAllLibrariesMediaContainer(BaseModel):
size: int
r"""Number of media items returned in this response."""
allow_sync: Annotated[bool, pydantic.Field(alias="allowSync")]
r"""Indicates whether syncing is allowed."""
title1: str
r"""The primary title of the media container."""
directory: Annotated[
List[GetAllLibrariesDirectory], pydantic.Field(alias="Directory")
]
Optional[List[GetAllLibrariesDirectory]], pydantic.Field(alias="Directory")
] = None
class GetAllLibrariesResponseBodyTypedDict(TypedDict):
r"""The libraries available on the Server"""
media_container: GetAllLibrariesMediaContainerTypedDict
media_container: NotRequired[GetAllLibrariesMediaContainerTypedDict]
class GetAllLibrariesResponseBody(BaseModel):
r"""The libraries available on the Server"""
media_container: Annotated[
GetAllLibrariesMediaContainer, pydantic.Field(alias="MediaContainer")
]
Optional[GetAllLibrariesMediaContainer], pydantic.Field(alias="MediaContainer")
] = None
class GetAllLibrariesResponseTypedDict(TypedDict):

2
src/plex_api_client/models/operations/gettokendetails.py
View File

@@ -627,10 +627,10 @@ class GetTokenDetailsUserPlexAccount(BaseModel):
"adsConsent",
"adsConsentReminderAt",
"adsConsentSetAt",
"anonymous",
"locale",
"subscriptionDescription",
"attributionPartner",
"anonymous",
]
null_default_fields = []

2
src/plex_api_client/models/operations/post_users_sign_in_data.py
View File

@@ -886,10 +886,10 @@ class PostUsersSignInDataUserPlexAccount(BaseModel):
"adsConsent",
"adsConsentReminderAt",
"adsConsentSetAt",
"anonymous",
"locale",
"subscriptionDescription",
"attributionPartner",
"anonymous",
]
null_default_fields = []