ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.406.0

This commit is contained in:
speakeasybot
2024-10-03 00:02:51 +00:00
parent 29e1e35349
commit 77c35ea4cc
266 changed files with 4537 additions and 2537 deletions

File diff suppressed because one or more lines are too long

View File

@@ -12,7 +12,7 @@ generation:
auth: auth:
oAuth2ClientCredentialsEnabled: true oAuth2ClientCredentialsEnabled: true
python: python:
version: 0.17.1 version: 0.18.0
additionalDependencies: additionalDependencies:
dev: {} dev: {}
main: {} main: {}
@@ -26,6 +26,7 @@ python:
responseRequiredSep2024: false responseRequiredSep2024: false
flattenGlobalSecurity: true flattenGlobalSecurity: true
flattenRequests: false flattenRequests: false
flatteningOrder: parameters-first
imports: imports:
option: openapi option: openapi
paths: paths:

View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.405.6 speakeasyVersion: 1.406.0
sources: sources:
my-source: my-source:
sourceNamespace: my-source sourceNamespace: my-source
@@ -8,8 +8,8 @@ sources:
- latest - latest
plexapi: plexapi:
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:c52cde0b8d51e160f7b9f1a3d3ea4dbb1aca6d5caad714e549201fb757fadd57 sourceRevisionDigest: sha256:c6ab8f13847c7cdc4ab3752f517164d7da08266726255aa0d614b1eaea66fb0e
sourceBlobDigest: sha256:f417b03ff71356808554313f24c3d06d670474bf51bc9a0631de1ad49c13a361 sourceBlobDigest: sha256:64c7694915a0828aeb256d10d2fa0ea477681785b818916b6681be8cc5ffb93b
tags: tags:
- latest - latest
- main - main
@@ -17,10 +17,10 @@ targets:
plexpy: plexpy:
source: plexapi source: plexapi
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:c52cde0b8d51e160f7b9f1a3d3ea4dbb1aca6d5caad714e549201fb757fadd57 sourceRevisionDigest: sha256:c6ab8f13847c7cdc4ab3752f517164d7da08266726255aa0d614b1eaea66fb0e
sourceBlobDigest: sha256:f417b03ff71356808554313f24c3d06d670474bf51bc9a0631de1ad49c13a361 sourceBlobDigest: sha256:64c7694915a0828aeb256d10d2fa0ea477681785b818916b6681be8cc5ffb93b
codeSamplesNamespace: code-samples-python-plexpy codeSamplesNamespace: code-samples-python-plexpy
codeSamplesRevisionDigest: sha256:4bd63bb65e2a00ee23f7799c4c14d38629318b0d107761d9d29c888d9f88b9c0 codeSamplesRevisionDigest: sha256:54884c9042f29a53422bd5060a7927c6d89db6df31124460f1b798ff8afe224f
workflow: workflow:
workflowVersion: 1.0.0 workflowVersion: 1.0.0
speakeasyVersion: latest speakeasyVersion: latest

137
README.md
View File

@@ -45,7 +45,6 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
* [IDE Support](#ide-support) * [IDE Support](#ide-support)
* [SDK Example Usage](#sdk-example-usage) * [SDK Example Usage](#sdk-example-usage)
* [Available Resources and Operations](#available-resources-and-operations) * [Available Resources and Operations](#available-resources-and-operations)
* [Global Parameters](#global-parameters)
* [Retries](#retries) * [Retries](#retries)
* [Error Handling](#error-handling) * [Error Handling](#error-handling)
* [Server Selection](#server-selection) * [Server Selection](#server-selection)
@@ -97,11 +96,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.server.get_server_capabilities() res = s.server.get_server_capabilities()
@@ -122,11 +121,11 @@ from plex_api_client import PlexAPI
async def main(): async def main():
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = await s.server.get_server_capabilities_async() res = await s.server.get_server_capabilities_async()
if res.object is not None: if res.object is not None:
@@ -179,6 +178,7 @@ asyncio.run(main())
* [get_library_items](docs/sdks/library/README.md#get_library_items) - Get Library Items * [get_library_items](docs/sdks/library/README.md#get_library_items) - Get Library Items
* [get_refresh_library_metadata](docs/sdks/library/README.md#get_refresh_library_metadata) - Refresh Metadata Of The Library * [get_refresh_library_metadata](docs/sdks/library/README.md#get_refresh_library_metadata) - Refresh Metadata Of The Library
* [get_search_library](docs/sdks/library/README.md#get_search_library) - Search Library * [get_search_library](docs/sdks/library/README.md#get_search_library) - Search Library
* [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_meta_data_by_rating_key](docs/sdks/library/README.md#get_meta_data_by_rating_key) - Get Metadata by RatingKey
* [get_metadata_children](docs/sdks/library/README.md#get_metadata_children) - Get Items Children * [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_top_watched_content](docs/sdks/library/README.md#get_top_watched_content) - Get Top Watched Content
@@ -282,11 +282,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.server.get_server_capabilities(, res = s.server.get_server_capabilities(,
@@ -306,11 +306,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False), retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.server.get_server_capabilities() res = s.server.get_server_capabilities()
@@ -352,11 +352,11 @@ from plex_api_client.models import errors
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = None res = None
@@ -398,11 +398,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
server_idx=0, server_idx=0,
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.server.get_server_capabilities() res = s.server.get_server_capabilities()
@@ -429,11 +429,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
server_url="{protocol}://{ip}:{port}", server_url="{protocol}://{ip}:{port}",
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.server.get_server_capabilities() res = s.server.get_server_capabilities()
@@ -452,11 +452,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.plex.get_companions_data(server_url="https://plex.tv/api/v2") res = s.plex.get_companions_data(server_url="https://plex.tv/api/v2")
@@ -566,11 +566,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.server.get_server_capabilities() res = s.server.get_server_capabilities()
@@ -582,51 +582,6 @@ if res.object is not None:
``` ```
<!-- End Authentication [security] --> <!-- End Authentication [security] -->
<!-- Start Global Parameters [global-parameters] -->
## Global Parameters
Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set `ClientID` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `get_server_resources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
### Available Globals
The following global parameters are available.
| Name | Type | Required | Description |
| ---- | ---- |:--------:| ----------- |
| client_id | str | | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) |
| client_name | str | | The client_name parameter. |
| client_version | str | | The client_version parameter. |
| client_platform | str | | The client_platform parameter. |
| device_name | str | | The device_name parameter. |
### Example
```python
from plex_api_client import PlexAPI
from plex_api_client.models import operations
s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
)
res = s.plex.get_server_resources(include_https=operations.IncludeHTTPS.ENABLE, include_relay=operations.IncludeRelay.ENABLE, include_i_pv6=operations.IncludeIPv6.ENABLE, client_id="gcgzw5rz2xovp84b4vha3a40")
if res.plex_devices is not None:
# handle response
pass
```
<!-- End Global Parameters [global-parameters] -->
<!-- Start Debugging [debug] --> <!-- Start Debugging [debug] -->
## Debugging ## Debugging

View File

@@ -828,4 +828,14 @@ Based on:
### Generated ### Generated
- [python v0.17.1] . - [python v0.17.1] .
### Releases ### Releases
- [PyPI v0.17.1] https://pypi.org/project/plex-api-client/0.17.1 - . - [PyPI v0.17.1] https://pypi.org/project/plex-api-client/0.17.1 - .
## 2024-10-03 00:01:26
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v0.18.0] .
### Releases
- [PyPI v0.18.0] https://pypi.org/project/plex-api-client/0.18.0 - .

View File

@@ -5,11 +5,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.server.get_server_capabilities() res = s.server.get_server_capabilities()
@@ -30,11 +30,11 @@ from plex_api_client import PlexAPI
async def main(): async def main():
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = await s.server.get_server_capabilities_async() res = await s.server.get_server_capabilities_async()
if res.object is not None: if res.object is not None:

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `errors` | List[[errors.GetSearchAllLibrariesErrors](../../models/errors/getsearchalllibrarieserrors.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 |

View File

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

View File

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

View File

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `errors` | List[[errors.GetSearchAllLibrariesLibraryErrors](../../models/errors/getsearchalllibrarieslibraryerrors.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 |

View File

@@ -3,10 +3,10 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | | `client_name` | *Optional[str]* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | | `client_version` | *Optional[str]* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | | `platform` | *Optional[str]* | :heavy_minus_sign: | The platform of the client application. | Roku |
| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | | `device_nickname` | *Optional[str]* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |

View File

@@ -1,102 +0,0 @@
# Features
## Values
| Name | Value |
| ----------------------------------------- | ----------------------------------------- |
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
| `ANDROID_PI_P` | Android - PiP |
| `CU_SUNSET` | CU Sunset |
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
| `ALBUM_TYPES` | album-types |
| `ALLOW_DVR` | allow_dvr |
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
| `AVOD_NEW_MEDIA` | avod-new-media |
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
| `BOOST_VOICES` | boost-voices |
| `CAMERA_UPLOAD` | camera_upload |
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
| `CLOUDSYNC` | cloudsync |
| `COLLECTIONS` | collections |
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
| `COMPANIONS_SONOS` | companions_sonos |
| `CONTENT_FILTER` | content_filter |
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
| `DOWNLOADS_GATING` | downloads-gating |
| `DRM_SUPPORT` | drm_support |
| `DVR` | dvr |
| `DVR_BLOCK_UNSUPPORTED_COUNTRIES` | dvr-block-unsupported-countries |
| `EPG_RECENT_CHANNELS` | epg-recent-channels |
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
| `FEDERATED_AUTH` | federated-auth |
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
| `GRANDFATHER_SYNC` | grandfather-sync |
| `GUIDED_UPGRADE` | guided-upgrade |
| `HARDWARE_TRANSCODING` | hardware_transcoding |
| `HOME` | home |
| `HWTRANSCODE` | hwtranscode |
| `IMAGGA_V2` | imagga-v2 |
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
| `ITEM_CLUSTERS` | item_clusters |
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
| `KEVIN_BACON` | kevin-bacon |
| `KOREA_CONSENT` | korea-consent |
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
| `LETS_ENCRYPT` | lets_encrypt |
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
| `LIVETV` | livetv |
| `LYRICS` | lyrics |
| `METADATA_SEARCH` | metadata_search |
| `MUSIC_ANALYSIS` | music-analysis |
| `MUSIC_VIDEOS` | music_videos |
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
| `NOMINATIM` | nominatim |
| `PASS` | pass |
| `PHOTOS_FAVORITES` | photos-favorites |
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
| `PHOTOS_V6_EDIT` | photosV6-edit |
| `PHOTOS_V6_TV_ALBUMS` | photosV6-tv-albums |
| `PMS_HEALTH` | pms_health |
| `PREMIUM_DASHBOARD` | premium-dashboard |
| `PREMIUM_MUSIC_METADATA` | premium_music_metadata |
| `RADIO` | radio |
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
| `SESSION_BANDWIDTH_RESTRICTIONS` | session_bandwidth_restrictions |
| `SESSION_KICK` | session_kick |
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
| `SIGNIN_NOTIFICATION` | signin_notification |
| `SIGNIN_WITH_APPLE` | signin_with_apple |
| `SILENCE_REMOVAL` | silence-removal |
| `SLEEP_TIMER` | sleep-timer |
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
| `SYNC` | sync |
| `SWEET_FADES` | sweet-fades |
| `TRANSCODER_CACHE` | transcoder_cache |
| `TRAILERS` | trailers |
| `TUNER_SHARING` | tuner-sharing |
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
| `UPGRADE_3DS2` | upgrade-3ds2 |
| `VISUALIZERS` | visualizers |
| `VOD_SCHEMA` | vod-schema |
| `VOD_CLOUDFLARE` | vod_cloudflare |
| `VOLUME_LEVELING` | volume-leveling |
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
| `WATCHLIST_RSS` | watchlist-rss |
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |
| `WEBHOOKS` | webhooks |

View File

@@ -3,26 +3,26 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `allow_sync` | *bool* | :heavy_check_mark: | N/A | true | | `allow_sync` | *bool* | :heavy_check_mark: | N/A | true |
| `art` | *str* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg | | `art` | *str* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
| `composite` | *str* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 | | `composite` | *str* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
| `filters` | *bool* | :heavy_check_mark: | N/A | true | | `filters` | *bool* | :heavy_check_mark: | N/A | true |
| `refreshing` | *bool* | :heavy_check_mark: | N/A | false | | `refreshing` | *bool* | :heavy_check_mark: | N/A | false |
| `thumb` | *str* | :heavy_check_mark: | N/A | /:/resources/movie.png | | `thumb` | *str* | :heavy_check_mark: | N/A | /:/resources/movie.png |
| `key` | *str* | :heavy_check_mark: | N/A | 1 | | `key` | *str* | :heavy_check_mark: | N/A | 1 |
| `type` | *str* | :heavy_check_mark: | N/A | movie | | `type` | *str* | :heavy_check_mark: | N/A | movie |
| `title` | *str* | :heavy_check_mark: | N/A | Movies | | `title` | *str* | :heavy_check_mark: | N/A | Movies |
| `agent` | *str* | :heavy_check_mark: | N/A | tv.plex.agents.movie | | `agent` | *str* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
| `scanner` | *str* | :heavy_check_mark: | N/A | Plex Movie | | `scanner` | *str* | :heavy_check_mark: | N/A | Plex Movie |
| `language` | *str* | :heavy_check_mark: | N/A | en-US | | `language` | *str* | :heavy_check_mark: | N/A | en-US |
| `uuid` | *str* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 | | `uuid` | *str* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `updated_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 | | `updated_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `created_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 | | `created_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `scanned_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 | | `scanned_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `content` | *bool* | :heavy_check_mark: | N/A | true | | `content` | *bool* | :heavy_check_mark: | N/A | true |
| `directory` | *bool* | :heavy_check_mark: | N/A | true | | `directory` | *bool* | :heavy_check_mark: | N/A | true |
| `content_changed_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 | | `content_changed_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `hidden` | *int* | :heavy_check_mark: | N/A | 0 | | `hidden` | *int* | :heavy_check_mark: | N/A | 0 |
| `location` | List[[operations.Location](../../models/operations/location.md)] | :heavy_check_mark: | N/A | | | `location` | List[[operations.GetAllLibrariesLocation](../../models/operations/getalllibrarieslocation.md)] | :heavy_check_mark: | N/A | |

View File

@@ -0,0 +1,9 @@
# GetAllLibrariesLocation
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *int* | :heavy_check_mark: | N/A | 1 |
| `path` | *str* | :heavy_check_mark: | N/A | /movies |

View File

@@ -10,4 +10,4 @@
| `height` | *int* | :heavy_check_mark: | N/A | 396 | | `height` | *int* | :heavy_check_mark: | N/A | 396 |
| `min_size` | *int* | :heavy_check_mark: | N/A | 1 | | `min_size` | *int* | :heavy_check_mark: | N/A | 1 |
| `upscale` | *int* | :heavy_check_mark: | N/A | 1 | | `upscale` | *int* | :heavy_check_mark: | N/A | 1 |
| `x_plex_token` | *str* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf | | `x_plex_token` | *str* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

View File

@@ -0,0 +1,8 @@
# GetLibraryItemsLocation
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `path` | *Optional[str]* | :heavy_minus_sign: | N/A | /TV Shows/House |

View File

@@ -6,20 +6,20 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119534 | | `id` | *int* | :heavy_check_mark: | N/A | 119534 |
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
| `bitrate` | *int* | :heavy_check_mark: | N/A | 25025 |
| `width` | *int* | :heavy_check_mark: | N/A | 3840 |
| `height` | *int* | :heavy_check_mark: | N/A | 2072 |
| `aspect_ratio` | *float* | :heavy_check_mark: | N/A | 1.85 |
| `audio_channels` | *int* | :heavy_check_mark: | N/A | 6 |
| `audio_codec` | *str* | :heavy_check_mark: | N/A | eac3 |
| `video_codec` | *str* | :heavy_check_mark: | N/A | hevc |
| `video_resolution` | *str* | :heavy_check_mark: | N/A | 4k |
| `container` | *str* | :heavy_check_mark: | N/A | mkv | | `container` | *str* | :heavy_check_mark: | N/A | mkv |
| `video_frame_rate` | *str* | :heavy_check_mark: | N/A | 24p |
| `video_profile` | *str* | :heavy_check_mark: | N/A | main 10 |
| `part` | List[[operations.GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md)] | :heavy_check_mark: | N/A | | | `part` | List[[operations.GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md)] | :heavy_check_mark: | N/A | |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | N/A | 25025 |
| `width` | *Optional[int]* | :heavy_minus_sign: | N/A | 3840 |
| `height` | *Optional[int]* | :heavy_minus_sign: | N/A | 2072 |
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | N/A | 1.85 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts | | `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts |
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | N/A | 6 |
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | eac3 |
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | hevc |
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | N/A | 4k |
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | N/A | 24p |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main 10 |
| `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | [Optional[operations.GetLibraryItemsOptimizedForStreaming]](../../models/operations/getlibraryitemsoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 | | `optimized_for_streaming` | [Optional[operations.GetLibraryItemsOptimizedForStreaming]](../../models/operations/getlibraryitemsoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |

View File

@@ -52,6 +52,7 @@
| `writer` | List[[operations.GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md)] | :heavy_minus_sign: | N/A | | | `writer` | List[[operations.GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md)] | :heavy_minus_sign: | N/A | |
| `collection` | List[[operations.GetLibraryItemsCollection](../../models/operations/getlibraryitemscollection.md)] | :heavy_minus_sign: | N/A | | | `collection` | List[[operations.GetLibraryItemsCollection](../../models/operations/getlibraryitemscollection.md)] | :heavy_minus_sign: | N/A | |
| `role` | List[[operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)] | :heavy_minus_sign: | N/A | | | `role` | List[[operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)] | :heavy_minus_sign: | N/A | |
| `location` | List[[operations.GetLibraryItemsLocation](../../models/operations/getlibraryitemslocation.md)] | :heavy_minus_sign: | N/A | |
| `media_guid` | List[[operations.GetLibraryItemsMediaGUID](../../models/operations/getlibraryitemsmediaguid.md)] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | | | `media_guid` | List[[operations.GetLibraryItemsMediaGUID](../../models/operations/getlibraryitemsmediaguid.md)] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `ultra_blur_colors` | [Optional[operations.GetLibraryItemsUltraBlurColors]](../../models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | | | `ultra_blur_colors` | [Optional[operations.GetLibraryItemsUltraBlurColors]](../../models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `meta_data_rating` | List[[operations.GetLibraryItemsMetaDataRating](../../models/operations/getlibraryitemsmetadatarating.md)] | :heavy_minus_sign: | N/A | | | `meta_data_rating` | List[[operations.GetLibraryItemsMetaDataRating](../../models/operations/getlibraryitemsmetadatarating.md)] | :heavy_minus_sign: | N/A | |

View File

@@ -7,14 +7,14 @@
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119542 | | `id` | *int* | :heavy_check_mark: | N/A | 119542 |
| `key` | *str* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv | | `key` | *str* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
| `file` | *str* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv | | `file` | *str* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
| `size` | *int* | :heavy_check_mark: | N/A | 36158371307 | | `size` | *int* | :heavy_check_mark: | N/A | 36158371307 |
| `container` | *str* | :heavy_check_mark: | The container format of the media file.<br/> | mkv | | `container` | *str* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
| `video_profile` | *str* | :heavy_check_mark: | N/A | main 10 | | `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts | | `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `optimized_for_streaming` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main 10 |
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd | | `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
| `has_thumbnail` | [Optional[operations.GetLibraryItemsHasThumbnail]](../../models/operations/getlibraryitemshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 | | `has_thumbnail` | [Optional[operations.GetLibraryItemsHasThumbnail]](../../models/operations/getlibraryitemshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | List[[operations.GetLibraryItemsStream](../../models/operations/getlibraryitemsstream.md)] | :heavy_minus_sign: | N/A | | | `stream` | List[[operations.GetLibraryItemsStream](../../models/operations/getlibraryitemsstream.md)] | :heavy_minus_sign: | N/A | |

View File

@@ -5,8 +5,8 @@
| Field | Type | Required | Description | Example | | 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 |
| `tag` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | | | `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 | | `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 | | `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 | | `include_meta` | [Optional[operations.GetLibraryItemsQueryParamIncludeMeta]](../../models/operations/getlibraryitemsqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |

View File

@@ -3,6 +3,6 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `x_plex_token` | *str* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf | | `x_plex_token` | *str* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

View File

@@ -15,7 +15,7 @@
| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Season 2 | | `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Season 2 |
| `parent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/30072 | | `parent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/30072 |
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Reacher | | `parent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Reacher |
| `summary` | *Optional[str]* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mindrevenge. | | `summary` | *Optional[str]* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge. |
| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | 2 | | `index` | *Optional[int]* | :heavy_minus_sign: | N/A | 2 |
| `parent_index` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | | `parent_index` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `view_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 11 | | `view_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 11 |

View File

@@ -3,10 +3,10 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | | `client_name` | *Optional[str]* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | | `device_nickname` | *Optional[str]* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | | `client_version` | *Optional[str]* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | | `platform` | *Optional[str]* | :heavy_minus_sign: | The platform of the client application. | Roku |

View File

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

View File

@@ -52,6 +52,7 @@
| `writer` | List[[operations.Writer](../../models/operations/writer.md)] | :heavy_minus_sign: | N/A | | | `writer` | List[[operations.Writer](../../models/operations/writer.md)] | :heavy_minus_sign: | N/A | |
| `collection` | List[[operations.Collection](../../models/operations/collection.md)] | :heavy_minus_sign: | N/A | | | `collection` | List[[operations.Collection](../../models/operations/collection.md)] | :heavy_minus_sign: | N/A | |
| `role` | List[[operations.Role](../../models/operations/role.md)] | :heavy_minus_sign: | N/A | | | `role` | List[[operations.Role](../../models/operations/role.md)] | :heavy_minus_sign: | N/A | |
| `location` | List[[operations.Location](../../models/operations/location.md)] | :heavy_minus_sign: | N/A | |
| `media_guid` | List[[operations.MediaGUID](../../models/operations/mediaguid.md)] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | | | `media_guid` | List[[operations.MediaGUID](../../models/operations/mediaguid.md)] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `ultra_blur_colors` | [Optional[operations.UltraBlurColors]](../../models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | | | `ultra_blur_colors` | [Optional[operations.UltraBlurColors]](../../models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `meta_data_rating` | List[[operations.MetaDataRating](../../models/operations/metadatarating.md)] | :heavy_minus_sign: | N/A | | | `meta_data_rating` | List[[operations.MetaDataRating](../../models/operations/metadatarating.md)] | :heavy_minus_sign: | N/A | |

View File

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

View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesCountry
## Fields
| Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | United States of America |

View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesDirector
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | James Cameron |

View File

@@ -0,0 +1,9 @@
# GetSearchAllLibrariesFlattenSeasons
## Values
| Name | Value |
| ------- | ------- |
| `FALSE` | 0 |
| `TRUE` | 1 |

View File

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

View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesGlobals
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `client_id` | *Optional[str]* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |

View File

@@ -0,0 +1,9 @@
# GetSearchAllLibrariesHasThumbnail
## Values
| Name | Value |
| ------- | ------- |
| `FALSE` | 0 |
| `TRUE` | 1 |

View File

@@ -0,0 +1,10 @@
# GetSearchAllLibrariesImage
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `alt` | *str* | :heavy_check_mark: | N/A | Episode 1 |
| `type` | [operations.GetSearchAllLibrariesLibraryType](../../models/operations/getsearchalllibrarieslibrarytype.md) | :heavy_check_mark: | N/A | background |
| `url` | *str* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |

View File

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

View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesLocation
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `path` | *Optional[str]* | :heavy_minus_sign: | N/A | /TV Shows/House |

View File

@@ -0,0 +1,25 @@
# GetSearchAllLibrariesMedia
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
| `container` | *str* | :heavy_check_mark: | N/A | mkv |
| `part` | List[[operations.GetSearchAllLibrariesPart](../../models/operations/getsearchalllibrariespart.md)] | :heavy_check_mark: | N/A | |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | N/A | 25025 |
| `width` | *Optional[int]* | :heavy_minus_sign: | N/A | 3840 |
| `height` | *Optional[int]* | :heavy_minus_sign: | N/A | 2072 |
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | N/A | 1.85 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts |
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | N/A | 6 |
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | eac3 |
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | hevc |
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | N/A | 4k |
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | N/A | 24p |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main 10 |
| `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | [Optional[operations.GetSearchAllLibrariesOptimizedForStreaming]](../../models/operations/getsearchalllibrariesoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |

View File

@@ -0,0 +1,9 @@
# GetSearchAllLibrariesMediaContainer
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `size` | *float* | :heavy_check_mark: | N/A |
| `search_result` | List[[operations.SearchResult](../../models/operations/searchresult.md)] | :heavy_check_mark: | N/A |

View File

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

View File

@@ -0,0 +1,81 @@
# GetSearchAllLibrariesMetadata
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rating_key` | *str* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
| `key` | *str* | :heavy_check_mark: | N/A | /library/metadata/58683 |
| `guid` | *str* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
| `type` | [operations.GetSearchAllLibrariesType](../../models/operations/getsearchalllibrariestype.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `title` | *str* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `summary` | *str* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
| `added_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `studio` | *Optional[str]* | :heavy_minus_sign: | N/A | 20th Century Studios |
| `skip_children` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Movies |
| `library_section_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `slug` | *Optional[str]* | :heavy_minus_sign: | N/A | 4-for-texas |
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | N/A | PG-13 |
| `rating` | *Optional[float]* | :heavy_minus_sign: | N/A | 7.6 |
| `audience_rating` | *Optional[float]* | :heavy_minus_sign: | N/A | 9.2 |
| `year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
| `season_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
| `tagline` | *Optional[str]* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `flatten_seasons` | [Optional[operations.GetSearchAllLibrariesFlattenSeasons]](../../models/operations/getsearchalllibrariesflattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
| `show_ordering` | [Optional[operations.GetSearchAllLibrariesShowOrdering]](../../models/operations/getsearchalllibrariesshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `banner` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `chapter_source` | *Optional[str]* | :heavy_minus_sign: | N/A | media |
| `primary_extra_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
| `rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
| `grandparent_rating_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 66 |
| `grandparent_guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66 |
| `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Caprica |
| `grandparent_thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `parent_slug` | *Optional[str]* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
| `grandparent_slug` | *Optional[str]* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
| `grandparent_art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
| `grandparent_theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
| `media` | List[[operations.GetSearchAllLibrariesMedia](../../models/operations/getsearchalllibrariesmedia.md)] | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
| `genre` | List[[operations.GetSearchAllLibrariesGenre](../../models/operations/getsearchalllibrariesgenre.md)] | :heavy_minus_sign: | N/A | |
| `country` | List[[operations.GetSearchAllLibrariesCountry](../../models/operations/getsearchalllibrariescountry.md)] | :heavy_minus_sign: | N/A | |
| `director` | List[[operations.GetSearchAllLibrariesDirector](../../models/operations/getsearchalllibrariesdirector.md)] | :heavy_minus_sign: | N/A | |
| `writer` | List[[operations.GetSearchAllLibrariesWriter](../../models/operations/getsearchalllibrarieswriter.md)] | :heavy_minus_sign: | N/A | |
| `collection` | List[[operations.GetSearchAllLibrariesCollection](../../models/operations/getsearchalllibrariescollection.md)] | :heavy_minus_sign: | N/A | |
| `role` | List[[operations.GetSearchAllLibrariesRole](../../models/operations/getsearchalllibrariesrole.md)] | :heavy_minus_sign: | N/A | |
| `location` | List[[operations.GetSearchAllLibrariesLocation](../../models/operations/getsearchalllibrarieslocation.md)] | :heavy_minus_sign: | N/A | |
| `media_guid` | List[[operations.GetSearchAllLibrariesMediaGUID](../../models/operations/getsearchalllibrariesmediaguid.md)] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `ultra_blur_colors` | [Optional[operations.GetSearchAllLibrariesUltraBlurColors]](../../models/operations/getsearchalllibrariesultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `meta_data_rating` | List[[operations.GetSearchAllLibrariesMetaDataRating](../../models/operations/getsearchalllibrariesmetadatarating.md)] | :heavy_minus_sign: | N/A | |
| `image` | List[[operations.GetSearchAllLibrariesImage](../../models/operations/getsearchalllibrariesimage.md)] | :heavy_minus_sign: | N/A | |
| `title_sort` | *Optional[str]* | :heavy_minus_sign: | N/A | Whale |
| `view_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1682752242 |
| `original_title` | *Optional[str]* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
| `view_offset` | *Optional[int]* | :heavy_minus_sign: | N/A | 5222500 |
| `skip_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 14 |
| `viewed_leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 0 |
| `child_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `has_premium_extras` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
| `has_premium_primary_extra` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
| `parent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
| `parent_guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
| `parent_studio` | *Optional[str]* | :heavy_minus_sign: | N/A | UCP |
| `parent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66 |
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Caprica |
| `parent_index` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `parent_year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2010 |
| `parent_thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `parent_theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |

View File

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

View File

@@ -0,0 +1,9 @@
# GetSearchAllLibrariesOptimizedForStreaming
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

View File

@@ -0,0 +1,20 @@
# GetSearchAllLibrariesPart
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119542 |
| `key` | *str* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
| `file` | *str* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
| `size` | *int* | :heavy_check_mark: | N/A | 36158371307 |
| `container` | *str* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main 10 |
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
| `has_thumbnail` | [Optional[operations.GetSearchAllLibrariesHasThumbnail]](../../models/operations/getsearchalllibrarieshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | List[[operations.GetSearchAllLibrariesStream](../../models/operations/getsearchalllibrariesstream.md)] | :heavy_minus_sign: | N/A | |

View File

@@ -0,0 +1,13 @@
# GetSearchAllLibrariesRequest
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `query` | *str* | :heavy_check_mark: | The search query term. | |
| `client_id` | *Optional[str]* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `limit` | *Optional[int]* | :heavy_minus_sign: | Limit the number of results returned. | |
| `search_types` | List[[operations.SearchTypes](../../models/operations/searchtypes.md)] | :heavy_minus_sign: | A comma-separated list of search types to include. Valid values are: movies, music, otherVideos, people, tv.<br/> | movies,music,otherVideos,people,tv |
| `include_collections` | [Optional[operations.QueryParamIncludeCollections]](../../models/operations/queryparamincludecollections.md) | :heavy_minus_sign: | Whether to include collections in the search results. | 1 |
| `include_external_media` | [Optional[operations.QueryParamIncludeExternalMedia]](../../models/operations/queryparamincludeexternalmedia.md) | :heavy_minus_sign: | Whether to include external media in the search results. | 1 |

View File

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesResponse
## 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.GetSearchAllLibrariesResponseBody]](../../models/operations/getsearchalllibrariesresponsebody.md) | :heavy_minus_sign: | The libraries available on the Server |

View File

@@ -0,0 +1,10 @@
# GetSearchAllLibrariesResponseBody
The libraries available on the Server
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `media_container` | [operations.GetSearchAllLibrariesMediaContainer](../../models/operations/getsearchalllibrariesmediacontainer.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,13 @@
# GetSearchAllLibrariesRole
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *Optional[int]* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 |
| `filter_` | *Optional[str]* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
| `tag` | *Optional[str]* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
| `tag_key` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
| `role` | *Optional[str]* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |

View File

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

View File

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

View File

@@ -0,0 +1,14 @@
# GetSearchAllLibrariesType
The type of media content
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | movie |
| `TV_SHOW` | show |
| `SEASON` | season |
| `EPISODE` | episode |

View File

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesUltraBlurColors
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `top_left` | *str* | :heavy_check_mark: | N/A | 11333b |
| `top_right` | *str* | :heavy_check_mark: | N/A | 0a232d |
| `bottom_right` | *str* | :heavy_check_mark: | N/A | 73958 |
| `bottom_left` | *str* | :heavy_check_mark: | N/A | 1f5066 |

View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesWriter
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | James Cameron |

View File

@@ -3,6 +3,6 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |

View File

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

View File

@@ -10,4 +10,4 @@
| `height` | *int* | :heavy_check_mark: | N/A | 396 | | `height` | *int* | :heavy_check_mark: | N/A | 396 |
| `min_size` | *int* | :heavy_check_mark: | N/A | 1 | | `min_size` | *int* | :heavy_check_mark: | N/A | 1 |
| `upscale` | *int* | :heavy_check_mark: | N/A | 1 | | `upscale` | *int* | :heavy_check_mark: | N/A | 1 |
| `x_plex_token` | *str* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf | | `x_plex_token` | *str* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

View File

@@ -3,10 +3,10 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | | `client_name` | *Optional[str]* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | | `device_nickname` | *Optional[str]* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | | `client_version` | *Optional[str]* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | | `platform` | *Optional[str]* | :heavy_minus_sign: | The platform of the client application. | Roku |

View File

@@ -3,11 +3,11 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `pin_id` | *int* | :heavy_check_mark: | The PinID to retrieve an access token for | | | `pin_id` | *int* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | | `client_name` | *Optional[str]* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | | `device_nickname` | *Optional[str]* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | | `client_version` | *Optional[str]* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | | `platform` | *Optional[str]* | :heavy_minus_sign: | The platform of the client application. | Roku |

View File

@@ -1,102 +0,0 @@
# GetTokenDetailsFeatures
## Values
| Name | Value |
| ----------------------------------------- | ----------------------------------------- |
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
| `ANDROID_PI_P` | Android - PiP |
| `CU_SUNSET` | CU Sunset |
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
| `ALBUM_TYPES` | album-types |
| `ALLOW_DVR` | allow_dvr |
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
| `AVOD_NEW_MEDIA` | avod-new-media |
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
| `BOOST_VOICES` | boost-voices |
| `CAMERA_UPLOAD` | camera_upload |
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
| `CLOUDSYNC` | cloudsync |
| `COLLECTIONS` | collections |
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
| `COMPANIONS_SONOS` | companions_sonos |
| `CONTENT_FILTER` | content_filter |
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
| `DOWNLOADS_GATING` | downloads-gating |
| `DRM_SUPPORT` | drm_support |
| `DVR` | dvr |
| `DVR_BLOCK_UNSUPPORTED_COUNTRIES` | dvr-block-unsupported-countries |
| `EPG_RECENT_CHANNELS` | epg-recent-channels |
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
| `FEDERATED_AUTH` | federated-auth |
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
| `GRANDFATHER_SYNC` | grandfather-sync |
| `GUIDED_UPGRADE` | guided-upgrade |
| `HARDWARE_TRANSCODING` | hardware_transcoding |
| `HOME` | home |
| `HWTRANSCODE` | hwtranscode |
| `IMAGGA_V2` | imagga-v2 |
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
| `ITEM_CLUSTERS` | item_clusters |
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
| `KEVIN_BACON` | kevin-bacon |
| `KOREA_CONSENT` | korea-consent |
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
| `LETS_ENCRYPT` | lets_encrypt |
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
| `LIVETV` | livetv |
| `LYRICS` | lyrics |
| `METADATA_SEARCH` | metadata_search |
| `MUSIC_ANALYSIS` | music-analysis |
| `MUSIC_VIDEOS` | music_videos |
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
| `NOMINATIM` | nominatim |
| `PASS` | pass |
| `PHOTOS_FAVORITES` | photos-favorites |
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
| `PHOTOS_V6_EDIT` | photosV6-edit |
| `PHOTOS_V6_TV_ALBUMS` | photosV6-tv-albums |
| `PMS_HEALTH` | pms_health |
| `PREMIUM_DASHBOARD` | premium-dashboard |
| `PREMIUM_MUSIC_METADATA` | premium_music_metadata |
| `RADIO` | radio |
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
| `SESSION_BANDWIDTH_RESTRICTIONS` | session_bandwidth_restrictions |
| `SESSION_KICK` | session_kick |
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
| `SIGNIN_NOTIFICATION` | signin_notification |
| `SIGNIN_WITH_APPLE` | signin_with_apple |
| `SILENCE_REMOVAL` | silence-removal |
| `SLEEP_TIMER` | sleep-timer |
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
| `SYNC` | sync |
| `SWEET_FADES` | sweet-fades |
| `TRANSCODER_CACHE` | transcoder_cache |
| `TRAILERS` | trailers |
| `TUNER_SHARING` | tuner-sharing |
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
| `UPGRADE_3DS2` | upgrade-3ds2 |
| `VISUALIZERS` | visualizers |
| `VOD_SCHEMA` | vod-schema |
| `VOD_CLOUDFLARE` | vod_cloudflare |
| `VOLUME_LEVELING` | volume-leveling |
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
| `WATCHLIST_RSS` | watchlist-rss |
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |
| `WEBHOOKS` | webhooks |

View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `features` | List[[operations.GetTokenDetailsFeatures](../../models/operations/gettokendetailsfeatures.md)] | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | | | `features` | List[*str*] | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `active` | *Optional[bool]* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true | | `active` | *Optional[bool]* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `subscribed_at` | *OptionalNullable[str]* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z | | `subscribed_at` | *OptionalNullable[str]* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `status` | [Optional[operations.GetTokenDetailsAuthenticationResponseStatus]](../../models/operations/gettokendetailsauthenticationresponsestatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive | | `status` | [Optional[operations.GetTokenDetailsAuthenticationResponseStatus]](../../models/operations/gettokendetailsauthenticationresponsestatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |

View File

@@ -6,7 +6,7 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filter_` | [operations.Filter](../../models/operations/filter_.md) | :heavy_check_mark: | Filter | | | `filter_` | [operations.Filter](../../models/operations/filter_.md) | :heavy_check_mark: | Filter | |
| `x_plex_token` | *str* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf | | `x_plex_token` | *str* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
| `sort` | *Optional[str]* | :heavy_minus_sign: | In the format "field:dir". Available fields are "watchlistedAt" (Added At),<br/>"titleSort" (Title), "originallyAvailableAt" (Release Date), or "rating" (Critic Rating).<br/>"dir" can be "asc" or "desc"<br/> | | | `sort` | *Optional[str]* | :heavy_minus_sign: | In the format "field:dir". Available fields are "watchlistedAt" (Added At),<br/>"titleSort" (Title), "originallyAvailableAt" (Release Date), or "rating" (Critic Rating).<br/>"dir" can be "asc" or "desc"<br/> | |
| `libtype` | [Optional[operations.Libtype]](../../models/operations/libtype.md) | :heavy_minus_sign: | The type of library to filter. Can be "movie" or "show", or all if not present.<br/> | | | `libtype` | [Optional[operations.Libtype]](../../models/operations/libtype.md) | :heavy_minus_sign: | The type of library to filter. Can be "movie" or "show", or all if not present.<br/> | |
| `maxresults` | *Optional[int]* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/> | | | `maxresults` | *Optional[int]* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/> | |

View File

@@ -5,5 +5,4 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *int* | :heavy_check_mark: | N/A | 1 | | `path` | *Optional[str]* | :heavy_minus_sign: | N/A | /TV Shows/House |
| `path` | *str* | :heavy_check_mark: | N/A | /movies |

View File

@@ -6,20 +6,20 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119534 | | `id` | *int* | :heavy_check_mark: | N/A | 119534 |
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
| `bitrate` | *int* | :heavy_check_mark: | N/A | 25025 |
| `width` | *int* | :heavy_check_mark: | N/A | 3840 |
| `height` | *int* | :heavy_check_mark: | N/A | 2072 |
| `aspect_ratio` | *float* | :heavy_check_mark: | N/A | 1.85 |
| `audio_channels` | *int* | :heavy_check_mark: | N/A | 6 |
| `audio_codec` | *str* | :heavy_check_mark: | N/A | eac3 |
| `video_codec` | *str* | :heavy_check_mark: | N/A | hevc |
| `video_resolution` | *str* | :heavy_check_mark: | N/A | 4k |
| `container` | *str* | :heavy_check_mark: | N/A | mkv | | `container` | *str* | :heavy_check_mark: | N/A | mkv |
| `video_frame_rate` | *str* | :heavy_check_mark: | N/A | 24p |
| `video_profile` | *str* | :heavy_check_mark: | N/A | main 10 |
| `part` | List[[operations.Part](../../models/operations/part.md)] | :heavy_check_mark: | N/A | | | `part` | List[[operations.Part](../../models/operations/part.md)] | :heavy_check_mark: | N/A | |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | N/A | 25025 |
| `width` | *Optional[int]* | :heavy_minus_sign: | N/A | 3840 |
| `height` | *Optional[int]* | :heavy_minus_sign: | N/A | 2072 |
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | N/A | 1.85 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts | | `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts |
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | N/A | 6 |
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | eac3 |
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | hevc |
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | N/A | 4k |
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | N/A | 24p |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main 10 |
| `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | [Optional[operations.OptimizedForStreaming]](../../models/operations/optimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 | | `optimized_for_streaming` | [Optional[operations.OptimizedForStreaming]](../../models/operations/optimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |

View File

@@ -7,14 +7,14 @@
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119542 | | `id` | *int* | :heavy_check_mark: | N/A | 119542 |
| `key` | *str* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv | | `key` | *str* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
| `file` | *str* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv | | `file` | *str* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
| `size` | *int* | :heavy_check_mark: | N/A | 36158371307 | | `size` | *int* | :heavy_check_mark: | N/A | 36158371307 |
| `container` | *str* | :heavy_check_mark: | The container format of the media file.<br/> | mkv | | `container` | *str* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
| `video_profile` | *str* | :heavy_check_mark: | N/A | main 10 | | `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts | | `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `optimized_for_streaming` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main 10 |
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd | | `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
| `has_thumbnail` | [Optional[operations.HasThumbnail]](../../models/operations/hasthumbnail.md) | :heavy_minus_sign: | N/A | 1 | | `has_thumbnail` | [Optional[operations.HasThumbnail]](../../models/operations/hasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | List[[operations.Stream](../../models/operations/stream.md)] | :heavy_minus_sign: | N/A | | | `stream` | List[[operations.Stream](../../models/operations/stream.md)] | :heavy_minus_sign: | N/A | |

View File

@@ -1,102 +0,0 @@
# PostUsersSignInDataAuthenticationFeatures
## Values
| Name | Value |
| ----------------------------------------- | ----------------------------------------- |
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
| `ANDROID_PI_P` | Android - PiP |
| `CU_SUNSET` | CU Sunset |
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
| `ALBUM_TYPES` | album-types |
| `ALLOW_DVR` | allow_dvr |
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
| `AVOD_NEW_MEDIA` | avod-new-media |
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
| `BOOST_VOICES` | boost-voices |
| `CAMERA_UPLOAD` | camera_upload |
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
| `CLOUDSYNC` | cloudsync |
| `COLLECTIONS` | collections |
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
| `COMPANIONS_SONOS` | companions_sonos |
| `CONTENT_FILTER` | content_filter |
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
| `DOWNLOADS_GATING` | downloads-gating |
| `DRM_SUPPORT` | drm_support |
| `DVR` | dvr |
| `DVR_BLOCK_UNSUPPORTED_COUNTRIES` | dvr-block-unsupported-countries |
| `EPG_RECENT_CHANNELS` | epg-recent-channels |
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
| `FEDERATED_AUTH` | federated-auth |
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
| `GRANDFATHER_SYNC` | grandfather-sync |
| `GUIDED_UPGRADE` | guided-upgrade |
| `HARDWARE_TRANSCODING` | hardware_transcoding |
| `HOME` | home |
| `HWTRANSCODE` | hwtranscode |
| `IMAGGA_V2` | imagga-v2 |
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
| `ITEM_CLUSTERS` | item_clusters |
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
| `KEVIN_BACON` | kevin-bacon |
| `KOREA_CONSENT` | korea-consent |
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
| `LETS_ENCRYPT` | lets_encrypt |
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
| `LIVETV` | livetv |
| `LYRICS` | lyrics |
| `METADATA_SEARCH` | metadata_search |
| `MUSIC_ANALYSIS` | music-analysis |
| `MUSIC_VIDEOS` | music_videos |
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
| `NOMINATIM` | nominatim |
| `PASS` | pass |
| `PHOTOS_FAVORITES` | photos-favorites |
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
| `PHOTOS_V6_EDIT` | photosV6-edit |
| `PHOTOS_V6_TV_ALBUMS` | photosV6-tv-albums |
| `PMS_HEALTH` | pms_health |
| `PREMIUM_DASHBOARD` | premium-dashboard |
| `PREMIUM_MUSIC_METADATA` | premium_music_metadata |
| `RADIO` | radio |
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
| `SESSION_BANDWIDTH_RESTRICTIONS` | session_bandwidth_restrictions |
| `SESSION_KICK` | session_kick |
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
| `SIGNIN_NOTIFICATION` | signin_notification |
| `SIGNIN_WITH_APPLE` | signin_with_apple |
| `SILENCE_REMOVAL` | silence-removal |
| `SLEEP_TIMER` | sleep-timer |
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
| `SYNC` | sync |
| `SWEET_FADES` | sweet-fades |
| `TRANSCODER_CACHE` | transcoder_cache |
| `TRAILERS` | trailers |
| `TUNER_SHARING` | tuner-sharing |
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
| `UPGRADE_3DS2` | upgrade-3ds2 |
| `VISUALIZERS` | visualizers |
| `VOD_SCHEMA` | vod-schema |
| `VOD_CLOUDFLARE` | vod_cloudflare |
| `VOLUME_LEVELING` | volume-leveling |
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
| `WATCHLIST_RSS` | watchlist-rss |
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |
| `WEBHOOKS` | webhooks |

View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `features` | List[[operations.PostUsersSignInDataAuthenticationFeatures](../../models/operations/postuserssignindataauthenticationfeatures.md)] | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | | | `features` | List[*str*] | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `active` | *Optional[bool]* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true | | `active` | *Optional[bool]* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `subscribed_at` | *OptionalNullable[str]* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z | | `subscribed_at` | *OptionalNullable[str]* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `status` | [Optional[operations.PostUsersSignInDataAuthenticationResponseStatus]](../../models/operations/postuserssignindataauthenticationresponsestatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive | | `status` | [Optional[operations.PostUsersSignInDataAuthenticationResponseStatus]](../../models/operations/postuserssignindataauthenticationresponsestatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |

View File

@@ -1,102 +0,0 @@
# PostUsersSignInDataFeatures
## Values
| Name | Value |
| ----------------------------------------- | ----------------------------------------- |
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
| `ANDROID_PI_P` | Android - PiP |
| `CU_SUNSET` | CU Sunset |
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
| `ALBUM_TYPES` | album-types |
| `ALLOW_DVR` | allow_dvr |
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
| `AVOD_NEW_MEDIA` | avod-new-media |
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
| `BOOST_VOICES` | boost-voices |
| `CAMERA_UPLOAD` | camera_upload |
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
| `CLOUDSYNC` | cloudsync |
| `COLLECTIONS` | collections |
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
| `COMPANIONS_SONOS` | companions_sonos |
| `CONTENT_FILTER` | content_filter |
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
| `DOWNLOADS_GATING` | downloads-gating |
| `DRM_SUPPORT` | drm_support |
| `DVR` | dvr |
| `DVR_BLOCK_UNSUPPORTED_COUNTRIES` | dvr-block-unsupported-countries |
| `EPG_RECENT_CHANNELS` | epg-recent-channels |
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
| `FEDERATED_AUTH` | federated-auth |
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
| `GRANDFATHER_SYNC` | grandfather-sync |
| `GUIDED_UPGRADE` | guided-upgrade |
| `HARDWARE_TRANSCODING` | hardware_transcoding |
| `HOME` | home |
| `HWTRANSCODE` | hwtranscode |
| `IMAGGA_V2` | imagga-v2 |
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
| `ITEM_CLUSTERS` | item_clusters |
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
| `KEVIN_BACON` | kevin-bacon |
| `KOREA_CONSENT` | korea-consent |
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
| `LETS_ENCRYPT` | lets_encrypt |
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
| `LIVETV` | livetv |
| `LYRICS` | lyrics |
| `METADATA_SEARCH` | metadata_search |
| `MUSIC_ANALYSIS` | music-analysis |
| `MUSIC_VIDEOS` | music_videos |
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
| `NOMINATIM` | nominatim |
| `PASS` | pass |
| `PHOTOS_FAVORITES` | photos-favorites |
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
| `PHOTOS_V6_EDIT` | photosV6-edit |
| `PHOTOS_V6_TV_ALBUMS` | photosV6-tv-albums |
| `PMS_HEALTH` | pms_health |
| `PREMIUM_DASHBOARD` | premium-dashboard |
| `PREMIUM_MUSIC_METADATA` | premium_music_metadata |
| `RADIO` | radio |
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
| `SESSION_BANDWIDTH_RESTRICTIONS` | session_bandwidth_restrictions |
| `SESSION_KICK` | session_kick |
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
| `SIGNIN_NOTIFICATION` | signin_notification |
| `SIGNIN_WITH_APPLE` | signin_with_apple |
| `SILENCE_REMOVAL` | silence-removal |
| `SLEEP_TIMER` | sleep-timer |
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
| `SYNC` | sync |
| `SWEET_FADES` | sweet-fades |
| `TRANSCODER_CACHE` | transcoder_cache |
| `TRAILERS` | trailers |
| `TUNER_SHARING` | tuner-sharing |
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
| `UPGRADE_3DS2` | upgrade-3ds2 |
| `VISUALIZERS` | visualizers |
| `VOD_SCHEMA` | vod-schema |
| `VOD_CLOUDFLARE` | vod_cloudflare |
| `VOLUME_LEVELING` | volume-leveling |
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
| `WATCHLIST_RSS` | watchlist-rss |
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |
| `WEBHOOKS` | webhooks |

View File

@@ -3,10 +3,10 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | | `client_name` | *Optional[str]* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | | `device_nickname` | *Optional[str]* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | | `client_version` | *Optional[str]* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | | `platform` | *Optional[str]* | :heavy_minus_sign: | The platform of the client application. | Roku |

View File

@@ -3,11 +3,11 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | | `client_name` | *Optional[str]* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | | `device_nickname` | *Optional[str]* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | | `client_version` | *Optional[str]* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | | `platform` | *Optional[str]* | :heavy_minus_sign: | The platform of the client application. | Roku |
| `request_body` | [Optional[operations.PostUsersSignInDataRequestBody]](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | | | `request_body` | [Optional[operations.PostUsersSignInDataRequestBody]](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | |

View File

@@ -7,7 +7,7 @@ If the accounts Plex Pass subscription is active
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `features` | List[[operations.PostUsersSignInDataFeatures](../../models/operations/postuserssignindatafeatures.md)] | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | | | `features` | List[*str*] | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `active` | *Optional[bool]* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true | | `active` | *Optional[bool]* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `subscribed_at` | *OptionalNullable[str]* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z | | `subscribed_at` | *OptionalNullable[str]* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `status` | [Optional[operations.PostUsersSignInDataAuthenticationStatus]](../../models/operations/postuserssignindataauthenticationstatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive | | `status` | [Optional[operations.PostUsersSignInDataAuthenticationStatus]](../../models/operations/postuserssignindataauthenticationstatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |

View File

@@ -0,0 +1,11 @@
# QueryParamIncludeCollections
Whether to include collections in the search results.
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

View File

@@ -0,0 +1,11 @@
# QueryParamIncludeExternalMedia
Whether to include external media in the search results.
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

View File

@@ -0,0 +1,9 @@
# SearchResult
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `score` | *float* | :heavy_check_mark: | N/A |
| `metadata` | [operations.GetSearchAllLibrariesMetadata](../../models/operations/getsearchalllibrariesmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,12 @@
# SearchTypes
## Values
| Name | Value |
| -------------- | -------------- |
| `MOVIES` | movies |
| `MUSIC` | music |
| `OTHER_VIDEOS` | otherVideos |
| `PEOPLE` | people |
| `TV` | tv |

View File

@@ -7,7 +7,7 @@ If the accounts Plex Pass subscription is active
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `features` | List[[operations.Features](../../models/operations/features.md)] | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | | | `features` | List[*str*] | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `active` | *Optional[bool]* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true | | `active` | *Optional[bool]* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `subscribed_at` | *OptionalNullable[str]* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z | | `subscribed_at` | *OptionalNullable[str]* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `status` | [Optional[operations.GetTokenDetailsAuthenticationStatus]](../../models/operations/gettokendetailsauthenticationstatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive | | `status` | [Optional[operations.GetTokenDetailsAuthenticationStatus]](../../models/operations/gettokendetailsauthenticationstatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |

View File

@@ -28,11 +28,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.activities.get_server_activities() res = s.activities.get_server_activities()
@@ -72,11 +72,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.activities.cancel_server_activities(activity_uuid="25b71ed5-0f9d-461c-baa7-d404e9e10d3e") res = s.activities.cancel_server_activities(activity_uuid="25b71ed5-0f9d-461c-baa7-d404e9e10d3e")

View File

@@ -26,11 +26,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.authentication.get_transient_token(type_=operations.GetTransientTokenQueryParamType.DELEGATION, scope=operations.Scope.ALL) res = s.authentication.get_transient_token(type_=operations.GetTransientTokenQueryParamType.DELEGATION, scope=operations.Scope.ALL)
@@ -74,11 +74,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.authentication.get_source_connection_information(source="provider://provider-identifier") res = s.authentication.get_source_connection_information(source="provider://provider-identifier")
@@ -119,11 +119,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.authentication.get_token_details() res = s.authentication.get_token_details()
@@ -163,11 +163,11 @@ Sign in user with username and password and return user data with Plex authentic
from plex_api_client import PlexAPI from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.authentication.post_users_sign_in_data(request={ res = s.authentication.post_users_sign_in_data(request={

View File

@@ -25,11 +25,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.butler.get_butler_tasks() res = s.butler.get_butler_tasks()
@@ -74,11 +74,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.butler.start_all_tasks() res = s.butler.start_all_tasks()
@@ -119,11 +119,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.butler.stop_all_tasks() res = s.butler.stop_all_tasks()
@@ -169,11 +169,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.butler.start_task(task_name=operations.TaskName.CLEAN_OLD_BUNDLES) res = s.butler.start_task(task_name=operations.TaskName.CLEAN_OLD_BUNDLES)
@@ -216,11 +216,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.butler.stop_task(task_name=operations.PathParamTaskName.BACKUP_DATABASE) res = s.butler.stop_task(task_name=operations.PathParamTaskName.BACKUP_DATABASE)

View File

@@ -23,11 +23,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.hubs.get_global_hubs() res = s.hubs.get_global_hubs()
@@ -71,11 +71,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.hubs.get_recently_added(request={ res = s.hubs.get_recently_added(request={
@@ -122,11 +122,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.hubs.get_library_hubs(section_id=6728.76) res = s.hubs.get_library_hubs(section_id=6728.76)

View File

@@ -16,6 +16,7 @@ API Calls interacting with Plex Media Server Libraries
* [get_library_items](#get_library_items) - Get Library Items * [get_library_items](#get_library_items) - Get Library Items
* [get_refresh_library_metadata](#get_refresh_library_metadata) - Refresh Metadata Of The Library * [get_refresh_library_metadata](#get_refresh_library_metadata) - Refresh Metadata Of The Library
* [get_search_library](#get_search_library) - Search Library * [get_search_library](#get_search_library) - Search Library
* [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_meta_data_by_rating_key](#get_meta_data_by_rating_key) - Get Metadata by RatingKey
* [get_metadata_children](#get_metadata_children) - Get Items Children * [get_metadata_children](#get_metadata_children) - Get Items Children
* [get_top_watched_content](#get_top_watched_content) - Get Top Watched Content * [get_top_watched_content](#get_top_watched_content) - Get Top Watched Content
@@ -32,11 +33,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.library.get_file_hash(url="file://C:\Image.png&type=13") res = s.library.get_file_hash(url="file://C:\Image.png&type=13")
@@ -80,11 +81,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.library.get_recently_added_library(request={ res = s.library.get_recently_added_library(request={
@@ -152,11 +153,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.library.get_all_libraries() res = s.library.get_all_libraries()
@@ -235,11 +236,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.library.get_library_details(section_key=9518) res = s.library.get_library_details(section_key=9518)
@@ -281,11 +282,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.library.delete_library(section_key=9518) res = s.library.delete_library(section_key=9518)
@@ -347,16 +348,16 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.library.get_library_items(request={ res = s.library.get_library_items(request={
"section_key": 9518,
"tag": operations.Tag.EDITION, "tag": operations.Tag.EDITION,
"section_key": 9518,
"include_guids": operations.IncludeGuids.ENABLE, "include_guids": operations.IncludeGuids.ENABLE,
"type": operations.GetLibraryItemsQueryParamType.TV_SHOW, "type": operations.GetLibraryItemsQueryParamType.TV_SHOW,
"include_meta": operations.GetLibraryItemsQueryParamIncludeMeta.ENABLE, "include_meta": operations.GetLibraryItemsQueryParamIncludeMeta.ENABLE,
@@ -402,11 +403,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.library.get_refresh_library_metadata(section_key=9518, force=operations.Force.ONE) res = s.library.get_refresh_library_metadata(section_key=9518, force=operations.Force.ONE)
@@ -467,11 +468,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.library.get_search_library(section_key=9518, type_=operations.GetSearchLibraryQueryParamType.TV_SHOW) res = s.library.get_search_library(section_key=9518, type_=operations.GetSearchLibraryQueryParamType.TV_SHOW)
@@ -502,6 +503,60 @@ if res.object is not None:
| errors.GetSearchLibraryUnauthorized | 401 | application/json | | errors.GetSearchLibraryUnauthorized | 401 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* | | 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.
### Example Usage
```python
from plex_api_client import PlexAPI
from plex_api_client.models import operations
s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex for Roku",
client_version="2.4.1",
platform="Roku",
device_nickname="Roku 3",
)
res = s.library.get_search_all_libraries(request={
"query": "<value>",
"search_types": [
operations.SearchTypes.PEOPLE,
],
"include_collections": operations.QueryParamIncludeCollections.ENABLE,
"include_external_media": operations.QueryParamIncludeExternalMedia.ENABLE,
})
if res.object is not None:
# handle response
pass
```
### Parameters
| Parameter | Type | Required | Description |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `request` | [operations.GetSearchAllLibrariesRequest](../../models/operations/getsearchalllibrariesrequest.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.GetSearchAllLibrariesResponse](../../models/operations/getsearchalllibrariesresponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| errors.GetSearchAllLibrariesBadRequest | 400 | application/json |
| errors.GetSearchAllLibrariesUnauthorized | 401 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## get_meta_data_by_rating_key ## get_meta_data_by_rating_key
This endpoint will return the metadata of a library item specified with the ratingKey. This endpoint will return the metadata of a library item specified with the ratingKey.
@@ -514,11 +569,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.library.get_meta_data_by_rating_key(rating_key=9518) res = s.library.get_meta_data_by_rating_key(rating_key=9518)
@@ -560,11 +615,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.library.get_metadata_children(rating_key=1539.14, include_elements="Stream") res = s.library.get_metadata_children(rating_key=1539.14, include_elements="Stream")
@@ -608,11 +663,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.library.get_top_watched_content(type_=operations.GetTopWatchedContentQueryParamType.TV_SHOW, include_guids=1) res = s.library.get_top_watched_content(type_=operations.GetTopWatchedContentQueryParamType.TV_SHOW, include_guids=1)
@@ -655,11 +710,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.library.get_on_deck() res = s.library.get_on_deck()

View File

@@ -25,11 +25,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.log.log_line(level=operations.Level.THREE, message="Test log message", source="Postman") res = s.log.log_line(level=operations.Level.THREE, message="Test log message", source="Postman")
@@ -93,11 +93,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.log.log_multi_line(request="level=4&message=Test%20message%201&source=postman\n" + res = s.log.log_multi_line(request="level=4&message=Test%20message%201&source=postman\n" +
@@ -141,11 +141,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.log.enable_paper_trail() res = s.log.enable_paper_trail()

View File

@@ -25,11 +25,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.media.mark_played(key=59398) res = s.media.mark_played(key=59398)
@@ -70,11 +70,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.media.mark_unplayed(key=59398) res = s.media.mark_unplayed(key=59398)
@@ -116,11 +116,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.media.update_play_progress(key="<key>", time=90000, state="played") res = s.media.update_play_progress(key="<key>", time=90000, state="played")
@@ -163,11 +163,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.media.get_banner_image(request={ res = s.media.get_banner_image(request={
@@ -215,11 +215,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.media.get_thumb_image(request={ res = s.media.get_thumb_image(request={

View File

@@ -36,11 +36,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.playlists.create_playlist(request={ res = s.playlists.create_playlist(request={
@@ -86,11 +86,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.playlists.get_playlists() res = s.playlists.get_playlists()
@@ -134,11 +134,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.playlists.get_playlist(playlist_id=4109.48) res = s.playlists.get_playlist(playlist_id=4109.48)
@@ -180,11 +180,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.playlists.delete_playlist(playlist_id=216.22) res = s.playlists.delete_playlist(playlist_id=216.22)
@@ -226,11 +226,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.playlists.update_playlist(playlist_id=3915) res = s.playlists.update_playlist(playlist_id=3915)
@@ -278,11 +278,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.playlists.get_playlist_contents(playlist_id=5004.46, type_=operations.GetPlaylistContentsQueryParamType.TV_SHOW) res = s.playlists.get_playlist_contents(playlist_id=5004.46, type_=operations.GetPlaylistContentsQueryParamType.TV_SHOW)
@@ -325,11 +325,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.playlists.clear_playlist_contents(playlist_id=1893.18) res = s.playlists.clear_playlist_contents(playlist_id=1893.18)
@@ -372,11 +372,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.playlists.add_playlist_contents(playlist_id=8502.01, uri="server://12345/com.plexapp.plugins.library/library/metadata/1", play_queue_id=123) res = s.playlists.add_playlist_contents(playlist_id=8502.01, uri="server://12345/com.plexapp.plugins.library/library/metadata/1", play_queue_id=123)
@@ -421,11 +421,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.playlists.upload_playlist(path="/home/barkley/playlist.m3u", force=operations.QueryParamForce.ZERO, section_id=1) res = s.playlists.upload_playlist(path="/home/barkley/playlist.m3u", force=operations.QueryParamForce.ZERO, section_id=1)

View File

@@ -27,11 +27,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.plex.get_companions_data() res = s.plex.get_companions_data()
@@ -72,11 +72,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.plex.get_user_friends() res = s.plex.get_user_friends()
@@ -116,11 +116,11 @@ Returns the geolocation and locale data of the caller
from plex_api_client import PlexAPI from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.plex.get_geo_data() res = s.plex.get_geo_data()
@@ -161,11 +161,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.plex.get_home_data() res = s.plex.get_home_data()
@@ -206,14 +206,14 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.plex.get_server_resources(include_https=operations.IncludeHTTPS.ENABLE, include_relay=operations.IncludeRelay.ENABLE, include_i_pv6=operations.IncludeIPv6.ENABLE, client_id="gcgzw5rz2xovp84b4vha3a40") res = s.plex.get_server_resources(include_https=operations.IncludeHTTPS.ENABLE, include_relay=operations.IncludeRelay.ENABLE, include_i_pv6=operations.IncludeIPv6.ENABLE, client_id="3381b62b-9ab7-4e37-827b-203e9809eb58")
if res.plex_devices is not None: if res.plex_devices is not None:
# handle response # handle response
@@ -223,14 +223,14 @@ if res.plex_devices is not None:
### Parameters ### Parameters
| Parameter | Type | Required | Description | Example | | Parameter | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `include_https` | [Optional[operations.IncludeHTTPS]](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 | | `include_https` | [Optional[operations.IncludeHTTPS]](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `include_relay` | [Optional[operations.IncludeRelay]](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 | | `include_relay` | [Optional[operations.IncludeRelay]](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `include_i_pv6` | [Optional[operations.IncludeIPv6]](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 | | `include_i_pv6` | [Optional[operations.IncludeIPv6]](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
| `server_url` | *Optional[str]* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 | | `server_url` | *Optional[str]* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response ### Response
@@ -254,11 +254,11 @@ Retrieve a Pin ID from Plex.tv to use for authentication flows
from plex_api_client import PlexAPI from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.plex.get_pin(request={}) res = s.plex.get_pin(request={})
@@ -298,11 +298,11 @@ Retrieve an Access Token from Plex.tv after the Pin has been authenticated
from plex_api_client import PlexAPI from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.plex.get_token_by_pin_id(request={ res = s.plex.get_token_by_pin_id(request={

View File

@@ -25,4 +25,4 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
| Swift | [GitHub](https://github.com/LukeHagar/plexswift) | [Releases](https://github.com/LukeHagar/plexswift/releases) | - | | Swift | [GitHub](https://github.com/LukeHagar/plexswift) | [Releases](https://github.com/LukeHagar/plexswift/releases) | - |
| PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - | | PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - |
| Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - | | Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - |
| C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | - | C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -

View File

@@ -35,11 +35,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.search.perform_search(query="dylan", limit=5) res = s.search.perform_search(query="dylan", limit=5)
@@ -86,11 +86,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.search.perform_voice_search(query="dead+poop", limit=5) res = s.search.perform_voice_search(query="dead+poop", limit=5)
@@ -133,11 +133,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.search.get_search_results(query="110") res = s.search.get_search_results(query="110")

View File

@@ -29,11 +29,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.server.get_server_capabilities() res = s.server.get_server_capabilities()
@@ -73,11 +73,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.server.get_server_preferences() res = s.server.get_server_preferences()
@@ -117,11 +117,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.server.get_available_clients() res = s.server.get_available_clients()
@@ -161,11 +161,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.server.get_devices() res = s.server.get_devices()
@@ -204,11 +204,11 @@ This request is useful to determine if the server is online or offline
from plex_api_client import PlexAPI from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.server.get_server_identity() res = s.server.get_server_identity()
@@ -247,11 +247,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.server.get_my_plex_account() res = s.server.get_my_plex_account()
@@ -293,11 +293,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.server.get_resized_photo(request={ res = s.server.get_resized_photo(request={
@@ -346,11 +346,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.server.get_media_providers(x_plex_token="CV5xoxjTpFKUzBTShsaf") res = s.server.get_media_providers(x_plex_token="CV5xoxjTpFKUzBTShsaf")
@@ -365,7 +365,7 @@ if res.object is not None:
| Parameter | Type | Required | Description | Example | | Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `x_plex_token` | *str* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf | | `x_plex_token` | *str* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response ### Response
@@ -391,11 +391,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.server.get_server_list() res = s.server.get_server_list()

View File

@@ -24,11 +24,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.sessions.get_sessions() res = s.sessions.get_sessions()
@@ -68,11 +68,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.sessions.get_session_history(sort="viewedAt:desc", account_id=1, filter_={}, library_section_id=12) res = s.sessions.get_session_history(sort="viewedAt:desc", account_id=1, filter_={}, library_section_id=12)
@@ -116,11 +116,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.sessions.get_transcode_sessions() res = s.sessions.get_transcode_sessions()
@@ -160,11 +160,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.sessions.stop_transcode_session(session_key="zz7llzqlx8w9vnrsbnwhbmep") res = s.sessions.stop_transcode_session(session_key="zz7llzqlx8w9vnrsbnwhbmep")

View File

@@ -23,11 +23,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.statistics.get_statistics(timespan=4) res = s.statistics.get_statistics(timespan=4)
@@ -68,11 +68,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.statistics.get_resources_statistics(timespan=4) res = s.statistics.get_resources_statistics(timespan=4)
@@ -113,11 +113,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.statistics.get_bandwidth_statistics(timespan=4) res = s.statistics.get_bandwidth_statistics(timespan=4)

View File

@@ -24,11 +24,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.updater.get_update_status() res = s.updater.get_update_status()
@@ -69,11 +69,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.updater.check_for_updates(download=operations.Download.ONE) res = s.updater.check_for_updates(download=operations.Download.ONE)
@@ -116,11 +116,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.updater.apply_updates(tonight=operations.Tonight.ONE, skip=operations.Skip.ONE) res = s.updater.apply_updates(tonight=operations.Tonight.ONE, skip=operations.Skip.ONE)

View File

@@ -23,11 +23,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.video.get_timeline(request={ res = s.video.get_timeline(request={
@@ -79,11 +79,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.video.start_universal_transcode(request={ res = s.video.start_universal_transcode(request={

View File

@@ -22,11 +22,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40", client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name="Plex Web", client_name="Plex for Roku",
client_version="4.133.0", client_version="2.4.1",
client_platform="Chrome", platform="Roku",
device_name="Linux", device_nickname="Roku 3",
) )
res = s.watchlist.get_watch_list(request={ res = s.watchlist.get_watch_list(request={

View File

@@ -1,6 +1,6 @@
[tool.poetry] [tool.poetry]
name = "plex-api-client" name = "plex-api-client"
version = "0.17.1" version = "0.18.0"
description = "Python Client SDK Generated by Speakeasy" description = "Python Client SDK Generated by Speakeasy"
authors = ["Speakeasy",] authors = ["Speakeasy",]
readme = "README-PYPI.md" readme = "README-PYPI.md"

View File

@@ -59,10 +59,14 @@ class Activities(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -150,10 +154,14 @@ class Activities(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -248,10 +256,14 @@ class Activities(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -343,10 +355,14 @@ class Activities(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(

View File

@@ -62,10 +62,14 @@ class Authentication(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -161,10 +165,14 @@ class Authentication(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -258,10 +266,14 @@ class Authentication(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -355,10 +367,14 @@ class Authentication(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -445,10 +461,14 @@ class Authentication(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -538,10 +558,14 @@ class Authentication(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -631,15 +655,15 @@ class Authentication(BaseSDK):
request=request, request=request,
request_body_required=False, request_body_required=False,
request_has_path_params=False, request_has_path_params=False,
request_has_query_params=True, request_has_query_params=False,
user_agent_header="user-agent", user_agent_header="user-agent",
accept_header_value="application/json", accept_header_value="application/json",
_globals=operations.PostUsersSignInDataGlobals( _globals=operations.PostUsersSignInDataGlobals(
client_id=self.sdk_configuration.globals.client_id, client_id=self.sdk_configuration.globals.client_id,
client_name=self.sdk_configuration.globals.client_name, client_name=self.sdk_configuration.globals.client_name,
device_name=self.sdk_configuration.globals.device_name, device_nickname=self.sdk_configuration.globals.device_nickname,
client_version=self.sdk_configuration.globals.client_version, client_version=self.sdk_configuration.globals.client_version,
client_platform=self.sdk_configuration.globals.client_platform, platform=self.sdk_configuration.globals.platform,
), ),
get_serialized_body=lambda: utils.serialize_request_body( get_serialized_body=lambda: utils.serialize_request_body(
request.request_body, request.request_body,
@@ -654,10 +678,14 @@ class Authentication(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -748,15 +776,15 @@ class Authentication(BaseSDK):
request=request, request=request,
request_body_required=False, request_body_required=False,
request_has_path_params=False, request_has_path_params=False,
request_has_query_params=True, request_has_query_params=False,
user_agent_header="user-agent", user_agent_header="user-agent",
accept_header_value="application/json", accept_header_value="application/json",
_globals=operations.PostUsersSignInDataGlobals( _globals=operations.PostUsersSignInDataGlobals(
client_id=self.sdk_configuration.globals.client_id, client_id=self.sdk_configuration.globals.client_id,
client_name=self.sdk_configuration.globals.client_name, client_name=self.sdk_configuration.globals.client_name,
device_name=self.sdk_configuration.globals.device_name, device_nickname=self.sdk_configuration.globals.device_nickname,
client_version=self.sdk_configuration.globals.client_version, client_version=self.sdk_configuration.globals.client_version,
client_platform=self.sdk_configuration.globals.client_platform, platform=self.sdk_configuration.globals.platform,
), ),
get_serialized_body=lambda: utils.serialize_request_body( get_serialized_body=lambda: utils.serialize_request_body(
request.request_body, request.request_body,
@@ -771,10 +799,14 @@ class Authentication(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(

View File

@@ -51,10 +51,14 @@ class Butler(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -142,10 +146,14 @@ class Butler(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -238,10 +246,14 @@ class Butler(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -331,10 +343,14 @@ class Butler(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -420,10 +436,14 @@ class Butler(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -509,10 +529,14 @@ class Butler(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -609,10 +633,14 @@ class Butler(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -705,10 +733,14 @@ class Butler(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -797,10 +829,14 @@ class Butler(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -889,10 +925,14 @@ class Butler(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(

View File

@@ -61,10 +61,14 @@ class Hubs(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -162,10 +166,14 @@ class Hubs(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -264,10 +272,14 @@ class Hubs(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -353,10 +365,14 @@ class Hubs(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -445,10 +461,14 @@ class Hubs(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -550,10 +570,14 @@ class Hubs(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(

View File

@@ -61,10 +61,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -157,10 +161,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -256,10 +264,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -361,10 +373,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -459,10 +475,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -556,10 +576,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -676,8 +700,8 @@ class Library(BaseSDK):
base_url = server_url base_url = server_url
request = operations.GetLibraryDetailsRequest( request = operations.GetLibraryDetailsRequest(
section_key=section_key,
include_details=include_details, include_details=include_details,
section_key=section_key,
) )
req = self.build_request( req = self.build_request(
@@ -698,10 +722,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -818,8 +846,8 @@ class Library(BaseSDK):
base_url = server_url base_url = server_url
request = operations.GetLibraryDetailsRequest( request = operations.GetLibraryDetailsRequest(
section_key=section_key,
include_details=include_details, include_details=include_details,
section_key=section_key,
) )
req = self.build_request_async( req = self.build_request_async(
@@ -840,10 +868,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -938,10 +970,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -1033,10 +1069,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -1151,10 +1191,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -1272,10 +1316,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -1352,8 +1400,8 @@ class Library(BaseSDK):
base_url = server_url base_url = server_url
request = operations.GetRefreshLibraryMetadataRequest( request = operations.GetRefreshLibraryMetadataRequest(
section_key=section_key,
force=force, force=force,
section_key=section_key,
) )
req = self.build_request( req = self.build_request(
@@ -1374,10 +1422,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -1451,8 +1503,8 @@ class Library(BaseSDK):
base_url = server_url base_url = server_url
request = operations.GetRefreshLibraryMetadataRequest( request = operations.GetRefreshLibraryMetadataRequest(
section_key=section_key,
force=force, force=force,
section_key=section_key,
) )
req = self.build_request_async( req = self.build_request_async(
@@ -1473,10 +1525,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -1589,10 +1645,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -1708,10 +1768,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -1759,6 +1823,226 @@ class Library(BaseSDK):
http_res, http_res,
) )
def get_search_all_libraries(
self,
*,
request: Union[
operations.GetSearchAllLibrariesRequest,
operations.GetSearchAllLibrariesRequestTypedDict,
],
retries: OptionalNullable[utils.RetryConfig] = UNSET,
server_url: Optional[str] = None,
timeout_ms: Optional[int] = None,
) -> operations.GetSearchAllLibrariesResponse:
r"""Search All Libraries
Search the provided query across all library sections, or a single section, and return matches as hubs, split up by type.
: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
"""
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
if not isinstance(request, BaseModel):
request = utils.unmarshal(request, operations.GetSearchAllLibrariesRequest)
request = cast(operations.GetSearchAllLibrariesRequest, request)
req = self.build_request(
method="GET",
path="/library/search",
base_url=base_url,
url_variables=url_variables,
request=request,
request_body_required=False,
request_has_path_params=False,
request_has_query_params=True,
user_agent_header="user-agent",
accept_header_value="application/json",
_globals=operations.GetSearchAllLibrariesGlobals(
client_id=self.sdk_configuration.globals.client_id,
),
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
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None
if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["5XX"])
http_res = self.do_request(
hook_ctx=HookContext(
operation_id="get-search-all-libraries",
oauth2_scopes=[],
security_source=self.sdk_configuration.security,
),
request=req,
error_status_codes=["400", "401", "4XX", "5XX"],
retry_config=retry_config,
)
data: Any = None
if utils.match_response(http_res, "200", "application/json"):
return operations.GetSearchAllLibrariesResponse(
object=utils.unmarshal_json(
http_res.text,
Optional[operations.GetSearchAllLibrariesResponseBody],
),
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"):
data = utils.unmarshal_json(
http_res.text, errors.GetSearchAllLibrariesBadRequestData
)
data.raw_response = http_res
raise errors.GetSearchAllLibrariesBadRequest(data=data)
if utils.match_response(http_res, "401", "application/json"):
data = utils.unmarshal_json(
http_res.text, errors.GetSearchAllLibrariesUnauthorizedData
)
data.raw_response = http_res
raise errors.GetSearchAllLibrariesUnauthorized(data=data)
if utils.match_response(http_res, ["4XX", "5XX"], "*"):
raise errors.SDKError(
"API error occurred", http_res.status_code, http_res.text, http_res
)
content_type = http_res.headers.get("Content-Type")
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_search_all_libraries_async(
self,
*,
request: Union[
operations.GetSearchAllLibrariesRequest,
operations.GetSearchAllLibrariesRequestTypedDict,
],
retries: OptionalNullable[utils.RetryConfig] = UNSET,
server_url: Optional[str] = None,
timeout_ms: Optional[int] = None,
) -> operations.GetSearchAllLibrariesResponse:
r"""Search All Libraries
Search the provided query across all library sections, or a single section, and return matches as hubs, split up by type.
: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
"""
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
if not isinstance(request, BaseModel):
request = utils.unmarshal(request, operations.GetSearchAllLibrariesRequest)
request = cast(operations.GetSearchAllLibrariesRequest, request)
req = self.build_request_async(
method="GET",
path="/library/search",
base_url=base_url,
url_variables=url_variables,
request=request,
request_body_required=False,
request_has_path_params=False,
request_has_query_params=True,
user_agent_header="user-agent",
accept_header_value="application/json",
_globals=operations.GetSearchAllLibrariesGlobals(
client_id=self.sdk_configuration.globals.client_id,
),
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
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None
if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["5XX"])
http_res = await self.do_request_async(
hook_ctx=HookContext(
operation_id="get-search-all-libraries",
oauth2_scopes=[],
security_source=self.sdk_configuration.security,
),
request=req,
error_status_codes=["400", "401", "4XX", "5XX"],
retry_config=retry_config,
)
data: Any = None
if utils.match_response(http_res, "200", "application/json"):
return operations.GetSearchAllLibrariesResponse(
object=utils.unmarshal_json(
http_res.text,
Optional[operations.GetSearchAllLibrariesResponseBody],
),
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"):
data = utils.unmarshal_json(
http_res.text, errors.GetSearchAllLibrariesBadRequestData
)
data.raw_response = http_res
raise errors.GetSearchAllLibrariesBadRequest(data=data)
if utils.match_response(http_res, "401", "application/json"):
data = utils.unmarshal_json(
http_res.text, errors.GetSearchAllLibrariesUnauthorizedData
)
data.raw_response = http_res
raise errors.GetSearchAllLibrariesUnauthorized(data=data)
if utils.match_response(http_res, ["4XX", "5XX"], "*"):
raise errors.SDKError(
"API error occurred", http_res.status_code, http_res.text, http_res
)
content_type = http_res.headers.get("Content-Type")
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_meta_data_by_rating_key( def get_meta_data_by_rating_key(
self, self,
*, *,
@@ -1807,10 +2091,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -1907,10 +2195,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -2010,10 +2302,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -2112,10 +2408,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -2192,8 +2492,8 @@ class Library(BaseSDK):
base_url = server_url base_url = server_url
request = operations.GetTopWatchedContentRequest( request = operations.GetTopWatchedContentRequest(
type=type_,
include_guids=include_guids, include_guids=include_guids,
type=type_,
) )
req = self.build_request( req = self.build_request(
@@ -2214,10 +2514,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -2294,8 +2598,8 @@ class Library(BaseSDK):
base_url = server_url base_url = server_url
request = operations.GetTopWatchedContentRequest( request = operations.GetTopWatchedContentRequest(
type=type_,
include_guids=include_guids, include_guids=include_guids,
type=type_,
) )
req = self.build_request_async( req = self.build_request_async(
@@ -2316,10 +2620,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -2408,10 +2716,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -2496,10 +2808,14 @@ class Library(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(

View File

@@ -65,10 +65,14 @@ class Log(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -163,10 +167,14 @@ class Log(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -274,10 +282,14 @@ class Log(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -389,10 +401,14 @@ class Log(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -478,10 +494,14 @@ class Log(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -567,10 +587,14 @@ class Log(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(

View File

@@ -58,10 +58,14 @@ class Media(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -151,10 +155,14 @@ class Media(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -244,10 +252,14 @@ class Media(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -339,10 +351,14 @@ class Media(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -441,10 +457,14 @@ class Media(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -543,10 +563,14 @@ class Media(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -640,10 +664,14 @@ class Media(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -740,10 +768,14 @@ class Media(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -840,10 +872,14 @@ class Media(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = self.do_request( http_res = self.do_request(
hook_ctx=HookContext( hook_ctx=HookContext(
@@ -940,10 +976,14 @@ class Media(BaseSDK):
if retries == UNSET: if retries == UNSET:
if self.sdk_configuration.retry_config is not UNSET: if self.sdk_configuration.retry_config is not UNSET:
retries = self.sdk_configuration.retry_config retries = self.sdk_configuration.retry_config
else:
retries = utils.RetryConfig(
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
)
retry_config = None retry_config = None
if isinstance(retries, utils.RetryConfig): if isinstance(retries, utils.RetryConfig):
retry_config = (retries, ["429", "500", "502", "503", "504"]) retry_config = (retries, ["5XX"])
http_res = await self.do_request_async( http_res = await self.do_request_async(
hook_ctx=HookContext( hook_ctx=HookContext(

View File

@@ -3,8 +3,8 @@
from __future__ import annotations from __future__ import annotations
from plex_api_client.types import BaseModel from plex_api_client.types import BaseModel
from plex_api_client.utils import FieldMetadata, SecurityMetadata from plex_api_client.utils import FieldMetadata, SecurityMetadata
from typing import Optional, TypedDict from typing import Optional
from typing_extensions import Annotated, NotRequired from typing_extensions import Annotated, NotRequired, TypedDict
class SecurityTypedDict(TypedDict): class SecurityTypedDict(TypedDict):

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