mirror of
https://github.com/LukeHagar/plexpy.git
synced 2025-12-06 04:20:52 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.487.1
This commit is contained in:
speakeasybot
File diff suppressed because one or more lines are too long
@@ -13,7 +13,7 @@ generation:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
oAuth2PasswordEnabled: false
|
||||
python:
|
||||
version: 0.22.0
|
||||
version: 0.22.1
|
||||
additionalDependencies:
|
||||
dev: {}
|
||||
main: {}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.487.0
|
||||
speakeasyVersion: 1.487.1
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
@@ -8,19 +8,19 @@ sources:
|
||||
- latest
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:e6ab335dd91a4165f4510e4a3af8a55819c6310b7e66251266d2384376f3ccae
|
||||
sourceBlobDigest: sha256:89d1b1133e400c89f0d06efe5e5168f5ba25a413e1ab8380d442d6b233e2e5a9
|
||||
sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64
|
||||
sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8
|
||||
tags:
|
||||
- latest
|
||||
- speakeasy-sdk-regen-1738886477
|
||||
- speakeasy-sdk-regen-1738972888
|
||||
targets:
|
||||
plexpy:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:e6ab335dd91a4165f4510e4a3af8a55819c6310b7e66251266d2384376f3ccae
|
||||
sourceBlobDigest: sha256:89d1b1133e400c89f0d06efe5e5168f5ba25a413e1ab8380d442d6b233e2e5a9
|
||||
sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64
|
||||
sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8
|
||||
codeSamplesNamespace: code-samples-python-plexpy
|
||||
codeSamplesRevisionDigest: sha256:7c876b753cb5ce60e78319a51e8a0a436679e86c4e4a90d423d73532459dac53
|
||||
codeSamplesRevisionDigest: sha256:ad966264da2ccb1f43501d2435d91d5bf795538ec83e99a3f4a2f97acee1293a
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
|
||||
@@ -219,8 +219,9 @@ asyncio.run(main())
|
||||
* [get_search_library](docs/sdks/library/README.md#get_search_library) - Search Library
|
||||
* [get_genres_library](docs/sdks/library/README.md#get_genres_library) - Get Genres of library media
|
||||
* [get_countries_library](docs/sdks/library/README.md#get_countries_library) - Get Countries of library media
|
||||
* [get_actors_library](docs/sdks/library/README.md#get_actors_library) - Get Actors of library media
|
||||
* [get_search_all_libraries](docs/sdks/library/README.md#get_search_all_libraries) - Search All Libraries
|
||||
* [get_meta_data_by_rating_key](docs/sdks/library/README.md#get_meta_data_by_rating_key) - Get Metadata by RatingKey
|
||||
* [get_media_meta_data](docs/sdks/library/README.md#get_media_meta_data) - Get Media Metadata
|
||||
* [get_metadata_children](docs/sdks/library/README.md#get_metadata_children) - Get Items Children
|
||||
* [get_top_watched_content](docs/sdks/library/README.md#get_top_watched_content) - Get Top Watched Content
|
||||
* [get_on_deck](docs/sdks/library/README.md#get_on_deck) - Get On Deck
|
||||
|
||||
10
RELEASES.md
10
RELEASES.md
@@ -929,3 +929,13 @@ Based on:
|
||||
- [python v0.22.0] .
|
||||
### Releases
|
||||
- [PyPI v0.22.0] https://pypi.org/project/plex-api-client/0.22.0 - .
|
||||
|
||||
## 2025-02-08 00:01:13
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.487.1 (2.506.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [python v0.22.1] .
|
||||
### Releases
|
||||
- [PyPI v0.22.1] https://pypi.org/project/plex-api-client/0.22.1 - .
|
||||
@@ -509,7 +509,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: python
|
||||
label: key
|
||||
label: data
|
||||
source: |-
|
||||
from plex_api_client import PlexAPI
|
||||
|
||||
@@ -517,7 +517,22 @@ actions:
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
) as plex_api:
|
||||
|
||||
res = plex_api.library.get_meta_data_by_rating_key(rating_key=9518)
|
||||
res = plex_api.library.get_media_meta_data(request={
|
||||
"rating_key": 9518,
|
||||
"include_concerts": True,
|
||||
"include_extras": True,
|
||||
"include_on_deck": True,
|
||||
"include_popular_leaves": True,
|
||||
"include_preferences": True,
|
||||
"include_reviews": True,
|
||||
"include_chapters": True,
|
||||
"include_stations": True,
|
||||
"include_external_media": True,
|
||||
"async_augment_metadata": True,
|
||||
"async_check_files": True,
|
||||
"async_refresh_analysis": True,
|
||||
"async_refresh_local_media_agent": True,
|
||||
})
|
||||
|
||||
assert res.object is not None
|
||||
|
||||
@@ -745,6 +760,25 @@ actions:
|
||||
|
||||
assert res.object is not None
|
||||
|
||||
# Handle response
|
||||
print(res.object)
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/actor"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: python
|
||||
label: library
|
||||
source: |-
|
||||
from plex_api_client import PlexAPI
|
||||
from plex_api_client.models import operations
|
||||
|
||||
with PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
) as plex_api:
|
||||
|
||||
res = plex_api.library.get_actors_library(section_key=9518, type_=operations.GetActorsLibraryQueryParamType.TV_SHOW)
|
||||
|
||||
assert res.object is not None
|
||||
|
||||
# Handle response
|
||||
print(res.object)
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/country"]["get"]
|
||||
@@ -754,12 +788,13 @@ actions:
|
||||
label: library
|
||||
source: |-
|
||||
from plex_api_client import PlexAPI
|
||||
from plex_api_client.models import operations
|
||||
|
||||
with PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
) as plex_api:
|
||||
|
||||
res = plex_api.library.get_countries_library(section_key=9518)
|
||||
res = plex_api.library.get_countries_library(section_key=9518, type_=operations.GetCountriesLibraryQueryParamType.TV_SHOW)
|
||||
|
||||
assert res.object is not None
|
||||
|
||||
@@ -772,12 +807,13 @@ actions:
|
||||
label: library
|
||||
source: |-
|
||||
from plex_api_client import PlexAPI
|
||||
from plex_api_client.models import operations
|
||||
|
||||
with PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
) as plex_api:
|
||||
|
||||
res = plex_api.library.get_genres_library(section_key=9518)
|
||||
res = plex_api.library.get_genres_library(section_key=9518, type_=operations.GetGenresLibraryQueryParamType.TV_SHOW)
|
||||
|
||||
assert res.object is not None
|
||||
|
||||
|
||||
11
docs/models/errors/getactorslibrarybadrequest.md
Normal file
11
docs/models/errors/getactorslibrarybadrequest.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetActorsLibraryBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.GetActorsLibraryErrors](../../models/errors/getactorslibraryerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetMetaDataByRatingKeyErrors
|
||||
# GetActorsLibraryErrors
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetMetaDataByRatingKeyLibraryErrors
|
||||
# GetActorsLibraryLibraryErrors
|
||||
|
||||
|
||||
## Fields
|
||||
11
docs/models/errors/getactorslibraryunauthorized.md
Normal file
11
docs/models/errors/getactorslibraryunauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetActorsLibraryUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetActorsLibraryLibraryErrors](../../models/errors/getactorslibrarylibraryerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
11
docs/models/errors/getmediametadatabadrequest.md
Normal file
11
docs/models/errors/getmediametadatabadrequest.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetMediaMetaDataBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.GetMediaMetaDataErrors](../../models/errors/getmediametadataerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
10
docs/models/errors/getmediametadataerrors.md
Normal file
10
docs/models/errors/getmediametadataerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
10
docs/models/errors/getmediametadatalibraryerrors.md
Normal file
10
docs/models/errors/getmediametadatalibraryerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataLibraryErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/getmediametadataunauthorized.md
Normal file
11
docs/models/errors/getmediametadataunauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetMediaMetaDataUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetMediaMetaDataLibraryErrors](../../models/errors/getmediametadatalibraryerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetMetaDataByRatingKeyBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.GetMetaDataByRatingKeyErrors](../../models/errors/getmetadatabyratingkeyerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetMetaDataByRatingKeyUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetMetaDataByRatingKeyLibraryErrors](../../models/errors/getmetadatabyratingkeylibraryerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
11
docs/models/operations/getactorslibrarydirectory.md
Normal file
11
docs/models/operations/getactorslibrarydirectory.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetActorsLibraryDirectory
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `fast_key` | *str* | :heavy_check_mark: | A fast lookup key for the actor relative url. | /library/sections/2/all?actor=134671 |
|
||||
| `thumb` | *str* | :heavy_check_mark: | URL for the thumbnail image of the actor. | https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg |
|
||||
| `key` | *str* | :heavy_check_mark: | A unique key representing the actor. | 134671 |
|
||||
| `title` | *str* | :heavy_check_mark: | The name of the actor. | Aaron Paul |
|
||||
20
docs/models/operations/getactorslibrarymediacontainer.md
Normal file
20
docs/models/operations/getactorslibrarymediacontainer.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# GetActorsLibraryMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *float* | :heavy_check_mark: | N/A | 50 |
|
||||
| `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 |
|
||||
| `identifier` | *str* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `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 |
|
||||
| `nocache` | *bool* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||
| `thumb` | *str* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `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 |
|
||||
| `view_mode` | *str* | :heavy_check_mark: | Identifier for the view mode. | 131131 |
|
||||
| `directory` | List[[operations.GetActorsLibraryDirectory](../../models/operations/getactorslibrarydirectory.md)] | :heavy_minus_sign: | An array of actor entries for media items. | |
|
||||
22
docs/models/operations/getactorslibraryqueryparamtype.md
Normal file
22
docs/models/operations/getactorslibraryqueryparamtype.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# GetActorsLibraryQueryParamType
|
||||
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `MOVIE` | 1 |
|
||||
| `TV_SHOW` | 2 |
|
||||
| `SEASON` | 3 |
|
||||
| `EPISODE` | 4 |
|
||||
| `AUDIO` | 8 |
|
||||
| `ALBUM` | 9 |
|
||||
| `TRACK` | 10 |
|
||||
9
docs/models/operations/getactorslibraryrequest.md
Normal file
9
docs/models/operations/getactorslibraryrequest.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetActorsLibraryRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
| `type` | [operations.GetActorsLibraryQueryParamType](../../models/operations/getactorslibraryqueryparamtype.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 |
|
||||
11
docs/models/operations/getactorslibraryresponse.md
Normal file
11
docs/models/operations/getactorslibraryresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetActorsLibraryResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [Optional[operations.GetActorsLibraryResponseBody]](../../models/operations/getactorslibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||
10
docs/models/operations/getactorslibraryresponsebody.md
Normal file
10
docs/models/operations/getactorslibraryresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetActorsLibraryResponseBody
|
||||
|
||||
Successful response containing media container data.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `media_container` | [Optional[operations.GetActorsLibraryMediaContainer]](../../models/operations/getactorslibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
22
docs/models/operations/getcountrieslibraryqueryparamtype.md
Normal file
22
docs/models/operations/getcountrieslibraryqueryparamtype.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# GetCountriesLibraryQueryParamType
|
||||
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `MOVIE` | 1 |
|
||||
| `TV_SHOW` | 2 |
|
||||
| `SEASON` | 3 |
|
||||
| `EPISODE` | 4 |
|
||||
| `AUDIO` | 8 |
|
||||
| `ALBUM` | 9 |
|
||||
| `TRACK` | 10 |
|
||||
@@ -3,6 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
| 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 |
|
||||
| `type` | [operations.GetCountriesLibraryQueryParamType](../../models/operations/getcountrieslibraryqueryparamtype.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 |
|
||||
22
docs/models/operations/getgenreslibraryqueryparamtype.md
Normal file
22
docs/models/operations/getgenreslibraryqueryparamtype.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# GetGenresLibraryQueryParamType
|
||||
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `MOVIE` | 1 |
|
||||
| `TV_SHOW` | 2 |
|
||||
| `SEASON` | 3 |
|
||||
| `EPISODE` | 4 |
|
||||
| `AUDIO` | 8 |
|
||||
| `ALBUM` | 9 |
|
||||
| `TRACK` | 10 |
|
||||
@@ -3,6 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
| 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 |
|
||||
| `type` | [operations.GetGenresLibraryQueryParamType](../../models/operations/getgenreslibraryqueryparamtype.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 |
|
||||
@@ -1,6 +1,6 @@
|
||||
# GetLibraryItemsQueryParamType
|
||||
|
||||
The type of media to retrieve.
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `tag` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||
| `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 |
|
||||
| `type` | [Optional[operations.GetLibraryItemsQueryParamType]](../../models/operations/getlibraryitemsqueryparamtype.md) | :heavy_minus_sign: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `tag` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||
| `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 |
|
||||
10
docs/models/operations/getmediametadatacountry.md
Normal file
10
docs/models/operations/getmediametadatacountry.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataCountry
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | The unique country identifier. | 58591 |
|
||||
| `filter_` | *str* | :heavy_check_mark: | The filter string for the country. | country=58591 |
|
||||
| `tag` | *str* | :heavy_check_mark: | The country name. | United States of America |
|
||||
13
docs/models/operations/getmediametadatadirector.md
Normal file
13
docs/models/operations/getmediametadatadirector.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetMediaMetaDataDirector
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||
| `filter_` | *str* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `tag` | *str* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `tag_key` | *str* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `role` | *Optional[str]* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `thumb` | *Optional[str]* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||
10
docs/models/operations/getmediametadatagenre.md
Normal file
10
docs/models/operations/getmediametadatagenre.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataGenre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | The unique genre identifier. | 1057 |
|
||||
| `filter_` | *str* | :heavy_check_mark: | The filter string for the genre. | genre=1057 |
|
||||
| `tag` | *str* | :heavy_check_mark: | The genre name. | Crime |
|
||||
10
docs/models/operations/getmediametadataimage.md
Normal file
10
docs/models/operations/getmediametadataimage.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataImage
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| `alt` | *str* | :heavy_check_mark: | Alternate text for the image. | Better Call Saul |
|
||||
| `type` | *str* | :heavy_check_mark: | The type of image (e.g., coverPoster, background, clearLogo). | coverPoster |
|
||||
| `url` | *str* | :heavy_check_mark: | The URL of the image. | /library/metadata/44288/thumb/1736487993 |
|
||||
8
docs/models/operations/getmediametadatalocation.md
Normal file
8
docs/models/operations/getmediametadatalocation.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetMediaMetaDataLocation
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `path` | *str* | :heavy_check_mark: | The file path for the location. | /TV Shows/Better Call Saul |
|
||||
22
docs/models/operations/getmediametadatamedia.md
Normal file
22
docs/models/operations/getmediametadatamedia.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# GetMediaMetaDataMedia
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||
| `duration` | *int* | :heavy_check_mark: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *int* | :heavy_check_mark: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *int* | :heavy_check_mark: | Video width in pixels. | 3840 |
|
||||
| `height` | *int* | :heavy_check_mark: | Video height in pixels. | 1602 |
|
||||
| `aspect_ratio` | *float* | :heavy_check_mark: | Aspect ratio of the video. | 2.35 |
|
||||
| `audio_channels` | *int* | :heavy_check_mark: | Number of audio channels. | 6 |
|
||||
| `audio_codec` | *str* | :heavy_check_mark: | Audio codec used. | eac3 |
|
||||
| `video_codec` | *str* | :heavy_check_mark: | Video codec used. | hevc |
|
||||
| `video_resolution` | *str* | :heavy_check_mark: | Video resolution (e.g., 4k). | 4k |
|
||||
| `container` | *str* | :heavy_check_mark: | File container type. | mkv |
|
||||
| `video_frame_rate` | *str* | :heavy_check_mark: | Frame rate of the video (e.g., 24p). | 24p |
|
||||
| `video_profile` | *str* | :heavy_check_mark: | Video profile (e.g., main 10). | main 10 |
|
||||
| `has_voice_activity` | *bool* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
|
||||
| `part` | List[[operations.GetMediaMetaDataPart](../../models/operations/getmediametadatapart.md)] | :heavy_check_mark: | An array of parts for this media item. | |
|
||||
16
docs/models/operations/getmediametadatamediacontainer.md
Normal file
16
docs/models/operations/getmediametadatamediacontainer.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# GetMediaMetaDataMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `size` | *float* | :heavy_check_mark: | N/A | 50 |
|
||||
| `allow_sync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `identifier` | *str* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `library_section_id` | *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 |
|
||||
| `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 |
|
||||
@@ -1,45 +1,66 @@
|
||||
# GetMetaDataByRatingKeyMetadata
|
||||
# GetMediaMetaDataMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `rating_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 17 |
|
||||
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/17 |
|
||||
| `guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://movie/5d77683f6f4521001ea9dc53 |
|
||||
| `studio` | *Optional[str]* | :heavy_minus_sign: | N/A | Universal Pictures |
|
||||
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Serenity |
|
||||
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `library_section_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||
| `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | The name of the album artist for the track when audio, and the name of the TV show for the episode when video. | |
|
||||
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | The name of the album for the track when audio, and the name of the season for the episode when TV show. | |
|
||||
| `original_title` | *Optional[str]* | :heavy_minus_sign: | The orginal untranslated name of the media item when non-english. | |
|
||||
| `index` | *Optional[int]* | :heavy_minus_sign: | The index starting from 0 of this media item in the MetaData array. | |
|
||||
| `parent_index` | *Optional[int]* | :heavy_minus_sign: | The parent index starting from 0 of this media item in the parent MetaData array. | |
|
||||
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *Optional[str]* | :heavy_minus_sign: | N/A | Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job. |
|
||||
| `rating` | *Optional[float]* | :heavy_minus_sign: | N/A | 8.2 |
|
||||
| `audience_rating` | *Optional[float]* | :heavy_minus_sign: | N/A | 9.1 |
|
||||
| `year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2005 |
|
||||
| `tagline` | *Optional[str]* | :heavy_minus_sign: | N/A | They aim to misbehave. |
|
||||
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/17/thumb/1705637165 |
|
||||
| `art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/17/art/1705637165 |
|
||||
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | N/A | 2005-09-29 00:00:00 +0000 UTC |
|
||||
| `added_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1705637164 |
|
||||
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1705637165 |
|
||||
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `has_premium_primary_extra` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `media` | List[[operations.GetMetaDataByRatingKeyMedia](../../models/operations/getmetadatabyratingkeymedia.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | List[[operations.GetMetaDataByRatingKeyGenre](../../models/operations/getmetadatabyratingkeygenre.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | List[[operations.GetMetaDataByRatingKeyCountry](../../models/operations/getmetadatabyratingkeycountry.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | List[[operations.Guids](../../models/operations/guids.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `ratings` | List[[operations.Ratings](../../models/operations/ratings.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `director` | List[[operations.GetMetaDataByRatingKeyDirector](../../models/operations/getmetadatabyratingkeydirector.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | List[[operations.GetMetaDataByRatingKeyWriter](../../models/operations/getmetadatabyratingkeywriter.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | List[[operations.GetMetaDataByRatingKeyRole](../../models/operations/getmetadatabyratingkeyrole.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `producer` | List[[operations.Producer](../../models/operations/producer.md)] | :heavy_minus_sign: | N/A | |
|
||||
| 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 |
|
||||
| `content_rating` | *str* | :heavy_check_mark: | 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. |
|
||||
| `audience_rating` | *float* | :heavy_check_mark: | The audience rating for the content. | 8.7 |
|
||||
| `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 |
|
||||
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | The original release date. | 2015-02-08 |
|
||||
| `added_at` | *int* | :heavy_check_mark: | Unix timestamp when the item was added. | 1625505101 |
|
||||
| `updated_at` | *int* | :heavy_check_mark: | Unix timestamp when the item was last updated. | 1736487993 |
|
||||
| `audience_rating_image` | *str* | :heavy_check_mark: | The URL for the audience rating image. | themoviedb://image.rating |
|
||||
| `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 | |
|
||||
| `guids` | List[[operations.Guids](../../models/operations/guids.md)] | :heavy_check_mark: | An array of GUID objects. | |
|
||||
| `rating` | List[[operations.Rating](../../models/operations/rating.md)] | :heavy_check_mark: | An array of rating objects. | |
|
||||
| `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 |
|
||||
| `grandparent_guid` | *Optional[str]* | :heavy_minus_sign: | A GUID identifying the grandparent entity (e.g., show). | plex://show/5e16253691c20300412003a8 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `original_title` | *Optional[str]* | :heavy_minus_sign: | The original title of the content. | Wicked: Part I |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `theme` | *Optional[str]* | :heavy_minus_sign: | URL of the theme image. | /library/metadata/44288/theme/1736487993 |
|
||||
| `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 |
|
||||
| `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 | |
|
||||
| `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. | |
|
||||
| `role` | List[[operations.GetMediaMetaDataRole](../../models/operations/getmediametadatarole.md)] | :heavy_minus_sign: | An array of Actor roles. | |
|
||||
| `director` | List[[operations.GetMediaMetaDataDirector](../../models/operations/getmediametadatadirector.md)] | :heavy_minus_sign: | An array of Director roles. | |
|
||||
| `writer` | List[[operations.GetMediaMetaDataWriter](../../models/operations/getmediametadatawriter.md)] | :heavy_minus_sign: | An array of Writer roles. | |
|
||||
| `producer` | List[[operations.Producer](../../models/operations/producer.md)] | :heavy_minus_sign: | An array of Writer roles. | |
|
||||
| `similar` | List[[operations.Similar](../../models/operations/similar.md)] | :heavy_minus_sign: | An array of similar content objects. | |
|
||||
| `location` | List[[operations.GetMediaMetaDataLocation](../../models/operations/getmediametadatalocation.md)] | :heavy_minus_sign: | An array of location objects. | |
|
||||
18
docs/models/operations/getmediametadatapart.md
Normal file
18
docs/models/operations/getmediametadatapart.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetMediaMetaDataPart
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
| `duration` | *int* | :heavy_check_mark: | 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 |
|
||||
| `container` | *str* | :heavy_check_mark: | Container format of the part. | mkv |
|
||||
| `video_profile` | *str* | :heavy_check_mark: | Video profile for the part. | main 10 |
|
||||
| `stream` | List[[operations.GetMediaMetaDataStream](../../models/operations/getmediametadatastream.md)] | :heavy_check_mark: | An array of streams for this part. | |
|
||||
| `accessible` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||
| `exists` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
|
||||
21
docs/models/operations/getmediametadatarequest.md
Normal file
21
docs/models/operations/getmediametadatarequest.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetMediaMetaDataRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
|
||||
| `rating_key` | *int* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
|
||||
| `include_concerts` | *Optional[bool]* | :heavy_minus_sign: | Include concerts data if set to true. | true |
|
||||
| `include_extras` | *Optional[bool]* | :heavy_minus_sign: | Include extra content (e.g. bonus features). | true |
|
||||
| `include_on_deck` | *Optional[bool]* | :heavy_minus_sign: | Include on-deck items. | true |
|
||||
| `include_popular_leaves` | *Optional[bool]* | :heavy_minus_sign: | Include popular leaves (episodes/chapters). | true |
|
||||
| `include_preferences` | *Optional[bool]* | :heavy_minus_sign: | Include preferences information. | true |
|
||||
| `include_reviews` | *Optional[bool]* | :heavy_minus_sign: | Include reviews for the content. | true |
|
||||
| `include_chapters` | *Optional[bool]* | :heavy_minus_sign: | Include chapter details. | true |
|
||||
| `include_stations` | *Optional[bool]* | :heavy_minus_sign: | Include station data. | true |
|
||||
| `include_external_media` | *Optional[bool]* | :heavy_minus_sign: | Include external media data. | true |
|
||||
| `async_augment_metadata` | *Optional[bool]* | :heavy_minus_sign: | Trigger asynchronous metadata augmentation. | true |
|
||||
| `async_check_files` | *Optional[bool]* | :heavy_minus_sign: | Trigger asynchronous file checking. | true |
|
||||
| `async_refresh_analysis` | *Optional[bool]* | :heavy_minus_sign: | Trigger asynchronous refresh of analysis. | true |
|
||||
| `async_refresh_local_media_agent` | *Optional[bool]* | :heavy_minus_sign: | Trigger asynchronous refresh of the local media agent. | true |
|
||||
11
docs/models/operations/getmediametadataresponse.md
Normal file
11
docs/models/operations/getmediametadataresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetMediaMetaDataResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [Optional[operations.GetMediaMetaDataResponseBody]](../../models/operations/getmediametadataresponsebody.md) | :heavy_minus_sign: | The metadata of the library item. |
|
||||
10
docs/models/operations/getmediametadataresponsebody.md
Normal file
10
docs/models/operations/getmediametadataresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataResponseBody
|
||||
|
||||
The metadata of the library item.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `media_container` | [Optional[operations.GetMediaMetaDataMediaContainer]](../../models/operations/getmediametadatamediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
13
docs/models/operations/getmediametadatarole.md
Normal file
13
docs/models/operations/getmediametadatarole.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetMediaMetaDataRole
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||
| `filter_` | *str* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `tag` | *str* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `tag_key` | *str* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `role` | *Optional[str]* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `thumb` | *Optional[str]* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||
53
docs/models/operations/getmediametadatastream.md
Normal file
53
docs/models/operations/getmediametadatastream.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# GetMediaMetaDataStream
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||
| `stream_type` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
|
||||
| `codec` | *str* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||
| `bitrate` | *int* | :heavy_check_mark: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *str* | :heavy_check_mark: | Language of the stream. | English |
|
||||
| `language_tag` | *str* | :heavy_check_mark: | Language tag (e.g., en). | en |
|
||||
| `language_code` | *str* | :heavy_check_mark: | ISO language code. | eng |
|
||||
| `display_title` | *str* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `extended_display_title` | *str* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `dovibl_compat_id` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||
| `dovibl_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||
| `doviel_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `dovi_level` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `dovi_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `dovi_profile` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpu_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `dovi_version` | *Optional[str]* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bit_depth` | *Optional[int]* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||
| `chroma_location` | *Optional[str]* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||
| `chroma_subsampling` | *Optional[str]* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||
| `coded_height` | *Optional[int]* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `coded_width` | *Optional[int]* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||
| `color_primaries` | *Optional[str]* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||
| `color_range` | *Optional[str]* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `color_space` | *Optional[str]* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
| `color_trc` | *Optional[str]* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frame_rate` | *Optional[float]* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `height` | *Optional[int]* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *Optional[int]* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `has_scaling_matrix` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `profile` | *Optional[str]* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `scan_type` | *Optional[str]* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `ref_frames` | *Optional[int]* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||
| `width` | *Optional[int]* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||
| `selected` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `forced` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `audio_channel_layout` | *Optional[str]* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `sampling_rate` | *Optional[int]* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `can_auto_sync` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `hearing_impaired` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `dub` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||
| `title` | *Optional[str]* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||
11
docs/models/operations/getmediametadataultrablurcolors.md
Normal file
11
docs/models/operations/getmediametadataultrablurcolors.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetMediaMetaDataUltraBlurColors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
|
||||
| `top_left` | *str* | :heavy_check_mark: | The top-left color value. | 11333a |
|
||||
| `top_right` | *str* | :heavy_check_mark: | The top-right color value. | 1d2721 |
|
||||
| `bottom_right` | *str* | :heavy_check_mark: | The bottom-right color value. | 5c451d |
|
||||
| `bottom_left` | *str* | :heavy_check_mark: | The bottom-left color value. | 372c10 |
|
||||
13
docs/models/operations/getmediametadatawriter.md
Normal file
13
docs/models/operations/getmediametadatawriter.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetMediaMetaDataWriter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||
| `filter_` | *str* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `tag` | *str* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `tag_key` | *str* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `role` | *Optional[str]* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `thumb` | *Optional[str]* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetMetaDataByRatingKeyCountry
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 116 |
|
||||
| `filter_` | *Optional[str]* | :heavy_minus_sign: | N/A | country=116 |
|
||||
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | United States of America |
|
||||
@@ -1,12 +0,0 @@
|
||||
# GetMetaDataByRatingKeyDirector
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 130 |
|
||||
| `filter_` | *Optional[str]* | :heavy_minus_sign: | N/A | director=130 |
|
||||
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | Joss Whedon |
|
||||
| `tag_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 5d776828880197001ec90e8f |
|
||||
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetMetaDataByRatingKeyGenre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 184 |
|
||||
| `filter_` | *Optional[str]* | :heavy_minus_sign: | N/A | genre=184 |
|
||||
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | Thriller |
|
||||
@@ -1,24 +0,0 @@
|
||||
# GetMetaDataByRatingKeyMedia
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 15 |
|
||||
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | N/A | 2278 |
|
||||
| `width` | *Optional[int]* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `height` | *Optional[int]* | :heavy_minus_sign: | N/A | 814 |
|
||||
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | N/A | 2.35 |
|
||||
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | aac |
|
||||
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | h264 |
|
||||
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `container` | *Optional[str]* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `optimized_for_streaming` | *Optional[int]* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | lc |
|
||||
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | high |
|
||||
| `part` | List[[operations.GetMetaDataByRatingKeyPart](../../models/operations/getmetadatabyratingkeypart.md)] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,16 +0,0 @@
|
||||
# GetMetaDataByRatingKeyMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `size` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `allow_sync` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `identifier` | *Optional[str]* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | N/A | cfc899d7-3000-46f6-8489-b9592714ada5 |
|
||||
| `media_tag_prefix` | *Optional[str]* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `media_tag_version` | *Optional[int]* | :heavy_minus_sign: | N/A | 1698860922 |
|
||||
| `metadata` | List[[operations.GetMetaDataByRatingKeyMetadata](../../models/operations/getmetadatabyratingkeymetadata.md)] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetMetaDataByRatingKeyPart
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 15 |
|
||||
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 |
|
||||
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `file` | *Optional[str]* | :heavy_minus_sign: | N/A | /movies/Serenity (2005)/Serenity (2005).mp4 |
|
||||
| `size` | *Optional[int]* | :heavy_minus_sign: | N/A | 40271948 |
|
||||
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | lc |
|
||||
| `container` | *Optional[str]* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimized_for_streaming` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | high |
|
||||
| `stream` | List[[operations.GetMetaDataByRatingKeyStream](../../models/operations/getmetadatabyratingkeystream.md)] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetMetaDataByRatingKeyRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `rating_key` | *int* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetMetaDataByRatingKeyResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [Optional[operations.GetMetaDataByRatingKeyResponseBody]](../../models/operations/getmetadatabyratingkeyresponsebody.md) | :heavy_minus_sign: | The metadata of the library item. |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetMetaDataByRatingKeyResponseBody
|
||||
|
||||
The metadata of the library item.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `media_container` | [Optional[operations.GetMetaDataByRatingKeyMediaContainer]](../../models/operations/getmetadatabyratingkeymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,13 +0,0 @@
|
||||
# GetMetaDataByRatingKeyRole
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 220 |
|
||||
| `filter_` | *Optional[str]* | :heavy_minus_sign: | N/A | actor=220 |
|
||||
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | Dennis Keiffer |
|
||||
| `tag_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 5d77683554f42c001f8c4708 |
|
||||
| `role` | *Optional[str]* | :heavy_minus_sign: | N/A | Bar Guy (uncredited) |
|
||||
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg |
|
||||
@@ -1,39 +0,0 @@
|
||||
# GetMetaDataByRatingKeyStream
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 29 |
|
||||
| `stream_type` | *Optional[int]* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `default` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `codec` | *Optional[str]* | :heavy_minus_sign: | N/A | aac |
|
||||
| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | N/A | 128 |
|
||||
| `bit_depth` | *Optional[int]* | :heavy_minus_sign: | N/A | 8 |
|
||||
| `chroma_location` | *Optional[str]* | :heavy_minus_sign: | N/A | left |
|
||||
| `chroma_subsampling` | *Optional[str]* | :heavy_minus_sign: | N/A | 14520 |
|
||||
| `coded_height` | *Optional[int]* | :heavy_minus_sign: | N/A | 816 |
|
||||
| `coded_width` | *Optional[int]* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `color_primaries` | *Optional[str]* | :heavy_minus_sign: | N/A | bt709 |
|
||||
| `color_range` | *Optional[str]* | :heavy_minus_sign: | N/A | tv |
|
||||
| `color_space` | *Optional[str]* | :heavy_minus_sign: | N/A | bt709 |
|
||||
| `color_trc` | *Optional[str]* | :heavy_minus_sign: | N/A | bt709 |
|
||||
| `frame_rate` | *Optional[int]* | :heavy_minus_sign: | N/A | 24 |
|
||||
| `has_scaling_matrix` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `height` | *Optional[int]* | :heavy_minus_sign: | N/A | 814 |
|
||||
| `level` | *Optional[int]* | :heavy_minus_sign: | N/A | 40 |
|
||||
| `profile` | *Optional[str]* | :heavy_minus_sign: | N/A | lc |
|
||||
| `ref_frames` | *Optional[int]* | :heavy_minus_sign: | N/A | 4 |
|
||||
| `scan_type` | *Optional[str]* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `stream_identifier` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `width` | *Optional[int]* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `display_title` | *Optional[str]* | :heavy_minus_sign: | N/A | English (AAC Stereo) |
|
||||
| `extended_display_title` | *Optional[str]* | :heavy_minus_sign: | N/A | English (AAC Stereo) |
|
||||
| `selected` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *Optional[int]* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `language` | *Optional[str]* | :heavy_minus_sign: | N/A | English |
|
||||
| `language_tag` | *Optional[str]* | :heavy_minus_sign: | N/A | en |
|
||||
| `language_code` | *Optional[str]* | :heavy_minus_sign: | N/A | eng |
|
||||
| `sampling_rate` | *Optional[int]* | :heavy_minus_sign: | N/A | 44100 |
|
||||
@@ -1,12 +0,0 @@
|
||||
# GetMetaDataByRatingKeyWriter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 132 |
|
||||
| `filter_` | *Optional[str]* | :heavy_minus_sign: | N/A | writer=132 |
|
||||
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | Joss Whedon |
|
||||
| `tag_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 5d776828880197001ec90e8f |
|
||||
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg |
|
||||
@@ -1,6 +1,6 @@
|
||||
# GetPlaylistContentsQueryParamType
|
||||
|
||||
The type of media to retrieve.
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `playlist_id` | *float* | :heavy_check_mark: | the ID of the playlist | |
|
||||
| `type` | [operations.GetPlaylistContentsQueryParamType](../../models/operations/getplaylistcontentsqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `playlist_id` | *float* | :heavy_check_mark: | the ID of the playlist | |
|
||||
| `type` | [operations.GetPlaylistContentsQueryParamType](../../models/operations/getplaylistcontentsqueryparamtype.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 |
|
||||
@@ -3,12 +3,12 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [operations.QueryParamType](../../models/operations/queryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| 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 |
|
||||
| `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 |
|
||||
@@ -3,12 +3,12 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| 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.<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 |
|
||||
| `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 |
|
||||
| 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 |
|
||||
| `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 |
|
||||
@@ -1,6 +1,6 @@
|
||||
# GetSearchLibraryQueryParamType
|
||||
|
||||
The type of media to retrieve.
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
| `type` | [operations.GetSearchLibraryQueryParamType](../../models/operations/getsearchlibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| 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 |
|
||||
| `type` | [operations.GetSearchLibraryQueryParamType](../../models/operations/getsearchlibraryqueryparamtype.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 |
|
||||
@@ -1,6 +1,6 @@
|
||||
# GetTopWatchedContentQueryParamType
|
||||
|
||||
The type of media to retrieve.
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [operations.GetTopWatchedContentQueryParamType](../../models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `include_guids` | *Optional[int]* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
| 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 |
|
||||
@@ -5,4 +5,4 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | tvdb://2337 |
|
||||
| `id` | *str* | :heavy_check_mark: | The GUID value. | imdb://tt3032476 |
|
||||
@@ -5,8 +5,9 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 221 |
|
||||
| `filter_` | *Optional[str]* | :heavy_minus_sign: | N/A | producer=221 |
|
||||
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | Barry Mendel |
|
||||
| `tag_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 5d776826961905001eb90e2b |
|
||||
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg |
|
||||
| `id` | *int* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||
| `filter_` | *str* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `tag` | *str* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `tag_key` | *str* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `role` | *Optional[str]* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `thumb` | *Optional[str]* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||
@@ -1,6 +1,6 @@
|
||||
# QueryParamType
|
||||
|
||||
The type of media to retrieve.
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
10
docs/models/operations/rating.md
Normal file
10
docs/models/operations/rating.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Rating
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `image` | *str* | :heavy_check_mark: | The image or reference for the rating. | imdb://image.rating |
|
||||
| `value` | *float* | :heavy_check_mark: | The rating value. | 9 |
|
||||
| `type` | *str* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
||||
@@ -1,10 +0,0 @@
|
||||
# Ratings
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `image` | *Optional[str]* | :heavy_minus_sign: | N/A | themoviedb://image.rating |
|
||||
| `value` | *Optional[float]* | :heavy_minus_sign: | N/A | 7.4 |
|
||||
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | audience |
|
||||
10
docs/models/operations/similar.md
Normal file
10
docs/models/operations/similar.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Similar
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | The unique similar item identifier. | 26 |
|
||||
| `filter_` | *str* | :heavy_check_mark: | The filter string for similar items. | similar=26 |
|
||||
| `tag` | *str* | :heavy_check_mark: | The tag or title of the similar content. | Breaking Bad |
|
||||
@@ -1,6 +1,6 @@
|
||||
# Type
|
||||
|
||||
The type of media to retrieve.
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -18,8 +18,9 @@ API Calls interacting with Plex Media Server Libraries
|
||||
* [get_search_library](#get_search_library) - Search Library
|
||||
* [get_genres_library](#get_genres_library) - Get Genres of library media
|
||||
* [get_countries_library](#get_countries_library) - Get Countries of library media
|
||||
* [get_actors_library](#get_actors_library) - Get Actors of library media
|
||||
* [get_search_all_libraries](#get_search_all_libraries) - Search All Libraries
|
||||
* [get_meta_data_by_rating_key](#get_meta_data_by_rating_key) - Get Metadata by RatingKey
|
||||
* [get_media_meta_data](#get_media_meta_data) - Get Media Metadata
|
||||
* [get_metadata_children](#get_metadata_children) - Get Items Children
|
||||
* [get_top_watched_content](#get_top_watched_content) - Get Top Watched Content
|
||||
* [get_on_deck](#get_on_deck) - Get On Deck
|
||||
@@ -332,8 +333,8 @@ with PlexAPI(
|
||||
|
||||
res = plex_api.library.get_library_items(request={
|
||||
"tag": operations.Tag.EDITION,
|
||||
"section_key": 9518,
|
||||
"type": operations.GetLibraryItemsQueryParamType.TV_SHOW,
|
||||
"section_key": 9518,
|
||||
})
|
||||
|
||||
assert res.object is not None
|
||||
@@ -449,11 +450,11 @@ with PlexAPI(
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | 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 |
|
||||
| `type` | [operations.GetSearchLibraryQueryParamType](../../models/operations/getsearchlibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
|
||||
| Parameter | 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 |
|
||||
| `type` | [operations.GetSearchLibraryQueryParamType](../../models/operations/getsearchlibraryqueryparamtype.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 |
|
||||
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
|
||||
|
||||
### Response
|
||||
|
||||
@@ -476,12 +477,13 @@ Retrieves a list of all the genres that are found for the media in this library.
|
||||
|
||||
```python
|
||||
from plex_api_client import PlexAPI
|
||||
from plex_api_client.models import operations
|
||||
|
||||
with PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
) as plex_api:
|
||||
|
||||
res = plex_api.library.get_genres_library(section_key=9518)
|
||||
res = plex_api.library.get_genres_library(section_key=9518, type_=operations.GetGenresLibraryQueryParamType.TV_SHOW)
|
||||
|
||||
assert res.object is not None
|
||||
|
||||
@@ -492,10 +494,11 @@ with PlexAPI(
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | 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 |
|
||||
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
|
||||
| Parameter | 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 |
|
||||
| `type` | [operations.GetGenresLibraryQueryParamType](../../models/operations/getgenreslibraryqueryparamtype.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 |
|
||||
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
|
||||
|
||||
### Response
|
||||
|
||||
@@ -518,12 +521,13 @@ Retrieves a list of all the countries that are found for the media in this libra
|
||||
|
||||
```python
|
||||
from plex_api_client import PlexAPI
|
||||
from plex_api_client.models import operations
|
||||
|
||||
with PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
) as plex_api:
|
||||
|
||||
res = plex_api.library.get_countries_library(section_key=9518)
|
||||
res = plex_api.library.get_countries_library(section_key=9518, type_=operations.GetCountriesLibraryQueryParamType.TV_SHOW)
|
||||
|
||||
assert res.object is not None
|
||||
|
||||
@@ -534,10 +538,11 @@ with PlexAPI(
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | 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 |
|
||||
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
|
||||
| Parameter | 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 |
|
||||
| `type` | [operations.GetCountriesLibraryQueryParamType](../../models/operations/getcountrieslibraryqueryparamtype.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 |
|
||||
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
|
||||
|
||||
### Response
|
||||
|
||||
@@ -551,6 +556,50 @@ with PlexAPI(
|
||||
| errors.GetCountriesLibraryUnauthorized | 401 | application/json |
|
||||
| errors.SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## get_actors_library
|
||||
|
||||
Retrieves a list of all the actors that are found for the media in this library.
|
||||
|
||||
|
||||
### Example Usage
|
||||
|
||||
```python
|
||||
from plex_api_client import PlexAPI
|
||||
from plex_api_client.models import operations
|
||||
|
||||
with PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
) as plex_api:
|
||||
|
||||
res = plex_api.library.get_actors_library(section_key=9518, type_=operations.GetActorsLibraryQueryParamType.TV_SHOW)
|
||||
|
||||
assert res.object is not None
|
||||
|
||||
# Handle response
|
||||
print(res.object)
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | 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 |
|
||||
| `type` | [operations.GetActorsLibraryQueryParamType](../../models/operations/getactorslibraryqueryparamtype.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 |
|
||||
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
|
||||
|
||||
### Response
|
||||
|
||||
**[operations.GetActorsLibraryResponse](../../models/operations/getactorslibraryresponse.md)**
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| errors.GetActorsLibraryBadRequest | 400 | application/json |
|
||||
| errors.GetActorsLibraryUnauthorized | 401 | application/json |
|
||||
| errors.SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## get_search_all_libraries
|
||||
|
||||
Search the provided query across all library sections, or a single section, and return matches as hubs, split up by type.
|
||||
@@ -600,9 +649,9 @@ with PlexAPI(
|
||||
| errors.GetSearchAllLibrariesUnauthorized | 401 | application/json |
|
||||
| errors.SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## get_meta_data_by_rating_key
|
||||
## get_media_meta_data
|
||||
|
||||
This endpoint will return the metadata of a library item specified with the ratingKey.
|
||||
This endpoint will return all the (meta)data of a library item specified with by the ratingKey.
|
||||
|
||||
|
||||
### Example Usage
|
||||
@@ -614,7 +663,22 @@ with PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
) as plex_api:
|
||||
|
||||
res = plex_api.library.get_meta_data_by_rating_key(rating_key=9518)
|
||||
res = plex_api.library.get_media_meta_data(request={
|
||||
"rating_key": 9518,
|
||||
"include_concerts": True,
|
||||
"include_extras": True,
|
||||
"include_on_deck": True,
|
||||
"include_popular_leaves": True,
|
||||
"include_preferences": True,
|
||||
"include_reviews": True,
|
||||
"include_chapters": True,
|
||||
"include_stations": True,
|
||||
"include_external_media": True,
|
||||
"async_augment_metadata": True,
|
||||
"async_check_files": True,
|
||||
"async_refresh_analysis": True,
|
||||
"async_refresh_local_media_agent": True,
|
||||
})
|
||||
|
||||
assert res.object is not None
|
||||
|
||||
@@ -625,22 +689,22 @@ with PlexAPI(
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| `rating_key` | *int* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
|
||||
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
|
||||
| Parameter | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||
| `request` | [operations.GetMediaMetaDataRequest](../../models/operations/getmediametadatarequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
||||
|
||||
### Response
|
||||
|
||||
**[operations.GetMetaDataByRatingKeyResponse](../../models/operations/getmetadatabyratingkeyresponse.md)**
|
||||
**[operations.GetMediaMetaDataResponse](../../models/operations/getmediametadataresponse.md)**
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
|
||||
| errors.GetMetaDataByRatingKeyBadRequest | 400 | application/json |
|
||||
| errors.GetMetaDataByRatingKeyUnauthorized | 401 | application/json |
|
||||
| errors.SDKError | 4XX, 5XX | \*/\* |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| errors.GetMediaMetaDataBadRequest | 400 | application/json |
|
||||
| errors.GetMediaMetaDataUnauthorized | 401 | application/json |
|
||||
| errors.SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## get_metadata_children
|
||||
|
||||
@@ -711,11 +775,11 @@ with PlexAPI(
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [operations.GetTopWatchedContentQueryParamType](../../models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `include_guids` | *Optional[int]* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
|
||||
| Parameter | 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 |
|
||||
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
|
||||
|
||||
### Response
|
||||
|
||||
|
||||
@@ -271,11 +271,11 @@ with PlexAPI(
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `playlist_id` | *float* | :heavy_check_mark: | the ID of the playlist | |
|
||||
| `type` | [operations.GetPlaylistContentsQueryParamType](../../models/operations/getplaylistcontentsqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `playlist_id` | *float* | :heavy_check_mark: | the ID of the playlist | |
|
||||
| `type` | [operations.GetPlaylistContentsQueryParamType](../../models/operations/getplaylistcontentsqueryparamtype.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 |
|
||||
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
|
||||
|
||||
### Response
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[project]
|
||||
name = "plex-api-client"
|
||||
version = "0.22.0"
|
||||
version = "0.22.1"
|
||||
description = "Python Client SDK Generated by Speakeasy"
|
||||
authors = [{ name = "Speakeasy" },]
|
||||
readme = "README-PYPI.md"
|
||||
|
||||
@@ -3,10 +3,10 @@
|
||||
import importlib.metadata
|
||||
|
||||
__title__: str = "plex-api-client"
|
||||
__version__: str = "0.22.0"
|
||||
__version__: str = "0.22.1"
|
||||
__openapi_doc_version__: str = "0.0.3"
|
||||
__gen_version__: str = "2.506.0"
|
||||
__user_agent__: str = "speakeasy-sdk/python 0.22.0 2.506.0 0.0.3 plex-api-client"
|
||||
__user_agent__: str = "speakeasy-sdk/python 0.22.1 2.506.0 0.0.3 plex-api-client"
|
||||
|
||||
try:
|
||||
if __package__ is not None:
|
||||
|
||||
@@ -1700,7 +1700,7 @@ class Library(BaseSDK):
|
||||
|
||||
|
||||
:param section_key: The unique key of the Plex library. Note: This is unique in the context of the Plex server.
|
||||
:param type: The type of media to retrieve. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
:param type: The type of media to retrieve or filter by. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
:param retries: Override the default retry configuration for this method
|
||||
:param server_url: Override the default server URL for this method
|
||||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||||
@@ -1829,7 +1829,7 @@ class Library(BaseSDK):
|
||||
|
||||
|
||||
:param section_key: The unique key of the Plex library. Note: This is unique in the context of the Plex server.
|
||||
:param type: The type of media to retrieve. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
:param type: The type of media to retrieve or filter by. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
:param retries: Override the default retry configuration for this method
|
||||
:param server_url: Override the default server URL for this method
|
||||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||||
@@ -1929,6 +1929,7 @@ class Library(BaseSDK):
|
||||
self,
|
||||
*,
|
||||
section_key: int,
|
||||
type_: operations.GetGenresLibraryQueryParamType,
|
||||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||||
server_url: Optional[str] = None,
|
||||
timeout_ms: Optional[int] = None,
|
||||
@@ -1940,6 +1941,7 @@ class Library(BaseSDK):
|
||||
|
||||
|
||||
:param section_key: The unique key of the Plex library. Note: This is unique in the context of the Plex server.
|
||||
:param type: The type of media to retrieve or filter by. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
:param retries: Override the default retry configuration for this method
|
||||
:param server_url: Override the default server URL for this method
|
||||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||||
@@ -1955,6 +1957,7 @@ class Library(BaseSDK):
|
||||
|
||||
request = operations.GetGenresLibraryRequest(
|
||||
section_key=section_key,
|
||||
type=type_,
|
||||
)
|
||||
|
||||
req = self._build_request(
|
||||
@@ -2038,6 +2041,7 @@ class Library(BaseSDK):
|
||||
self,
|
||||
*,
|
||||
section_key: int,
|
||||
type_: operations.GetGenresLibraryQueryParamType,
|
||||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||||
server_url: Optional[str] = None,
|
||||
timeout_ms: Optional[int] = None,
|
||||
@@ -2049,6 +2053,7 @@ class Library(BaseSDK):
|
||||
|
||||
|
||||
:param section_key: The unique key of the Plex library. Note: This is unique in the context of the Plex server.
|
||||
:param type: The type of media to retrieve or filter by. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
:param retries: Override the default retry configuration for this method
|
||||
:param server_url: Override the default server URL for this method
|
||||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||||
@@ -2064,6 +2069,7 @@ class Library(BaseSDK):
|
||||
|
||||
request = operations.GetGenresLibraryRequest(
|
||||
section_key=section_key,
|
||||
type=type_,
|
||||
)
|
||||
|
||||
req = self._build_request_async(
|
||||
@@ -2147,6 +2153,7 @@ class Library(BaseSDK):
|
||||
self,
|
||||
*,
|
||||
section_key: int,
|
||||
type_: operations.GetCountriesLibraryQueryParamType,
|
||||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||||
server_url: Optional[str] = None,
|
||||
timeout_ms: Optional[int] = None,
|
||||
@@ -2158,6 +2165,7 @@ class Library(BaseSDK):
|
||||
|
||||
|
||||
:param section_key: The unique key of the Plex library. Note: This is unique in the context of the Plex server.
|
||||
:param type: The type of media to retrieve or filter by. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
:param retries: Override the default retry configuration for this method
|
||||
:param server_url: Override the default server URL for this method
|
||||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||||
@@ -2173,6 +2181,7 @@ class Library(BaseSDK):
|
||||
|
||||
request = operations.GetCountriesLibraryRequest(
|
||||
section_key=section_key,
|
||||
type=type_,
|
||||
)
|
||||
|
||||
req = self._build_request(
|
||||
@@ -2256,6 +2265,7 @@ class Library(BaseSDK):
|
||||
self,
|
||||
*,
|
||||
section_key: int,
|
||||
type_: operations.GetCountriesLibraryQueryParamType,
|
||||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||||
server_url: Optional[str] = None,
|
||||
timeout_ms: Optional[int] = None,
|
||||
@@ -2267,6 +2277,7 @@ class Library(BaseSDK):
|
||||
|
||||
|
||||
:param section_key: The unique key of the Plex library. Note: This is unique in the context of the Plex server.
|
||||
:param type: The type of media to retrieve or filter by. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
:param retries: Override the default retry configuration for this method
|
||||
:param server_url: Override the default server URL for this method
|
||||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||||
@@ -2282,6 +2293,7 @@ class Library(BaseSDK):
|
||||
|
||||
request = operations.GetCountriesLibraryRequest(
|
||||
section_key=section_key,
|
||||
type=type_,
|
||||
)
|
||||
|
||||
req = self._build_request_async(
|
||||
@@ -2361,6 +2373,230 @@ class Library(BaseSDK):
|
||||
http_res,
|
||||
)
|
||||
|
||||
def get_actors_library(
|
||||
self,
|
||||
*,
|
||||
section_key: int,
|
||||
type_: operations.GetActorsLibraryQueryParamType,
|
||||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||||
server_url: Optional[str] = None,
|
||||
timeout_ms: Optional[int] = None,
|
||||
http_headers: Optional[Mapping[str, str]] = None,
|
||||
) -> operations.GetActorsLibraryResponse:
|
||||
r"""Get Actors of library media
|
||||
|
||||
Retrieves a list of all the actors that are found for the media in this library.
|
||||
|
||||
|
||||
:param section_key: The unique key of the Plex library. Note: This is unique in the context of the Plex server.
|
||||
:param type: The type of media to retrieve or filter by. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
:param retries: Override the default retry configuration for this method
|
||||
:param server_url: Override the default server URL for this method
|
||||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||||
:param http_headers: Additional headers to set or replace on requests.
|
||||
"""
|
||||
base_url = None
|
||||
url_variables = None
|
||||
if timeout_ms is None:
|
||||
timeout_ms = self.sdk_configuration.timeout_ms
|
||||
|
||||
if server_url is not None:
|
||||
base_url = server_url
|
||||
|
||||
request = operations.GetActorsLibraryRequest(
|
||||
section_key=section_key,
|
||||
type=type_,
|
||||
)
|
||||
|
||||
req = self._build_request(
|
||||
method="GET",
|
||||
path="/library/sections/{sectionKey}/actor",
|
||||
base_url=base_url,
|
||||
url_variables=url_variables,
|
||||
request=request,
|
||||
request_body_required=False,
|
||||
request_has_path_params=True,
|
||||
request_has_query_params=True,
|
||||
user_agent_header="user-agent",
|
||||
accept_header_value="application/json",
|
||||
http_headers=http_headers,
|
||||
security=self.sdk_configuration.security,
|
||||
timeout_ms=timeout_ms,
|
||||
)
|
||||
|
||||
if retries == UNSET:
|
||||
if self.sdk_configuration.retry_config is not UNSET:
|
||||
retries = self.sdk_configuration.retry_config
|
||||
|
||||
retry_config = None
|
||||
if isinstance(retries, utils.RetryConfig):
|
||||
retry_config = (retries, ["429", "500", "502", "503", "504"])
|
||||
|
||||
http_res = self.do_request(
|
||||
hook_ctx=HookContext(
|
||||
operation_id="get-actors-library",
|
||||
oauth2_scopes=[],
|
||||
security_source=self.sdk_configuration.security,
|
||||
),
|
||||
request=req,
|
||||
error_status_codes=["400", "401", "404", "4XX", "5XX"],
|
||||
retry_config=retry_config,
|
||||
)
|
||||
|
||||
response_data: Any = None
|
||||
if utils.match_response(http_res, "200", "application/json"):
|
||||
return operations.GetActorsLibraryResponse(
|
||||
object=utils.unmarshal_json(
|
||||
http_res.text, Optional[operations.GetActorsLibraryResponseBody]
|
||||
),
|
||||
status_code=http_res.status_code,
|
||||
content_type=http_res.headers.get("Content-Type") or "",
|
||||
raw_response=http_res,
|
||||
)
|
||||
if utils.match_response(http_res, "400", "application/json"):
|
||||
response_data = utils.unmarshal_json(
|
||||
http_res.text, errors.GetActorsLibraryBadRequestData
|
||||
)
|
||||
response_data.raw_response = http_res
|
||||
raise errors.GetActorsLibraryBadRequest(data=response_data)
|
||||
if utils.match_response(http_res, "401", "application/json"):
|
||||
response_data = utils.unmarshal_json(
|
||||
http_res.text, errors.GetActorsLibraryUnauthorizedData
|
||||
)
|
||||
response_data.raw_response = http_res
|
||||
raise errors.GetActorsLibraryUnauthorized(data=response_data)
|
||||
if utils.match_response(http_res, ["404", "4XX"], "*"):
|
||||
http_res_text = utils.stream_to_text(http_res)
|
||||
raise errors.SDKError(
|
||||
"API error occurred", http_res.status_code, http_res_text, http_res
|
||||
)
|
||||
if utils.match_response(http_res, "5XX", "*"):
|
||||
http_res_text = utils.stream_to_text(http_res)
|
||||
raise errors.SDKError(
|
||||
"API error occurred", http_res.status_code, http_res_text, http_res
|
||||
)
|
||||
|
||||
content_type = http_res.headers.get("Content-Type")
|
||||
http_res_text = utils.stream_to_text(http_res)
|
||||
raise errors.SDKError(
|
||||
f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
|
||||
http_res.status_code,
|
||||
http_res_text,
|
||||
http_res,
|
||||
)
|
||||
|
||||
async def get_actors_library_async(
|
||||
self,
|
||||
*,
|
||||
section_key: int,
|
||||
type_: operations.GetActorsLibraryQueryParamType,
|
||||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||||
server_url: Optional[str] = None,
|
||||
timeout_ms: Optional[int] = None,
|
||||
http_headers: Optional[Mapping[str, str]] = None,
|
||||
) -> operations.GetActorsLibraryResponse:
|
||||
r"""Get Actors of library media
|
||||
|
||||
Retrieves a list of all the actors that are found for the media in this library.
|
||||
|
||||
|
||||
:param section_key: The unique key of the Plex library. Note: This is unique in the context of the Plex server.
|
||||
:param type: The type of media to retrieve or filter by. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
:param retries: Override the default retry configuration for this method
|
||||
:param server_url: Override the default server URL for this method
|
||||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||||
:param http_headers: Additional headers to set or replace on requests.
|
||||
"""
|
||||
base_url = None
|
||||
url_variables = None
|
||||
if timeout_ms is None:
|
||||
timeout_ms = self.sdk_configuration.timeout_ms
|
||||
|
||||
if server_url is not None:
|
||||
base_url = server_url
|
||||
|
||||
request = operations.GetActorsLibraryRequest(
|
||||
section_key=section_key,
|
||||
type=type_,
|
||||
)
|
||||
|
||||
req = self._build_request_async(
|
||||
method="GET",
|
||||
path="/library/sections/{sectionKey}/actor",
|
||||
base_url=base_url,
|
||||
url_variables=url_variables,
|
||||
request=request,
|
||||
request_body_required=False,
|
||||
request_has_path_params=True,
|
||||
request_has_query_params=True,
|
||||
user_agent_header="user-agent",
|
||||
accept_header_value="application/json",
|
||||
http_headers=http_headers,
|
||||
security=self.sdk_configuration.security,
|
||||
timeout_ms=timeout_ms,
|
||||
)
|
||||
|
||||
if retries == UNSET:
|
||||
if self.sdk_configuration.retry_config is not UNSET:
|
||||
retries = self.sdk_configuration.retry_config
|
||||
|
||||
retry_config = None
|
||||
if isinstance(retries, utils.RetryConfig):
|
||||
retry_config = (retries, ["429", "500", "502", "503", "504"])
|
||||
|
||||
http_res = await self.do_request_async(
|
||||
hook_ctx=HookContext(
|
||||
operation_id="get-actors-library",
|
||||
oauth2_scopes=[],
|
||||
security_source=self.sdk_configuration.security,
|
||||
),
|
||||
request=req,
|
||||
error_status_codes=["400", "401", "404", "4XX", "5XX"],
|
||||
retry_config=retry_config,
|
||||
)
|
||||
|
||||
response_data: Any = None
|
||||
if utils.match_response(http_res, "200", "application/json"):
|
||||
return operations.GetActorsLibraryResponse(
|
||||
object=utils.unmarshal_json(
|
||||
http_res.text, Optional[operations.GetActorsLibraryResponseBody]
|
||||
),
|
||||
status_code=http_res.status_code,
|
||||
content_type=http_res.headers.get("Content-Type") or "",
|
||||
raw_response=http_res,
|
||||
)
|
||||
if utils.match_response(http_res, "400", "application/json"):
|
||||
response_data = utils.unmarshal_json(
|
||||
http_res.text, errors.GetActorsLibraryBadRequestData
|
||||
)
|
||||
response_data.raw_response = http_res
|
||||
raise errors.GetActorsLibraryBadRequest(data=response_data)
|
||||
if utils.match_response(http_res, "401", "application/json"):
|
||||
response_data = utils.unmarshal_json(
|
||||
http_res.text, errors.GetActorsLibraryUnauthorizedData
|
||||
)
|
||||
response_data.raw_response = http_res
|
||||
raise errors.GetActorsLibraryUnauthorized(data=response_data)
|
||||
if utils.match_response(http_res, ["404", "4XX"], "*"):
|
||||
http_res_text = await utils.stream_to_text_async(http_res)
|
||||
raise errors.SDKError(
|
||||
"API error occurred", http_res.status_code, http_res_text, http_res
|
||||
)
|
||||
if utils.match_response(http_res, "5XX", "*"):
|
||||
http_res_text = await utils.stream_to_text_async(http_res)
|
||||
raise errors.SDKError(
|
||||
"API error occurred", http_res.status_code, http_res_text, http_res
|
||||
)
|
||||
|
||||
content_type = http_res.headers.get("Content-Type")
|
||||
http_res_text = await utils.stream_to_text_async(http_res)
|
||||
raise errors.SDKError(
|
||||
f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
|
||||
http_res.status_code,
|
||||
http_res_text,
|
||||
http_res,
|
||||
)
|
||||
|
||||
def get_search_all_libraries(
|
||||
self,
|
||||
*,
|
||||
@@ -2587,21 +2823,24 @@ class Library(BaseSDK):
|
||||
http_res,
|
||||
)
|
||||
|
||||
def get_meta_data_by_rating_key(
|
||||
def get_media_meta_data(
|
||||
self,
|
||||
*,
|
||||
rating_key: int,
|
||||
request: Union[
|
||||
operations.GetMediaMetaDataRequest,
|
||||
operations.GetMediaMetaDataRequestTypedDict,
|
||||
],
|
||||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||||
server_url: Optional[str] = None,
|
||||
timeout_ms: Optional[int] = None,
|
||||
http_headers: Optional[Mapping[str, str]] = None,
|
||||
) -> operations.GetMetaDataByRatingKeyResponse:
|
||||
r"""Get Metadata by RatingKey
|
||||
) -> operations.GetMediaMetaDataResponse:
|
||||
r"""Get Media Metadata
|
||||
|
||||
This endpoint will return the metadata of a library item specified with the ratingKey.
|
||||
This endpoint will return all the (meta)data of a library item specified with by the ratingKey.
|
||||
|
||||
|
||||
:param rating_key: the id of the library item to return the children of.
|
||||
:param request: The request object to send.
|
||||
:param retries: Override the default retry configuration for this method
|
||||
:param server_url: Override the default server URL for this method
|
||||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||||
@@ -2615,9 +2854,9 @@ class Library(BaseSDK):
|
||||
if server_url is not None:
|
||||
base_url = server_url
|
||||
|
||||
request = operations.GetMetaDataByRatingKeyRequest(
|
||||
rating_key=rating_key,
|
||||
)
|
||||
if not isinstance(request, BaseModel):
|
||||
request = utils.unmarshal(request, operations.GetMediaMetaDataRequest)
|
||||
request = cast(operations.GetMediaMetaDataRequest, request)
|
||||
|
||||
req = self._build_request(
|
||||
method="GET",
|
||||
@@ -2645,21 +2884,20 @@ class Library(BaseSDK):
|
||||
|
||||
http_res = self.do_request(
|
||||
hook_ctx=HookContext(
|
||||
operation_id="get-meta-data-by-rating-key",
|
||||
operation_id="get-media-meta-data",
|
||||
oauth2_scopes=[],
|
||||
security_source=self.sdk_configuration.security,
|
||||
),
|
||||
request=req,
|
||||
error_status_codes=["400", "401", "4XX", "5XX"],
|
||||
error_status_codes=["400", "401", "404", "4XX", "5XX"],
|
||||
retry_config=retry_config,
|
||||
)
|
||||
|
||||
response_data: Any = None
|
||||
if utils.match_response(http_res, "200", "application/json"):
|
||||
return operations.GetMetaDataByRatingKeyResponse(
|
||||
return operations.GetMediaMetaDataResponse(
|
||||
object=utils.unmarshal_json(
|
||||
http_res.text,
|
||||
Optional[operations.GetMetaDataByRatingKeyResponseBody],
|
||||
http_res.text, Optional[operations.GetMediaMetaDataResponseBody]
|
||||
),
|
||||
status_code=http_res.status_code,
|
||||
content_type=http_res.headers.get("Content-Type") or "",
|
||||
@@ -2667,17 +2905,17 @@ class Library(BaseSDK):
|
||||
)
|
||||
if utils.match_response(http_res, "400", "application/json"):
|
||||
response_data = utils.unmarshal_json(
|
||||
http_res.text, errors.GetMetaDataByRatingKeyBadRequestData
|
||||
http_res.text, errors.GetMediaMetaDataBadRequestData
|
||||
)
|
||||
response_data.raw_response = http_res
|
||||
raise errors.GetMetaDataByRatingKeyBadRequest(data=response_data)
|
||||
raise errors.GetMediaMetaDataBadRequest(data=response_data)
|
||||
if utils.match_response(http_res, "401", "application/json"):
|
||||
response_data = utils.unmarshal_json(
|
||||
http_res.text, errors.GetMetaDataByRatingKeyUnauthorizedData
|
||||
http_res.text, errors.GetMediaMetaDataUnauthorizedData
|
||||
)
|
||||
response_data.raw_response = http_res
|
||||
raise errors.GetMetaDataByRatingKeyUnauthorized(data=response_data)
|
||||
if utils.match_response(http_res, "4XX", "*"):
|
||||
raise errors.GetMediaMetaDataUnauthorized(data=response_data)
|
||||
if utils.match_response(http_res, ["404", "4XX"], "*"):
|
||||
http_res_text = utils.stream_to_text(http_res)
|
||||
raise errors.SDKError(
|
||||
"API error occurred", http_res.status_code, http_res_text, http_res
|
||||
@@ -2697,21 +2935,24 @@ class Library(BaseSDK):
|
||||
http_res,
|
||||
)
|
||||
|
||||
async def get_meta_data_by_rating_key_async(
|
||||
async def get_media_meta_data_async(
|
||||
self,
|
||||
*,
|
||||
rating_key: int,
|
||||
request: Union[
|
||||
operations.GetMediaMetaDataRequest,
|
||||
operations.GetMediaMetaDataRequestTypedDict,
|
||||
],
|
||||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||||
server_url: Optional[str] = None,
|
||||
timeout_ms: Optional[int] = None,
|
||||
http_headers: Optional[Mapping[str, str]] = None,
|
||||
) -> operations.GetMetaDataByRatingKeyResponse:
|
||||
r"""Get Metadata by RatingKey
|
||||
) -> operations.GetMediaMetaDataResponse:
|
||||
r"""Get Media Metadata
|
||||
|
||||
This endpoint will return the metadata of a library item specified with the ratingKey.
|
||||
This endpoint will return all the (meta)data of a library item specified with by the ratingKey.
|
||||
|
||||
|
||||
:param rating_key: the id of the library item to return the children of.
|
||||
:param request: The request object to send.
|
||||
:param retries: Override the default retry configuration for this method
|
||||
:param server_url: Override the default server URL for this method
|
||||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||||
@@ -2725,9 +2966,9 @@ class Library(BaseSDK):
|
||||
if server_url is not None:
|
||||
base_url = server_url
|
||||
|
||||
request = operations.GetMetaDataByRatingKeyRequest(
|
||||
rating_key=rating_key,
|
||||
)
|
||||
if not isinstance(request, BaseModel):
|
||||
request = utils.unmarshal(request, operations.GetMediaMetaDataRequest)
|
||||
request = cast(operations.GetMediaMetaDataRequest, request)
|
||||
|
||||
req = self._build_request_async(
|
||||
method="GET",
|
||||
@@ -2755,21 +2996,20 @@ class Library(BaseSDK):
|
||||
|
||||
http_res = await self.do_request_async(
|
||||
hook_ctx=HookContext(
|
||||
operation_id="get-meta-data-by-rating-key",
|
||||
operation_id="get-media-meta-data",
|
||||
oauth2_scopes=[],
|
||||
security_source=self.sdk_configuration.security,
|
||||
),
|
||||
request=req,
|
||||
error_status_codes=["400", "401", "4XX", "5XX"],
|
||||
error_status_codes=["400", "401", "404", "4XX", "5XX"],
|
||||
retry_config=retry_config,
|
||||
)
|
||||
|
||||
response_data: Any = None
|
||||
if utils.match_response(http_res, "200", "application/json"):
|
||||
return operations.GetMetaDataByRatingKeyResponse(
|
||||
return operations.GetMediaMetaDataResponse(
|
||||
object=utils.unmarshal_json(
|
||||
http_res.text,
|
||||
Optional[operations.GetMetaDataByRatingKeyResponseBody],
|
||||
http_res.text, Optional[operations.GetMediaMetaDataResponseBody]
|
||||
),
|
||||
status_code=http_res.status_code,
|
||||
content_type=http_res.headers.get("Content-Type") or "",
|
||||
@@ -2777,17 +3017,17 @@ class Library(BaseSDK):
|
||||
)
|
||||
if utils.match_response(http_res, "400", "application/json"):
|
||||
response_data = utils.unmarshal_json(
|
||||
http_res.text, errors.GetMetaDataByRatingKeyBadRequestData
|
||||
http_res.text, errors.GetMediaMetaDataBadRequestData
|
||||
)
|
||||
response_data.raw_response = http_res
|
||||
raise errors.GetMetaDataByRatingKeyBadRequest(data=response_data)
|
||||
raise errors.GetMediaMetaDataBadRequest(data=response_data)
|
||||
if utils.match_response(http_res, "401", "application/json"):
|
||||
response_data = utils.unmarshal_json(
|
||||
http_res.text, errors.GetMetaDataByRatingKeyUnauthorizedData
|
||||
http_res.text, errors.GetMediaMetaDataUnauthorizedData
|
||||
)
|
||||
response_data.raw_response = http_res
|
||||
raise errors.GetMetaDataByRatingKeyUnauthorized(data=response_data)
|
||||
if utils.match_response(http_res, "4XX", "*"):
|
||||
raise errors.GetMediaMetaDataUnauthorized(data=response_data)
|
||||
if utils.match_response(http_res, ["404", "4XX"], "*"):
|
||||
http_res_text = await utils.stream_to_text_async(http_res)
|
||||
raise errors.SDKError(
|
||||
"API error occurred", http_res.status_code, http_res_text, http_res
|
||||
@@ -3046,7 +3286,7 @@ class Library(BaseSDK):
|
||||
This endpoint will return the top watched content from libraries of a certain type
|
||||
|
||||
|
||||
:param type: The type of media to retrieve. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
:param type: The type of media to retrieve or filter by. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
:param include_guids: Adds the Guids object to the response
|
||||
:param retries: Override the default retry configuration for this method
|
||||
:param server_url: Override the default server URL for this method
|
||||
@@ -3158,7 +3398,7 @@ class Library(BaseSDK):
|
||||
This endpoint will return the top watched content from libraries of a certain type
|
||||
|
||||
|
||||
:param type: The type of media to retrieve. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
:param type: The type of media to retrieve or filter by. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
:param include_guids: Adds the Guids object to the response
|
||||
:param retries: Override the default retry configuration for this method
|
||||
:param server_url: Override the default server URL for this method
|
||||
|
||||
@@ -90,6 +90,16 @@ from .enablepapertrail import (
|
||||
EnablePaperTrailUnauthorized,
|
||||
EnablePaperTrailUnauthorizedData,
|
||||
)
|
||||
from .get_actors_library import (
|
||||
GetActorsLibraryBadRequest,
|
||||
GetActorsLibraryBadRequestData,
|
||||
GetActorsLibraryErrors,
|
||||
GetActorsLibraryErrorsTypedDict,
|
||||
GetActorsLibraryLibraryErrors,
|
||||
GetActorsLibraryLibraryErrorsTypedDict,
|
||||
GetActorsLibraryUnauthorized,
|
||||
GetActorsLibraryUnauthorizedData,
|
||||
)
|
||||
from .get_all_libraries import (
|
||||
GetAllLibrariesBadRequest,
|
||||
GetAllLibrariesBadRequestData,
|
||||
@@ -150,6 +160,16 @@ from .get_library_items import (
|
||||
GetLibraryItemsUnauthorized,
|
||||
GetLibraryItemsUnauthorizedData,
|
||||
)
|
||||
from .get_media_meta_data import (
|
||||
GetMediaMetaDataBadRequest,
|
||||
GetMediaMetaDataBadRequestData,
|
||||
GetMediaMetaDataErrors,
|
||||
GetMediaMetaDataErrorsTypedDict,
|
||||
GetMediaMetaDataLibraryErrors,
|
||||
GetMediaMetaDataLibraryErrorsTypedDict,
|
||||
GetMediaMetaDataUnauthorized,
|
||||
GetMediaMetaDataUnauthorizedData,
|
||||
)
|
||||
from .get_media_providers import (
|
||||
GetMediaProvidersBadRequest,
|
||||
GetMediaProvidersBadRequestData,
|
||||
@@ -160,16 +180,6 @@ from .get_media_providers import (
|
||||
GetMediaProvidersUnauthorized,
|
||||
GetMediaProvidersUnauthorizedData,
|
||||
)
|
||||
from .get_meta_data_by_rating_key import (
|
||||
GetMetaDataByRatingKeyBadRequest,
|
||||
GetMetaDataByRatingKeyBadRequestData,
|
||||
GetMetaDataByRatingKeyErrors,
|
||||
GetMetaDataByRatingKeyErrorsTypedDict,
|
||||
GetMetaDataByRatingKeyLibraryErrors,
|
||||
GetMetaDataByRatingKeyLibraryErrorsTypedDict,
|
||||
GetMetaDataByRatingKeyUnauthorized,
|
||||
GetMetaDataByRatingKeyUnauthorizedData,
|
||||
)
|
||||
from .get_recently_added_library import (
|
||||
GetRecentlyAddedLibraryBadRequest,
|
||||
GetRecentlyAddedLibraryBadRequestData,
|
||||
@@ -848,6 +858,14 @@ __all__ = [
|
||||
"EnablePaperTrailUnauthorizedData",
|
||||
"Errors",
|
||||
"ErrorsTypedDict",
|
||||
"GetActorsLibraryBadRequest",
|
||||
"GetActorsLibraryBadRequestData",
|
||||
"GetActorsLibraryErrors",
|
||||
"GetActorsLibraryErrorsTypedDict",
|
||||
"GetActorsLibraryLibraryErrors",
|
||||
"GetActorsLibraryLibraryErrorsTypedDict",
|
||||
"GetActorsLibraryUnauthorized",
|
||||
"GetActorsLibraryUnauthorizedData",
|
||||
"GetAllLibrariesBadRequest",
|
||||
"GetAllLibrariesBadRequestData",
|
||||
"GetAllLibrariesErrors",
|
||||
@@ -976,6 +994,14 @@ __all__ = [
|
||||
"GetLibraryItemsLibraryErrorsTypedDict",
|
||||
"GetLibraryItemsUnauthorized",
|
||||
"GetLibraryItemsUnauthorizedData",
|
||||
"GetMediaMetaDataBadRequest",
|
||||
"GetMediaMetaDataBadRequestData",
|
||||
"GetMediaMetaDataErrors",
|
||||
"GetMediaMetaDataErrorsTypedDict",
|
||||
"GetMediaMetaDataLibraryErrors",
|
||||
"GetMediaMetaDataLibraryErrorsTypedDict",
|
||||
"GetMediaMetaDataUnauthorized",
|
||||
"GetMediaMetaDataUnauthorizedData",
|
||||
"GetMediaProvidersBadRequest",
|
||||
"GetMediaProvidersBadRequestData",
|
||||
"GetMediaProvidersErrors",
|
||||
@@ -984,14 +1010,6 @@ __all__ = [
|
||||
"GetMediaProvidersServerErrorsTypedDict",
|
||||
"GetMediaProvidersUnauthorized",
|
||||
"GetMediaProvidersUnauthorizedData",
|
||||
"GetMetaDataByRatingKeyBadRequest",
|
||||
"GetMetaDataByRatingKeyBadRequestData",
|
||||
"GetMetaDataByRatingKeyErrors",
|
||||
"GetMetaDataByRatingKeyErrorsTypedDict",
|
||||
"GetMetaDataByRatingKeyLibraryErrors",
|
||||
"GetMetaDataByRatingKeyLibraryErrorsTypedDict",
|
||||
"GetMetaDataByRatingKeyUnauthorized",
|
||||
"GetMetaDataByRatingKeyUnauthorizedData",
|
||||
"GetMetadataChildrenBadRequest",
|
||||
"GetMetadataChildrenBadRequestData",
|
||||
"GetMetadataChildrenErrors",
|
||||
|
||||
@@ -9,13 +9,13 @@ from typing import List, Optional
|
||||
from typing_extensions import Annotated, NotRequired, TypedDict
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyLibraryErrorsTypedDict(TypedDict):
|
||||
class GetActorsLibraryLibraryErrorsTypedDict(TypedDict):
|
||||
code: NotRequired[int]
|
||||
message: NotRequired[str]
|
||||
status: NotRequired[int]
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyLibraryErrors(BaseModel):
|
||||
class GetActorsLibraryLibraryErrors(BaseModel):
|
||||
code: Optional[int] = None
|
||||
|
||||
message: Optional[str] = None
|
||||
@@ -23,8 +23,8 @@ class GetMetaDataByRatingKeyLibraryErrors(BaseModel):
|
||||
status: Optional[int] = None
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyUnauthorizedData(BaseModel):
|
||||
errors: Optional[List[GetMetaDataByRatingKeyLibraryErrors]] = None
|
||||
class GetActorsLibraryUnauthorizedData(BaseModel):
|
||||
errors: Optional[List[GetActorsLibraryLibraryErrors]] = None
|
||||
|
||||
raw_response: Annotated[Optional[httpx.Response], pydantic.Field(exclude=True)] = (
|
||||
None
|
||||
@@ -32,25 +32,25 @@ class GetMetaDataByRatingKeyUnauthorizedData(BaseModel):
|
||||
r"""Raw HTTP response; suitable for custom response parsing"""
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyUnauthorized(Exception):
|
||||
class GetActorsLibraryUnauthorized(Exception):
|
||||
r"""Unauthorized - Returned if the X-Plex-Token is missing from the header or query."""
|
||||
|
||||
data: GetMetaDataByRatingKeyUnauthorizedData
|
||||
data: GetActorsLibraryUnauthorizedData
|
||||
|
||||
def __init__(self, data: GetMetaDataByRatingKeyUnauthorizedData):
|
||||
def __init__(self, data: GetActorsLibraryUnauthorizedData):
|
||||
self.data = data
|
||||
|
||||
def __str__(self) -> str:
|
||||
return utils.marshal_json(self.data, GetMetaDataByRatingKeyUnauthorizedData)
|
||||
return utils.marshal_json(self.data, GetActorsLibraryUnauthorizedData)
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyErrorsTypedDict(TypedDict):
|
||||
class GetActorsLibraryErrorsTypedDict(TypedDict):
|
||||
code: NotRequired[int]
|
||||
message: NotRequired[str]
|
||||
status: NotRequired[int]
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyErrors(BaseModel):
|
||||
class GetActorsLibraryErrors(BaseModel):
|
||||
code: Optional[int] = None
|
||||
|
||||
message: Optional[str] = None
|
||||
@@ -58,8 +58,8 @@ class GetMetaDataByRatingKeyErrors(BaseModel):
|
||||
status: Optional[int] = None
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyBadRequestData(BaseModel):
|
||||
errors: Optional[List[GetMetaDataByRatingKeyErrors]] = None
|
||||
class GetActorsLibraryBadRequestData(BaseModel):
|
||||
errors: Optional[List[GetActorsLibraryErrors]] = None
|
||||
|
||||
raw_response: Annotated[Optional[httpx.Response], pydantic.Field(exclude=True)] = (
|
||||
None
|
||||
@@ -67,13 +67,13 @@ class GetMetaDataByRatingKeyBadRequestData(BaseModel):
|
||||
r"""Raw HTTP response; suitable for custom response parsing"""
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyBadRequest(Exception):
|
||||
class GetActorsLibraryBadRequest(Exception):
|
||||
r"""Bad Request - A parameter was not specified, or was specified incorrectly."""
|
||||
|
||||
data: GetMetaDataByRatingKeyBadRequestData
|
||||
data: GetActorsLibraryBadRequestData
|
||||
|
||||
def __init__(self, data: GetMetaDataByRatingKeyBadRequestData):
|
||||
def __init__(self, data: GetActorsLibraryBadRequestData):
|
||||
self.data = data
|
||||
|
||||
def __str__(self) -> str:
|
||||
return utils.marshal_json(self.data, GetMetaDataByRatingKeyBadRequestData)
|
||||
return utils.marshal_json(self.data, GetActorsLibraryBadRequestData)
|
||||
79
src/plex_api_client/models/errors/get_media_meta_data.py
Normal file
79
src/plex_api_client/models/errors/get_media_meta_data.py
Normal file
@@ -0,0 +1,79 @@
|
||||
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
||||
|
||||
from __future__ import annotations
|
||||
import httpx
|
||||
from plex_api_client import utils
|
||||
from plex_api_client.types import BaseModel
|
||||
import pydantic
|
||||
from typing import List, Optional
|
||||
from typing_extensions import Annotated, NotRequired, TypedDict
|
||||
|
||||
|
||||
class GetMediaMetaDataLibraryErrorsTypedDict(TypedDict):
|
||||
code: NotRequired[int]
|
||||
message: NotRequired[str]
|
||||
status: NotRequired[int]
|
||||
|
||||
|
||||
class GetMediaMetaDataLibraryErrors(BaseModel):
|
||||
code: Optional[int] = None
|
||||
|
||||
message: Optional[str] = None
|
||||
|
||||
status: Optional[int] = None
|
||||
|
||||
|
||||
class GetMediaMetaDataUnauthorizedData(BaseModel):
|
||||
errors: Optional[List[GetMediaMetaDataLibraryErrors]] = None
|
||||
|
||||
raw_response: Annotated[Optional[httpx.Response], pydantic.Field(exclude=True)] = (
|
||||
None
|
||||
)
|
||||
r"""Raw HTTP response; suitable for custom response parsing"""
|
||||
|
||||
|
||||
class GetMediaMetaDataUnauthorized(Exception):
|
||||
r"""Unauthorized - Returned if the X-Plex-Token is missing from the header or query."""
|
||||
|
||||
data: GetMediaMetaDataUnauthorizedData
|
||||
|
||||
def __init__(self, data: GetMediaMetaDataUnauthorizedData):
|
||||
self.data = data
|
||||
|
||||
def __str__(self) -> str:
|
||||
return utils.marshal_json(self.data, GetMediaMetaDataUnauthorizedData)
|
||||
|
||||
|
||||
class GetMediaMetaDataErrorsTypedDict(TypedDict):
|
||||
code: NotRequired[int]
|
||||
message: NotRequired[str]
|
||||
status: NotRequired[int]
|
||||
|
||||
|
||||
class GetMediaMetaDataErrors(BaseModel):
|
||||
code: Optional[int] = None
|
||||
|
||||
message: Optional[str] = None
|
||||
|
||||
status: Optional[int] = None
|
||||
|
||||
|
||||
class GetMediaMetaDataBadRequestData(BaseModel):
|
||||
errors: Optional[List[GetMediaMetaDataErrors]] = None
|
||||
|
||||
raw_response: Annotated[Optional[httpx.Response], pydantic.Field(exclude=True)] = (
|
||||
None
|
||||
)
|
||||
r"""Raw HTTP response; suitable for custom response parsing"""
|
||||
|
||||
|
||||
class GetMediaMetaDataBadRequest(Exception):
|
||||
r"""Bad Request - A parameter was not specified, or was specified incorrectly."""
|
||||
|
||||
data: GetMediaMetaDataBadRequestData
|
||||
|
||||
def __init__(self, data: GetMediaMetaDataBadRequestData):
|
||||
self.data = data
|
||||
|
||||
def __str__(self) -> str:
|
||||
return utils.marshal_json(self.data, GetMediaMetaDataBadRequestData)
|
||||
@@ -69,6 +69,19 @@ from .enablepapertrail import (
|
||||
EnablePaperTrailResponse,
|
||||
EnablePaperTrailResponseTypedDict,
|
||||
)
|
||||
from .get_actors_library import (
|
||||
GetActorsLibraryDirectory,
|
||||
GetActorsLibraryDirectoryTypedDict,
|
||||
GetActorsLibraryMediaContainer,
|
||||
GetActorsLibraryMediaContainerTypedDict,
|
||||
GetActorsLibraryQueryParamType,
|
||||
GetActorsLibraryRequest,
|
||||
GetActorsLibraryRequestTypedDict,
|
||||
GetActorsLibraryResponse,
|
||||
GetActorsLibraryResponseBody,
|
||||
GetActorsLibraryResponseBodyTypedDict,
|
||||
GetActorsLibraryResponseTypedDict,
|
||||
)
|
||||
from .get_all_libraries import (
|
||||
GetAllLibrariesDirectory,
|
||||
GetAllLibrariesDirectoryTypedDict,
|
||||
@@ -92,6 +105,7 @@ from .get_countries_library import (
|
||||
GetCountriesLibraryDirectoryTypedDict,
|
||||
GetCountriesLibraryMediaContainer,
|
||||
GetCountriesLibraryMediaContainerTypedDict,
|
||||
GetCountriesLibraryQueryParamType,
|
||||
GetCountriesLibraryRequest,
|
||||
GetCountriesLibraryRequestTypedDict,
|
||||
GetCountriesLibraryResponse,
|
||||
@@ -104,6 +118,7 @@ from .get_genres_library import (
|
||||
GetGenresLibraryDirectoryTypedDict,
|
||||
GetGenresLibraryMediaContainer,
|
||||
GetGenresLibraryMediaContainerTypedDict,
|
||||
GetGenresLibraryQueryParamType,
|
||||
GetGenresLibraryRequest,
|
||||
GetGenresLibraryRequestTypedDict,
|
||||
GetGenresLibraryResponse,
|
||||
@@ -218,6 +233,48 @@ from .get_library_items import (
|
||||
IncludeGuids,
|
||||
Tag,
|
||||
)
|
||||
from .get_media_meta_data import (
|
||||
GetMediaMetaDataCountry,
|
||||
GetMediaMetaDataCountryTypedDict,
|
||||
GetMediaMetaDataDirector,
|
||||
GetMediaMetaDataDirectorTypedDict,
|
||||
GetMediaMetaDataGenre,
|
||||
GetMediaMetaDataGenreTypedDict,
|
||||
GetMediaMetaDataImage,
|
||||
GetMediaMetaDataImageTypedDict,
|
||||
GetMediaMetaDataLocation,
|
||||
GetMediaMetaDataLocationTypedDict,
|
||||
GetMediaMetaDataMedia,
|
||||
GetMediaMetaDataMediaContainer,
|
||||
GetMediaMetaDataMediaContainerTypedDict,
|
||||
GetMediaMetaDataMediaTypedDict,
|
||||
GetMediaMetaDataMetadata,
|
||||
GetMediaMetaDataMetadataTypedDict,
|
||||
GetMediaMetaDataPart,
|
||||
GetMediaMetaDataPartTypedDict,
|
||||
GetMediaMetaDataRequest,
|
||||
GetMediaMetaDataRequestTypedDict,
|
||||
GetMediaMetaDataResponse,
|
||||
GetMediaMetaDataResponseBody,
|
||||
GetMediaMetaDataResponseBodyTypedDict,
|
||||
GetMediaMetaDataResponseTypedDict,
|
||||
GetMediaMetaDataRole,
|
||||
GetMediaMetaDataRoleTypedDict,
|
||||
GetMediaMetaDataStream,
|
||||
GetMediaMetaDataStreamTypedDict,
|
||||
GetMediaMetaDataUltraBlurColors,
|
||||
GetMediaMetaDataUltraBlurColorsTypedDict,
|
||||
GetMediaMetaDataWriter,
|
||||
GetMediaMetaDataWriterTypedDict,
|
||||
Guids,
|
||||
GuidsTypedDict,
|
||||
Producer,
|
||||
ProducerTypedDict,
|
||||
Rating,
|
||||
RatingTypedDict,
|
||||
Similar,
|
||||
SimilarTypedDict,
|
||||
)
|
||||
from .get_media_providers import (
|
||||
Action,
|
||||
ActionTypedDict,
|
||||
@@ -238,40 +295,6 @@ from .get_media_providers import (
|
||||
Pivot,
|
||||
PivotTypedDict,
|
||||
)
|
||||
from .get_meta_data_by_rating_key import (
|
||||
GetMetaDataByRatingKeyCountry,
|
||||
GetMetaDataByRatingKeyCountryTypedDict,
|
||||
GetMetaDataByRatingKeyDirector,
|
||||
GetMetaDataByRatingKeyDirectorTypedDict,
|
||||
GetMetaDataByRatingKeyGenre,
|
||||
GetMetaDataByRatingKeyGenreTypedDict,
|
||||
GetMetaDataByRatingKeyMedia,
|
||||
GetMetaDataByRatingKeyMediaContainer,
|
||||
GetMetaDataByRatingKeyMediaContainerTypedDict,
|
||||
GetMetaDataByRatingKeyMediaTypedDict,
|
||||
GetMetaDataByRatingKeyMetadata,
|
||||
GetMetaDataByRatingKeyMetadataTypedDict,
|
||||
GetMetaDataByRatingKeyPart,
|
||||
GetMetaDataByRatingKeyPartTypedDict,
|
||||
GetMetaDataByRatingKeyRequest,
|
||||
GetMetaDataByRatingKeyRequestTypedDict,
|
||||
GetMetaDataByRatingKeyResponse,
|
||||
GetMetaDataByRatingKeyResponseBody,
|
||||
GetMetaDataByRatingKeyResponseBodyTypedDict,
|
||||
GetMetaDataByRatingKeyResponseTypedDict,
|
||||
GetMetaDataByRatingKeyRole,
|
||||
GetMetaDataByRatingKeyRoleTypedDict,
|
||||
GetMetaDataByRatingKeyStream,
|
||||
GetMetaDataByRatingKeyStreamTypedDict,
|
||||
GetMetaDataByRatingKeyWriter,
|
||||
GetMetaDataByRatingKeyWriterTypedDict,
|
||||
Guids,
|
||||
GuidsTypedDict,
|
||||
Producer,
|
||||
ProducerTypedDict,
|
||||
Ratings,
|
||||
RatingsTypedDict,
|
||||
)
|
||||
from .get_recently_added import (
|
||||
Collection,
|
||||
CollectionTypedDict,
|
||||
@@ -1228,6 +1251,17 @@ __all__ = [
|
||||
"GenreTypedDict",
|
||||
"GeoData",
|
||||
"GeoDataTypedDict",
|
||||
"GetActorsLibraryDirectory",
|
||||
"GetActorsLibraryDirectoryTypedDict",
|
||||
"GetActorsLibraryMediaContainer",
|
||||
"GetActorsLibraryMediaContainerTypedDict",
|
||||
"GetActorsLibraryQueryParamType",
|
||||
"GetActorsLibraryRequest",
|
||||
"GetActorsLibraryRequestTypedDict",
|
||||
"GetActorsLibraryResponse",
|
||||
"GetActorsLibraryResponseBody",
|
||||
"GetActorsLibraryResponseBodyTypedDict",
|
||||
"GetActorsLibraryResponseTypedDict",
|
||||
"GetAllLibrariesDirectory",
|
||||
"GetAllLibrariesDirectoryTypedDict",
|
||||
"GetAllLibrariesLocation",
|
||||
@@ -1270,6 +1304,7 @@ __all__ = [
|
||||
"GetCountriesLibraryDirectoryTypedDict",
|
||||
"GetCountriesLibraryMediaContainer",
|
||||
"GetCountriesLibraryMediaContainerTypedDict",
|
||||
"GetCountriesLibraryQueryParamType",
|
||||
"GetCountriesLibraryRequest",
|
||||
"GetCountriesLibraryRequestTypedDict",
|
||||
"GetCountriesLibraryResponse",
|
||||
@@ -1290,6 +1325,7 @@ __all__ = [
|
||||
"GetGenresLibraryDirectoryTypedDict",
|
||||
"GetGenresLibraryMediaContainer",
|
||||
"GetGenresLibraryMediaContainerTypedDict",
|
||||
"GetGenresLibraryQueryParamType",
|
||||
"GetGenresLibraryRequest",
|
||||
"GetGenresLibraryRequestTypedDict",
|
||||
"GetGenresLibraryResponse",
|
||||
@@ -1440,6 +1476,38 @@ __all__ = [
|
||||
"GetLibraryItemsUltraBlurColorsTypedDict",
|
||||
"GetLibraryItemsWriter",
|
||||
"GetLibraryItemsWriterTypedDict",
|
||||
"GetMediaMetaDataCountry",
|
||||
"GetMediaMetaDataCountryTypedDict",
|
||||
"GetMediaMetaDataDirector",
|
||||
"GetMediaMetaDataDirectorTypedDict",
|
||||
"GetMediaMetaDataGenre",
|
||||
"GetMediaMetaDataGenreTypedDict",
|
||||
"GetMediaMetaDataImage",
|
||||
"GetMediaMetaDataImageTypedDict",
|
||||
"GetMediaMetaDataLocation",
|
||||
"GetMediaMetaDataLocationTypedDict",
|
||||
"GetMediaMetaDataMedia",
|
||||
"GetMediaMetaDataMediaContainer",
|
||||
"GetMediaMetaDataMediaContainerTypedDict",
|
||||
"GetMediaMetaDataMediaTypedDict",
|
||||
"GetMediaMetaDataMetadata",
|
||||
"GetMediaMetaDataMetadataTypedDict",
|
||||
"GetMediaMetaDataPart",
|
||||
"GetMediaMetaDataPartTypedDict",
|
||||
"GetMediaMetaDataRequest",
|
||||
"GetMediaMetaDataRequestTypedDict",
|
||||
"GetMediaMetaDataResponse",
|
||||
"GetMediaMetaDataResponseBody",
|
||||
"GetMediaMetaDataResponseBodyTypedDict",
|
||||
"GetMediaMetaDataResponseTypedDict",
|
||||
"GetMediaMetaDataRole",
|
||||
"GetMediaMetaDataRoleTypedDict",
|
||||
"GetMediaMetaDataStream",
|
||||
"GetMediaMetaDataStreamTypedDict",
|
||||
"GetMediaMetaDataUltraBlurColors",
|
||||
"GetMediaMetaDataUltraBlurColorsTypedDict",
|
||||
"GetMediaMetaDataWriter",
|
||||
"GetMediaMetaDataWriterTypedDict",
|
||||
"GetMediaProvidersDirectory",
|
||||
"GetMediaProvidersDirectoryTypedDict",
|
||||
"GetMediaProvidersMediaContainer",
|
||||
@@ -1450,32 +1518,6 @@ __all__ = [
|
||||
"GetMediaProvidersResponseBody",
|
||||
"GetMediaProvidersResponseBodyTypedDict",
|
||||
"GetMediaProvidersResponseTypedDict",
|
||||
"GetMetaDataByRatingKeyCountry",
|
||||
"GetMetaDataByRatingKeyCountryTypedDict",
|
||||
"GetMetaDataByRatingKeyDirector",
|
||||
"GetMetaDataByRatingKeyDirectorTypedDict",
|
||||
"GetMetaDataByRatingKeyGenre",
|
||||
"GetMetaDataByRatingKeyGenreTypedDict",
|
||||
"GetMetaDataByRatingKeyMedia",
|
||||
"GetMetaDataByRatingKeyMediaContainer",
|
||||
"GetMetaDataByRatingKeyMediaContainerTypedDict",
|
||||
"GetMetaDataByRatingKeyMediaTypedDict",
|
||||
"GetMetaDataByRatingKeyMetadata",
|
||||
"GetMetaDataByRatingKeyMetadataTypedDict",
|
||||
"GetMetaDataByRatingKeyPart",
|
||||
"GetMetaDataByRatingKeyPartTypedDict",
|
||||
"GetMetaDataByRatingKeyRequest",
|
||||
"GetMetaDataByRatingKeyRequestTypedDict",
|
||||
"GetMetaDataByRatingKeyResponse",
|
||||
"GetMetaDataByRatingKeyResponseBody",
|
||||
"GetMetaDataByRatingKeyResponseBodyTypedDict",
|
||||
"GetMetaDataByRatingKeyResponseTypedDict",
|
||||
"GetMetaDataByRatingKeyRole",
|
||||
"GetMetaDataByRatingKeyRoleTypedDict",
|
||||
"GetMetaDataByRatingKeyStream",
|
||||
"GetMetaDataByRatingKeyStreamTypedDict",
|
||||
"GetMetaDataByRatingKeyWriter",
|
||||
"GetMetaDataByRatingKeyWriterTypedDict",
|
||||
"GetMetadataChildrenDirectory",
|
||||
"GetMetadataChildrenDirectoryTypedDict",
|
||||
"GetMetadataChildrenMediaContainer",
|
||||
@@ -1990,8 +2032,8 @@ __all__ = [
|
||||
"QueryParamOnlyTransient",
|
||||
"QueryParamSmart",
|
||||
"QueryParamType",
|
||||
"Ratings",
|
||||
"RatingsTypedDict",
|
||||
"Rating",
|
||||
"RatingTypedDict",
|
||||
"Release",
|
||||
"ReleaseTypedDict",
|
||||
"ResponseBody",
|
||||
@@ -2016,6 +2058,8 @@ __all__ = [
|
||||
"SharedSources",
|
||||
"SharedSourcesTypedDict",
|
||||
"ShowOrdering",
|
||||
"Similar",
|
||||
"SimilarTypedDict",
|
||||
"Skip",
|
||||
"Smart",
|
||||
"Sort",
|
||||
|
||||
205
src/plex_api_client/models/operations/get_actors_library.py
Normal file
205
src/plex_api_client/models/operations/get_actors_library.py
Normal file
@@ -0,0 +1,205 @@
|
||||
"""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
|
||||
from plex_api_client.utils import FieldMetadata, PathParamMetadata, QueryParamMetadata
|
||||
import pydantic
|
||||
from typing import List, Optional
|
||||
from typing_extensions import Annotated, NotRequired, TypedDict
|
||||
|
||||
|
||||
class GetActorsLibraryQueryParamType(int, Enum):
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
"""
|
||||
|
||||
MOVIE = 1
|
||||
TV_SHOW = 2
|
||||
SEASON = 3
|
||||
EPISODE = 4
|
||||
AUDIO = 8
|
||||
ALBUM = 9
|
||||
TRACK = 10
|
||||
|
||||
|
||||
class GetActorsLibraryRequestTypedDict(TypedDict):
|
||||
section_key: int
|
||||
r"""The unique key of the Plex library.
|
||||
Note: This is unique in the context of the Plex server.
|
||||
|
||||
"""
|
||||
type: GetActorsLibraryQueryParamType
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
"""
|
||||
|
||||
|
||||
class GetActorsLibraryRequest(BaseModel):
|
||||
section_key: Annotated[
|
||||
int,
|
||||
pydantic.Field(alias="sectionKey"),
|
||||
FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
|
||||
]
|
||||
r"""The unique key of the Plex library.
|
||||
Note: This is unique in the context of the Plex server.
|
||||
|
||||
"""
|
||||
|
||||
type: Annotated[
|
||||
GetActorsLibraryQueryParamType,
|
||||
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
||||
]
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
"""
|
||||
|
||||
|
||||
class GetActorsLibraryDirectoryTypedDict(TypedDict):
|
||||
fast_key: str
|
||||
r"""A fast lookup key for the actor relative url."""
|
||||
thumb: str
|
||||
r"""URL for the thumbnail image of the actor."""
|
||||
key: str
|
||||
r"""A unique key representing the actor."""
|
||||
title: str
|
||||
r"""The name of the actor."""
|
||||
|
||||
|
||||
class GetActorsLibraryDirectory(BaseModel):
|
||||
fast_key: Annotated[str, pydantic.Field(alias="fastKey")]
|
||||
r"""A fast lookup key for the actor relative url."""
|
||||
|
||||
thumb: str
|
||||
r"""URL for the thumbnail image of the actor."""
|
||||
|
||||
key: str
|
||||
r"""A unique key representing the actor."""
|
||||
|
||||
title: str
|
||||
r"""The name of the actor."""
|
||||
|
||||
|
||||
class GetActorsLibraryMediaContainerTypedDict(TypedDict):
|
||||
size: float
|
||||
allow_sync: bool
|
||||
r"""Indicates whether syncing is allowed."""
|
||||
art: str
|
||||
r"""URL for the background artwork of the media container."""
|
||||
identifier: str
|
||||
r"""An plugin identifier for the media container."""
|
||||
media_tag_prefix: str
|
||||
r"""The prefix used for media tag resource paths."""
|
||||
media_tag_version: int
|
||||
r"""The version number for media tags."""
|
||||
nocache: bool
|
||||
r"""Specifies whether caching is disabled."""
|
||||
thumb: str
|
||||
r"""URL for the thumbnail image of the media container."""
|
||||
title1: str
|
||||
r"""The primary title of the media container."""
|
||||
title2: str
|
||||
r"""The secondary title of the media container."""
|
||||
view_group: str
|
||||
r"""Identifier for the view group layout."""
|
||||
view_mode: str
|
||||
r"""Identifier for the view mode."""
|
||||
directory: NotRequired[List[GetActorsLibraryDirectoryTypedDict]]
|
||||
r"""An array of actor entries for media items."""
|
||||
|
||||
|
||||
class GetActorsLibraryMediaContainer(BaseModel):
|
||||
size: float
|
||||
|
||||
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."""
|
||||
|
||||
identifier: str
|
||||
r"""An plugin identifier for the media container."""
|
||||
|
||||
media_tag_prefix: Annotated[str, pydantic.Field(alias="mediaTagPrefix")]
|
||||
r"""The prefix used for media tag resource paths."""
|
||||
|
||||
media_tag_version: Annotated[int, pydantic.Field(alias="mediaTagVersion")]
|
||||
r"""The version number for media tags."""
|
||||
|
||||
nocache: bool
|
||||
r"""Specifies whether caching is disabled."""
|
||||
|
||||
thumb: str
|
||||
r"""URL for the thumbnail image of the media container."""
|
||||
|
||||
title1: str
|
||||
r"""The primary title of the media container."""
|
||||
|
||||
title2: str
|
||||
r"""The secondary title of the media container."""
|
||||
|
||||
view_group: Annotated[str, pydantic.Field(alias="viewGroup")]
|
||||
r"""Identifier for the view group layout."""
|
||||
|
||||
view_mode: Annotated[str, pydantic.Field(alias="viewMode")]
|
||||
r"""Identifier for the view mode."""
|
||||
|
||||
directory: Annotated[
|
||||
Optional[List[GetActorsLibraryDirectory]], pydantic.Field(alias="Directory")
|
||||
] = None
|
||||
r"""An array of actor entries for media items."""
|
||||
|
||||
|
||||
class GetActorsLibraryResponseBodyTypedDict(TypedDict):
|
||||
r"""Successful response containing media container data."""
|
||||
|
||||
media_container: NotRequired[GetActorsLibraryMediaContainerTypedDict]
|
||||
|
||||
|
||||
class GetActorsLibraryResponseBody(BaseModel):
|
||||
r"""Successful response containing media container data."""
|
||||
|
||||
media_container: Annotated[
|
||||
Optional[GetActorsLibraryMediaContainer], pydantic.Field(alias="MediaContainer")
|
||||
] = None
|
||||
|
||||
|
||||
class GetActorsLibraryResponseTypedDict(TypedDict):
|
||||
content_type: str
|
||||
r"""HTTP response content type for this operation"""
|
||||
status_code: int
|
||||
r"""HTTP response status code for this operation"""
|
||||
raw_response: httpx.Response
|
||||
r"""Raw HTTP response; suitable for custom response parsing"""
|
||||
object: NotRequired[GetActorsLibraryResponseBodyTypedDict]
|
||||
r"""Successful response containing media container data."""
|
||||
|
||||
|
||||
class GetActorsLibraryResponse(BaseModel):
|
||||
content_type: str
|
||||
r"""HTTP response content type for this operation"""
|
||||
|
||||
status_code: int
|
||||
r"""HTTP response status code for this operation"""
|
||||
|
||||
raw_response: httpx.Response
|
||||
r"""Raw HTTP response; suitable for custom response parsing"""
|
||||
|
||||
object: Optional[GetActorsLibraryResponseBody] = None
|
||||
r"""Successful response containing media container data."""
|
||||
@@ -1,20 +1,49 @@
|
||||
"""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
|
||||
from plex_api_client.utils import FieldMetadata, PathParamMetadata
|
||||
from plex_api_client.utils import FieldMetadata, PathParamMetadata, QueryParamMetadata
|
||||
import pydantic
|
||||
from typing import List, Optional
|
||||
from typing_extensions import Annotated, NotRequired, TypedDict
|
||||
|
||||
|
||||
class GetCountriesLibraryQueryParamType(int, Enum):
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
"""
|
||||
|
||||
MOVIE = 1
|
||||
TV_SHOW = 2
|
||||
SEASON = 3
|
||||
EPISODE = 4
|
||||
AUDIO = 8
|
||||
ALBUM = 9
|
||||
TRACK = 10
|
||||
|
||||
|
||||
class GetCountriesLibraryRequestTypedDict(TypedDict):
|
||||
section_key: int
|
||||
r"""The unique key of the Plex library.
|
||||
Note: This is unique in the context of the Plex server.
|
||||
|
||||
"""
|
||||
type: GetCountriesLibraryQueryParamType
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
"""
|
||||
|
||||
|
||||
class GetCountriesLibraryRequest(BaseModel):
|
||||
@@ -28,6 +57,19 @@ class GetCountriesLibraryRequest(BaseModel):
|
||||
|
||||
"""
|
||||
|
||||
type: Annotated[
|
||||
GetCountriesLibraryQueryParamType,
|
||||
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
||||
]
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
"""
|
||||
|
||||
|
||||
class GetCountriesLibraryDirectoryTypedDict(TypedDict):
|
||||
fast_key: str
|
||||
|
||||
@@ -1,20 +1,49 @@
|
||||
"""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
|
||||
from plex_api_client.utils import FieldMetadata, PathParamMetadata
|
||||
from plex_api_client.utils import FieldMetadata, PathParamMetadata, QueryParamMetadata
|
||||
import pydantic
|
||||
from typing import List, Optional
|
||||
from typing_extensions import Annotated, NotRequired, TypedDict
|
||||
|
||||
|
||||
class GetGenresLibraryQueryParamType(int, Enum):
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
"""
|
||||
|
||||
MOVIE = 1
|
||||
TV_SHOW = 2
|
||||
SEASON = 3
|
||||
EPISODE = 4
|
||||
AUDIO = 8
|
||||
ALBUM = 9
|
||||
TRACK = 10
|
||||
|
||||
|
||||
class GetGenresLibraryRequestTypedDict(TypedDict):
|
||||
section_key: int
|
||||
r"""The unique key of the Plex library.
|
||||
Note: This is unique in the context of the Plex server.
|
||||
|
||||
"""
|
||||
type: GetGenresLibraryQueryParamType
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
"""
|
||||
|
||||
|
||||
class GetGenresLibraryRequest(BaseModel):
|
||||
@@ -28,6 +57,19 @@ class GetGenresLibraryRequest(BaseModel):
|
||||
|
||||
"""
|
||||
|
||||
type: Annotated[
|
||||
GetGenresLibraryQueryParamType,
|
||||
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
||||
]
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
"""
|
||||
|
||||
|
||||
class GetGenresLibraryDirectoryTypedDict(TypedDict):
|
||||
fast_key: str
|
||||
|
||||
@@ -44,7 +44,7 @@ class IncludeGuids(int, Enum):
|
||||
|
||||
|
||||
class GetLibraryItemsQueryParamType(int, Enum):
|
||||
r"""The type of media to retrieve.
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
@@ -72,6 +72,15 @@ class GetLibraryItemsQueryParamIncludeMeta(int, Enum):
|
||||
class GetLibraryItemsRequestTypedDict(TypedDict):
|
||||
tag: Tag
|
||||
r"""A key representing a specific tag within the section."""
|
||||
type: GetLibraryItemsQueryParamType
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
"""
|
||||
section_key: int
|
||||
r"""The unique key of the Plex library.
|
||||
Note: This is unique in the context of the Plex server.
|
||||
@@ -80,15 +89,6 @@ class GetLibraryItemsRequestTypedDict(TypedDict):
|
||||
include_guids: NotRequired[IncludeGuids]
|
||||
r"""Adds the Guids object to the response
|
||||
|
||||
"""
|
||||
type: NotRequired[GetLibraryItemsQueryParamType]
|
||||
r"""The type of media to retrieve.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
"""
|
||||
include_meta: NotRequired[GetLibraryItemsQueryParamIncludeMeta]
|
||||
r"""Adds the Meta object to the response
|
||||
@@ -114,6 +114,19 @@ class GetLibraryItemsRequest(BaseModel):
|
||||
]
|
||||
r"""A key representing a specific tag within the section."""
|
||||
|
||||
type: Annotated[
|
||||
GetLibraryItemsQueryParamType,
|
||||
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
||||
]
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
"""
|
||||
|
||||
section_key: Annotated[
|
||||
int,
|
||||
pydantic.Field(alias="sectionKey"),
|
||||
@@ -133,19 +146,6 @@ class GetLibraryItemsRequest(BaseModel):
|
||||
|
||||
"""
|
||||
|
||||
type: Annotated[
|
||||
Optional[GetLibraryItemsQueryParamType],
|
||||
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
||||
] = None
|
||||
r"""The type of media to retrieve.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
"""
|
||||
|
||||
include_meta: Annotated[
|
||||
Optional[GetLibraryItemsQueryParamIncludeMeta],
|
||||
pydantic.Field(alias="includeMeta"),
|
||||
|
||||
1242
src/plex_api_client/models/operations/get_media_meta_data.py
Normal file
1242
src/plex_api_client/models/operations/get_media_meta_data.py
Normal file
File diff suppressed because it is too large
Load Diff
@@ -1,629 +0,0 @@
|
||||
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
||||
|
||||
from __future__ import annotations
|
||||
from datetime import date
|
||||
import httpx
|
||||
from plex_api_client.types import BaseModel
|
||||
from plex_api_client.utils import FieldMetadata, PathParamMetadata
|
||||
import pydantic
|
||||
from typing import List, Optional
|
||||
from typing_extensions import Annotated, NotRequired, TypedDict
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyRequestTypedDict(TypedDict):
|
||||
rating_key: int
|
||||
r"""the id of the library item to return the children of."""
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyRequest(BaseModel):
|
||||
rating_key: Annotated[
|
||||
int,
|
||||
pydantic.Field(alias="ratingKey"),
|
||||
FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
|
||||
]
|
||||
r"""the id of the library item to return the children of."""
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyStreamTypedDict(TypedDict):
|
||||
id: NotRequired[int]
|
||||
stream_type: NotRequired[int]
|
||||
default: NotRequired[bool]
|
||||
codec: NotRequired[str]
|
||||
index: NotRequired[int]
|
||||
bitrate: NotRequired[int]
|
||||
bit_depth: NotRequired[int]
|
||||
chroma_location: NotRequired[str]
|
||||
chroma_subsampling: NotRequired[str]
|
||||
coded_height: NotRequired[int]
|
||||
coded_width: NotRequired[int]
|
||||
color_primaries: NotRequired[str]
|
||||
color_range: NotRequired[str]
|
||||
color_space: NotRequired[str]
|
||||
color_trc: NotRequired[str]
|
||||
frame_rate: NotRequired[int]
|
||||
has_scaling_matrix: NotRequired[bool]
|
||||
height: NotRequired[int]
|
||||
level: NotRequired[int]
|
||||
profile: NotRequired[str]
|
||||
ref_frames: NotRequired[int]
|
||||
scan_type: NotRequired[str]
|
||||
stream_identifier: NotRequired[str]
|
||||
width: NotRequired[int]
|
||||
display_title: NotRequired[str]
|
||||
extended_display_title: NotRequired[str]
|
||||
selected: NotRequired[bool]
|
||||
channels: NotRequired[int]
|
||||
language: NotRequired[str]
|
||||
language_tag: NotRequired[str]
|
||||
language_code: NotRequired[str]
|
||||
sampling_rate: NotRequired[int]
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyStream(BaseModel):
|
||||
id: Optional[int] = None
|
||||
|
||||
stream_type: Annotated[Optional[int], pydantic.Field(alias="streamType")] = None
|
||||
|
||||
default: Optional[bool] = None
|
||||
|
||||
codec: Optional[str] = None
|
||||
|
||||
index: Optional[int] = None
|
||||
|
||||
bitrate: Optional[int] = None
|
||||
|
||||
bit_depth: Annotated[Optional[int], pydantic.Field(alias="bitDepth")] = None
|
||||
|
||||
chroma_location: Annotated[
|
||||
Optional[str], pydantic.Field(alias="chromaLocation")
|
||||
] = None
|
||||
|
||||
chroma_subsampling: Annotated[
|
||||
Optional[str], pydantic.Field(alias="chromaSubsampling")
|
||||
] = None
|
||||
|
||||
coded_height: Annotated[Optional[int], pydantic.Field(alias="codedHeight")] = None
|
||||
|
||||
coded_width: Annotated[Optional[int], pydantic.Field(alias="codedWidth")] = None
|
||||
|
||||
color_primaries: Annotated[
|
||||
Optional[str], pydantic.Field(alias="colorPrimaries")
|
||||
] = None
|
||||
|
||||
color_range: Annotated[Optional[str], pydantic.Field(alias="colorRange")] = None
|
||||
|
||||
color_space: Annotated[Optional[str], pydantic.Field(alias="colorSpace")] = None
|
||||
|
||||
color_trc: Annotated[Optional[str], pydantic.Field(alias="colorTrc")] = None
|
||||
|
||||
frame_rate: Annotated[Optional[int], pydantic.Field(alias="frameRate")] = None
|
||||
|
||||
has_scaling_matrix: Annotated[
|
||||
Optional[bool], pydantic.Field(alias="hasScalingMatrix")
|
||||
] = None
|
||||
|
||||
height: Optional[int] = None
|
||||
|
||||
level: Optional[int] = None
|
||||
|
||||
profile: Optional[str] = None
|
||||
|
||||
ref_frames: Annotated[Optional[int], pydantic.Field(alias="refFrames")] = None
|
||||
|
||||
scan_type: Annotated[Optional[str], pydantic.Field(alias="scanType")] = None
|
||||
|
||||
stream_identifier: Annotated[
|
||||
Optional[str], pydantic.Field(alias="streamIdentifier")
|
||||
] = None
|
||||
|
||||
width: Optional[int] = None
|
||||
|
||||
display_title: Annotated[Optional[str], pydantic.Field(alias="displayTitle")] = None
|
||||
|
||||
extended_display_title: Annotated[
|
||||
Optional[str], pydantic.Field(alias="extendedDisplayTitle")
|
||||
] = None
|
||||
|
||||
selected: Optional[bool] = None
|
||||
|
||||
channels: Optional[int] = None
|
||||
|
||||
language: Optional[str] = None
|
||||
|
||||
language_tag: Annotated[Optional[str], pydantic.Field(alias="languageTag")] = None
|
||||
|
||||
language_code: Annotated[Optional[str], pydantic.Field(alias="languageCode")] = None
|
||||
|
||||
sampling_rate: Annotated[Optional[int], pydantic.Field(alias="samplingRate")] = None
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyPartTypedDict(TypedDict):
|
||||
id: NotRequired[int]
|
||||
key: NotRequired[str]
|
||||
duration: NotRequired[int]
|
||||
file: NotRequired[str]
|
||||
size: NotRequired[int]
|
||||
audio_profile: NotRequired[str]
|
||||
container: NotRequired[str]
|
||||
has64bit_offsets: NotRequired[bool]
|
||||
optimized_for_streaming: NotRequired[bool]
|
||||
video_profile: NotRequired[str]
|
||||
stream: NotRequired[List[GetMetaDataByRatingKeyStreamTypedDict]]
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyPart(BaseModel):
|
||||
id: Optional[int] = None
|
||||
|
||||
key: Optional[str] = None
|
||||
|
||||
duration: Optional[int] = None
|
||||
|
||||
file: Optional[str] = None
|
||||
|
||||
size: Optional[int] = None
|
||||
|
||||
audio_profile: Annotated[Optional[str], pydantic.Field(alias="audioProfile")] = None
|
||||
|
||||
container: Optional[str] = None
|
||||
|
||||
has64bit_offsets: Annotated[
|
||||
Optional[bool], pydantic.Field(alias="has64bitOffsets")
|
||||
] = None
|
||||
|
||||
optimized_for_streaming: Annotated[
|
||||
Optional[bool], pydantic.Field(alias="optimizedForStreaming")
|
||||
] = None
|
||||
|
||||
video_profile: Annotated[Optional[str], pydantic.Field(alias="videoProfile")] = None
|
||||
|
||||
stream: Annotated[
|
||||
Optional[List[GetMetaDataByRatingKeyStream]], pydantic.Field(alias="Stream")
|
||||
] = None
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyMediaTypedDict(TypedDict):
|
||||
id: NotRequired[int]
|
||||
duration: NotRequired[int]
|
||||
bitrate: NotRequired[int]
|
||||
width: NotRequired[int]
|
||||
height: NotRequired[int]
|
||||
aspect_ratio: NotRequired[float]
|
||||
audio_channels: NotRequired[int]
|
||||
audio_codec: NotRequired[str]
|
||||
video_codec: NotRequired[str]
|
||||
video_resolution: NotRequired[str]
|
||||
container: NotRequired[str]
|
||||
video_frame_rate: NotRequired[str]
|
||||
optimized_for_streaming: NotRequired[int]
|
||||
audio_profile: NotRequired[str]
|
||||
has64bit_offsets: NotRequired[bool]
|
||||
video_profile: NotRequired[str]
|
||||
part: NotRequired[List[GetMetaDataByRatingKeyPartTypedDict]]
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyMedia(BaseModel):
|
||||
id: Optional[int] = None
|
||||
|
||||
duration: Optional[int] = None
|
||||
|
||||
bitrate: Optional[int] = None
|
||||
|
||||
width: Optional[int] = None
|
||||
|
||||
height: Optional[int] = None
|
||||
|
||||
aspect_ratio: Annotated[Optional[float], pydantic.Field(alias="aspectRatio")] = None
|
||||
|
||||
audio_channels: Annotated[Optional[int], pydantic.Field(alias="audioChannels")] = (
|
||||
None
|
||||
)
|
||||
|
||||
audio_codec: Annotated[Optional[str], pydantic.Field(alias="audioCodec")] = None
|
||||
|
||||
video_codec: Annotated[Optional[str], pydantic.Field(alias="videoCodec")] = None
|
||||
|
||||
video_resolution: Annotated[
|
||||
Optional[str], pydantic.Field(alias="videoResolution")
|
||||
] = None
|
||||
|
||||
container: Optional[str] = None
|
||||
|
||||
video_frame_rate: Annotated[
|
||||
Optional[str], pydantic.Field(alias="videoFrameRate")
|
||||
] = None
|
||||
|
||||
optimized_for_streaming: Annotated[
|
||||
Optional[int], pydantic.Field(alias="optimizedForStreaming")
|
||||
] = None
|
||||
|
||||
audio_profile: Annotated[Optional[str], pydantic.Field(alias="audioProfile")] = None
|
||||
|
||||
has64bit_offsets: Annotated[
|
||||
Optional[bool], pydantic.Field(alias="has64bitOffsets")
|
||||
] = None
|
||||
|
||||
video_profile: Annotated[Optional[str], pydantic.Field(alias="videoProfile")] = None
|
||||
|
||||
part: Annotated[
|
||||
Optional[List[GetMetaDataByRatingKeyPart]], pydantic.Field(alias="Part")
|
||||
] = None
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyGenreTypedDict(TypedDict):
|
||||
id: NotRequired[int]
|
||||
filter_: NotRequired[str]
|
||||
tag: NotRequired[str]
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyGenre(BaseModel):
|
||||
id: Optional[int] = None
|
||||
|
||||
filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = None
|
||||
|
||||
tag: Optional[str] = None
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyCountryTypedDict(TypedDict):
|
||||
id: NotRequired[int]
|
||||
filter_: NotRequired[str]
|
||||
tag: NotRequired[str]
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyCountry(BaseModel):
|
||||
id: Optional[int] = None
|
||||
|
||||
filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = None
|
||||
|
||||
tag: Optional[str] = None
|
||||
|
||||
|
||||
class GuidsTypedDict(TypedDict):
|
||||
id: NotRequired[str]
|
||||
|
||||
|
||||
class Guids(BaseModel):
|
||||
id: Optional[str] = None
|
||||
|
||||
|
||||
class RatingsTypedDict(TypedDict):
|
||||
image: NotRequired[str]
|
||||
value: NotRequired[float]
|
||||
type: NotRequired[str]
|
||||
|
||||
|
||||
class Ratings(BaseModel):
|
||||
image: Optional[str] = None
|
||||
|
||||
value: Optional[float] = None
|
||||
|
||||
type: Optional[str] = None
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyDirectorTypedDict(TypedDict):
|
||||
id: NotRequired[int]
|
||||
filter_: NotRequired[str]
|
||||
tag: NotRequired[str]
|
||||
tag_key: NotRequired[str]
|
||||
thumb: NotRequired[str]
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyDirector(BaseModel):
|
||||
id: Optional[int] = None
|
||||
|
||||
filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = None
|
||||
|
||||
tag: Optional[str] = None
|
||||
|
||||
tag_key: Annotated[Optional[str], pydantic.Field(alias="tagKey")] = None
|
||||
|
||||
thumb: Optional[str] = None
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyWriterTypedDict(TypedDict):
|
||||
id: NotRequired[int]
|
||||
filter_: NotRequired[str]
|
||||
tag: NotRequired[str]
|
||||
tag_key: NotRequired[str]
|
||||
thumb: NotRequired[str]
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyWriter(BaseModel):
|
||||
id: Optional[int] = None
|
||||
|
||||
filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = None
|
||||
|
||||
tag: Optional[str] = None
|
||||
|
||||
tag_key: Annotated[Optional[str], pydantic.Field(alias="tagKey")] = None
|
||||
|
||||
thumb: Optional[str] = None
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyRoleTypedDict(TypedDict):
|
||||
id: NotRequired[int]
|
||||
filter_: NotRequired[str]
|
||||
tag: NotRequired[str]
|
||||
tag_key: NotRequired[str]
|
||||
role: NotRequired[str]
|
||||
thumb: NotRequired[str]
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyRole(BaseModel):
|
||||
id: Optional[int] = None
|
||||
|
||||
filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = None
|
||||
|
||||
tag: Optional[str] = None
|
||||
|
||||
tag_key: Annotated[Optional[str], pydantic.Field(alias="tagKey")] = None
|
||||
|
||||
role: Optional[str] = None
|
||||
|
||||
thumb: Optional[str] = None
|
||||
|
||||
|
||||
class ProducerTypedDict(TypedDict):
|
||||
id: NotRequired[int]
|
||||
filter_: NotRequired[str]
|
||||
tag: NotRequired[str]
|
||||
tag_key: NotRequired[str]
|
||||
thumb: NotRequired[str]
|
||||
|
||||
|
||||
class Producer(BaseModel):
|
||||
id: Optional[int] = None
|
||||
|
||||
filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = None
|
||||
|
||||
tag: Optional[str] = None
|
||||
|
||||
tag_key: Annotated[Optional[str], pydantic.Field(alias="tagKey")] = None
|
||||
|
||||
thumb: Optional[str] = None
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyMetadataTypedDict(TypedDict):
|
||||
rating_key: NotRequired[str]
|
||||
key: NotRequired[str]
|
||||
guid: NotRequired[str]
|
||||
studio: NotRequired[str]
|
||||
type: NotRequired[str]
|
||||
title: NotRequired[str]
|
||||
library_section_title: NotRequired[str]
|
||||
library_section_id: NotRequired[int]
|
||||
library_section_key: NotRequired[str]
|
||||
grandparent_title: NotRequired[str]
|
||||
r"""The name of the album artist for the track when audio, and the name of the TV show for the episode when video."""
|
||||
parent_title: NotRequired[str]
|
||||
r"""The name of the album for the track when audio, and the name of the season for the episode when TV show."""
|
||||
original_title: NotRequired[str]
|
||||
r"""The orginal untranslated name of the media item when non-english."""
|
||||
index: NotRequired[int]
|
||||
r"""The index starting from 0 of this media item in the MetaData array."""
|
||||
parent_index: NotRequired[int]
|
||||
r"""The parent index starting from 0 of this media item in the parent MetaData array."""
|
||||
content_rating: NotRequired[str]
|
||||
summary: NotRequired[str]
|
||||
rating: NotRequired[float]
|
||||
audience_rating: NotRequired[float]
|
||||
year: NotRequired[int]
|
||||
tagline: NotRequired[str]
|
||||
thumb: NotRequired[str]
|
||||
art: NotRequired[str]
|
||||
duration: NotRequired[int]
|
||||
originally_available_at: NotRequired[date]
|
||||
added_at: NotRequired[int]
|
||||
updated_at: NotRequired[int]
|
||||
audience_rating_image: NotRequired[str]
|
||||
has_premium_primary_extra: NotRequired[str]
|
||||
rating_image: NotRequired[str]
|
||||
media: NotRequired[List[GetMetaDataByRatingKeyMediaTypedDict]]
|
||||
genre: NotRequired[List[GetMetaDataByRatingKeyGenreTypedDict]]
|
||||
country: NotRequired[List[GetMetaDataByRatingKeyCountryTypedDict]]
|
||||
guids: NotRequired[List[GuidsTypedDict]]
|
||||
ratings: NotRequired[List[RatingsTypedDict]]
|
||||
director: NotRequired[List[GetMetaDataByRatingKeyDirectorTypedDict]]
|
||||
writer: NotRequired[List[GetMetaDataByRatingKeyWriterTypedDict]]
|
||||
role: NotRequired[List[GetMetaDataByRatingKeyRoleTypedDict]]
|
||||
producer: NotRequired[List[ProducerTypedDict]]
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyMetadata(BaseModel):
|
||||
rating_key: Annotated[Optional[str], pydantic.Field(alias="ratingKey")] = None
|
||||
|
||||
key: Optional[str] = None
|
||||
|
||||
guid: Optional[str] = None
|
||||
|
||||
studio: Optional[str] = None
|
||||
|
||||
type: Optional[str] = None
|
||||
|
||||
title: Optional[str] = None
|
||||
|
||||
library_section_title: Annotated[
|
||||
Optional[str], pydantic.Field(alias="librarySectionTitle")
|
||||
] = None
|
||||
|
||||
library_section_id: Annotated[
|
||||
Optional[int], pydantic.Field(alias="librarySectionID")
|
||||
] = None
|
||||
|
||||
library_section_key: Annotated[
|
||||
Optional[str], pydantic.Field(alias="librarySectionKey")
|
||||
] = None
|
||||
|
||||
grandparent_title: Annotated[
|
||||
Optional[str], pydantic.Field(alias="grandparentTitle")
|
||||
] = None
|
||||
r"""The name of the album artist for the track when audio, and the name of the TV show for the episode when video."""
|
||||
|
||||
parent_title: Annotated[Optional[str], pydantic.Field(alias="parentTitle")] = None
|
||||
r"""The name of the album for the track when audio, and the name of the season for the episode when TV show."""
|
||||
|
||||
original_title: Annotated[Optional[str], pydantic.Field(alias="originalTitle")] = (
|
||||
None
|
||||
)
|
||||
r"""The orginal untranslated name of the media item when non-english."""
|
||||
|
||||
index: Optional[int] = None
|
||||
r"""The index starting from 0 of this media item in the MetaData array."""
|
||||
|
||||
parent_index: Annotated[Optional[int], pydantic.Field(alias="parentIndex")] = None
|
||||
r"""The parent index starting from 0 of this media item in the parent MetaData array."""
|
||||
|
||||
content_rating: Annotated[Optional[str], pydantic.Field(alias="contentRating")] = (
|
||||
None
|
||||
)
|
||||
|
||||
summary: Optional[str] = None
|
||||
|
||||
rating: Optional[float] = None
|
||||
|
||||
audience_rating: Annotated[
|
||||
Optional[float], pydantic.Field(alias="audienceRating")
|
||||
] = None
|
||||
|
||||
year: Optional[int] = None
|
||||
|
||||
tagline: Optional[str] = None
|
||||
|
||||
thumb: Optional[str] = None
|
||||
|
||||
art: Optional[str] = None
|
||||
|
||||
duration: Optional[int] = None
|
||||
|
||||
originally_available_at: Annotated[
|
||||
Optional[date], pydantic.Field(alias="originallyAvailableAt")
|
||||
] = None
|
||||
|
||||
added_at: Annotated[Optional[int], pydantic.Field(alias="addedAt")] = None
|
||||
|
||||
updated_at: Annotated[Optional[int], pydantic.Field(alias="updatedAt")] = None
|
||||
|
||||
audience_rating_image: Annotated[
|
||||
Optional[str], pydantic.Field(alias="audienceRatingImage")
|
||||
] = None
|
||||
|
||||
has_premium_primary_extra: Annotated[
|
||||
Optional[str], pydantic.Field(alias="hasPremiumPrimaryExtra")
|
||||
] = None
|
||||
|
||||
rating_image: Annotated[Optional[str], pydantic.Field(alias="ratingImage")] = None
|
||||
|
||||
media: Annotated[
|
||||
Optional[List[GetMetaDataByRatingKeyMedia]], pydantic.Field(alias="Media")
|
||||
] = None
|
||||
|
||||
genre: Annotated[
|
||||
Optional[List[GetMetaDataByRatingKeyGenre]], pydantic.Field(alias="Genre")
|
||||
] = None
|
||||
|
||||
country: Annotated[
|
||||
Optional[List[GetMetaDataByRatingKeyCountry]], pydantic.Field(alias="Country")
|
||||
] = None
|
||||
|
||||
guids: Annotated[Optional[List[Guids]], pydantic.Field(alias="Guid")] = None
|
||||
|
||||
ratings: Annotated[Optional[List[Ratings]], pydantic.Field(alias="Rating")] = None
|
||||
|
||||
director: Annotated[
|
||||
Optional[List[GetMetaDataByRatingKeyDirector]], pydantic.Field(alias="Director")
|
||||
] = None
|
||||
|
||||
writer: Annotated[
|
||||
Optional[List[GetMetaDataByRatingKeyWriter]], pydantic.Field(alias="Writer")
|
||||
] = None
|
||||
|
||||
role: Annotated[
|
||||
Optional[List[GetMetaDataByRatingKeyRole]], pydantic.Field(alias="Role")
|
||||
] = None
|
||||
|
||||
producer: Annotated[Optional[List[Producer]], pydantic.Field(alias="Producer")] = (
|
||||
None
|
||||
)
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyMediaContainerTypedDict(TypedDict):
|
||||
size: NotRequired[int]
|
||||
allow_sync: NotRequired[bool]
|
||||
identifier: NotRequired[str]
|
||||
library_section_id: NotRequired[int]
|
||||
library_section_title: NotRequired[str]
|
||||
library_section_uuid: NotRequired[str]
|
||||
media_tag_prefix: NotRequired[str]
|
||||
media_tag_version: NotRequired[int]
|
||||
metadata: NotRequired[List[GetMetaDataByRatingKeyMetadataTypedDict]]
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyMediaContainer(BaseModel):
|
||||
size: Optional[int] = None
|
||||
|
||||
allow_sync: Annotated[Optional[bool], pydantic.Field(alias="allowSync")] = None
|
||||
|
||||
identifier: Optional[str] = None
|
||||
|
||||
library_section_id: Annotated[
|
||||
Optional[int], pydantic.Field(alias="librarySectionID")
|
||||
] = None
|
||||
|
||||
library_section_title: Annotated[
|
||||
Optional[str], pydantic.Field(alias="librarySectionTitle")
|
||||
] = None
|
||||
|
||||
library_section_uuid: Annotated[
|
||||
Optional[str], pydantic.Field(alias="librarySectionUUID")
|
||||
] = None
|
||||
|
||||
media_tag_prefix: Annotated[
|
||||
Optional[str], pydantic.Field(alias="mediaTagPrefix")
|
||||
] = None
|
||||
|
||||
media_tag_version: Annotated[
|
||||
Optional[int], pydantic.Field(alias="mediaTagVersion")
|
||||
] = None
|
||||
|
||||
metadata: Annotated[
|
||||
Optional[List[GetMetaDataByRatingKeyMetadata]], pydantic.Field(alias="Metadata")
|
||||
] = None
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyResponseBodyTypedDict(TypedDict):
|
||||
r"""The metadata of the library item."""
|
||||
|
||||
media_container: NotRequired[GetMetaDataByRatingKeyMediaContainerTypedDict]
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyResponseBody(BaseModel):
|
||||
r"""The metadata of the library item."""
|
||||
|
||||
media_container: Annotated[
|
||||
Optional[GetMetaDataByRatingKeyMediaContainer],
|
||||
pydantic.Field(alias="MediaContainer"),
|
||||
] = None
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyResponseTypedDict(TypedDict):
|
||||
content_type: str
|
||||
r"""HTTP response content type for this operation"""
|
||||
status_code: int
|
||||
r"""HTTP response status code for this operation"""
|
||||
raw_response: httpx.Response
|
||||
r"""Raw HTTP response; suitable for custom response parsing"""
|
||||
object: NotRequired[GetMetaDataByRatingKeyResponseBodyTypedDict]
|
||||
r"""The metadata of the library item."""
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyResponse(BaseModel):
|
||||
content_type: str
|
||||
r"""HTTP response content type for this operation"""
|
||||
|
||||
status_code: int
|
||||
r"""HTTP response status code for this operation"""
|
||||
|
||||
raw_response: httpx.Response
|
||||
r"""Raw HTTP response; suitable for custom response parsing"""
|
||||
|
||||
object: Optional[GetMetaDataByRatingKeyResponseBody] = None
|
||||
r"""The metadata of the library item."""
|
||||
@@ -12,7 +12,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
|
||||
|
||||
|
||||
class Type(int, Enum):
|
||||
r"""The type of media to retrieve.
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
@@ -41,7 +41,7 @@ class GetRecentlyAddedRequestTypedDict(TypedDict):
|
||||
content_directory_id: int
|
||||
r"""The content directory ID."""
|
||||
type: Type
|
||||
r"""The type of media to retrieve.
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
@@ -82,7 +82,7 @@ class GetRecentlyAddedRequest(BaseModel):
|
||||
type: Annotated[
|
||||
Type, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
|
||||
]
|
||||
r"""The type of media to retrieve.
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -12,7 +12,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
|
||||
|
||||
|
||||
class QueryParamType(int, Enum):
|
||||
r"""The type of media to retrieve.
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
@@ -39,7 +39,7 @@ class QueryParamIncludeMeta(int, Enum):
|
||||
|
||||
class GetRecentlyAddedLibraryRequestTypedDict(TypedDict):
|
||||
type: QueryParamType
|
||||
r"""The type of media to retrieve.
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
@@ -74,7 +74,7 @@ class GetRecentlyAddedLibraryRequest(BaseModel):
|
||||
QueryParamType,
|
||||
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
||||
]
|
||||
r"""The type of media to retrieve.
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -11,7 +11,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
|
||||
|
||||
|
||||
class GetSearchLibraryQueryParamType(int, Enum):
|
||||
r"""The type of media to retrieve.
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
@@ -36,7 +36,7 @@ class GetSearchLibraryRequestTypedDict(TypedDict):
|
||||
|
||||
"""
|
||||
type: GetSearchLibraryQueryParamType
|
||||
r"""The type of media to retrieve.
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
@@ -61,7 +61,7 @@ class GetSearchLibraryRequest(BaseModel):
|
||||
GetSearchLibraryQueryParamType,
|
||||
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
||||
]
|
||||
r"""The type of media to retrieve.
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -12,7 +12,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
|
||||
|
||||
|
||||
class GetPlaylistContentsQueryParamType(int, Enum):
|
||||
r"""The type of media to retrieve.
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
@@ -34,7 +34,7 @@ class GetPlaylistContentsRequestTypedDict(TypedDict):
|
||||
playlist_id: float
|
||||
r"""the ID of the playlist"""
|
||||
type: GetPlaylistContentsQueryParamType
|
||||
r"""The type of media to retrieve.
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
@@ -56,7 +56,7 @@ class GetPlaylistContentsRequest(BaseModel):
|
||||
GetPlaylistContentsQueryParamType,
|
||||
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
||||
]
|
||||
r"""The type of media to retrieve.
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -12,7 +12,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
|
||||
|
||||
|
||||
class GetTopWatchedContentQueryParamType(int, Enum):
|
||||
r"""The type of media to retrieve.
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
@@ -32,7 +32,7 @@ class GetTopWatchedContentQueryParamType(int, Enum):
|
||||
|
||||
class GetTopWatchedContentRequestTypedDict(TypedDict):
|
||||
type: GetTopWatchedContentQueryParamType
|
||||
r"""The type of media to retrieve.
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
@@ -51,7 +51,7 @@ class GetTopWatchedContentRequest(BaseModel):
|
||||
GetTopWatchedContentQueryParamType,
|
||||
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
||||
]
|
||||
r"""The type of media to retrieve.
|
||||
r"""The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -1139,7 +1139,7 @@ class Playlists(BaseSDK):
|
||||
|
||||
|
||||
:param playlist_id: the ID of the playlist
|
||||
:param type: The type of media to retrieve. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
:param type: The type of media to retrieve or filter by. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
:param retries: Override the default retry configuration for this method
|
||||
:param server_url: Override the default server URL for this method
|
||||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||||
@@ -1254,7 +1254,7 @@ class Playlists(BaseSDK):
|
||||
|
||||
|
||||
:param playlist_id: the ID of the playlist
|
||||
:param type: The type of media to retrieve. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
:param type: The type of media to retrieve or filter by. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
:param retries: Override the default retry configuration for this method
|
||||
:param server_url: Override the default server URL for this method
|
||||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||||
|
||||
Reference in New Issue
Block a user