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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.542.0

Browse Source
This commit is contained in:
speakeasybot
2025-05-02 00:02:48 +00:00
parent f6273102ed
commit ec4c92a1a4
37 changed files with 1295 additions and 852 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@@ -1,3 +1,5 @@
**/.speakeasy/temp/
**/.speakeasy/logs/
.speakeasy/reports
.venv/
pyrightconfig.json

28
.speakeasy/gen.lock
View File

File diff suppressed because one or more lines are too long

4
.speakeasy/gen.yaml
View File

@@ -11,11 +11,12 @@ generation:
parameterOrderingFeb2024: true
requestResponseComponentNamesFeb2024: true
securityFeb2025: false
sharedErrorComponentsApr2025: false
auth:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
python:
version: 0.26.0
version: 0.27.0
additionalDependencies:
dev: {}
main: {}
@@ -43,6 +44,7 @@ python:
inputModelSuffix: input
maxMethodParams: 4
methodArguments: require-security-and-request
moduleName: ""
outputModelSuffix: output
packageName: plex-api-client
projectUrls: {}

14
.speakeasy/workflow.lock
View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.535.1
speakeasyVersion: 1.542.0
sources:
my-source:
sourceNamespace: my-source
@@ -8,19 +8,19 @@ sources:
- latest
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:b2f9599237ceb13cf8f9c1693e38b290177b65fb389cebf0c3c60b8ef4778615
sourceBlobDigest: sha256:f8df9ef88ada992cd981d601e6c0b45cc82db76aba3d915c2f9d08f90c81ced9
sourceRevisionDigest: sha256:31ab7b2e65ccf1e0349bcd8b35791d1ce80091313481874749163fc0c80fd8ed
sourceBlobDigest: sha256:d971fff9723c626fe70403a2a83d813c396a20b06ccd6b899263762038cfdbb0
tags:
- latest
- speakeasy-sdk-regen-1745107281
- speakeasy-sdk-regen-1746144091
targets:
plexpy:
source: plexapi
sourceNamespace: plexapi
sourceRevisionDigest: sha256:b2f9599237ceb13cf8f9c1693e38b290177b65fb389cebf0c3c60b8ef4778615
sourceBlobDigest: sha256:f8df9ef88ada992cd981d601e6c0b45cc82db76aba3d915c2f9d08f90c81ced9
sourceRevisionDigest: sha256:31ab7b2e65ccf1e0349bcd8b35791d1ce80091313481874749163fc0c80fd8ed
sourceBlobDigest: sha256:d971fff9723c626fe70403a2a83d813c396a20b06ccd6b899263762038cfdbb0
codeSamplesNamespace: code-samples-python-plexpy
codeSamplesRevisionDigest: sha256:f8411618a6aad7b5f6551648ed1e29639c1e0245618ed12233d2abf42a8f5122
codeSamplesRevisionDigest: sha256:647c4ac7b5139ce5ac47fd90eb5845242a98f693627233caed79fa992350c80a
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest

12
RELEASES.md
View File

@@ -1018,4 +1018,14 @@ Based on:
### Generated
- [python v0.26.0] .
### Releases
- [PyPI v0.26.0] https://pypi.org/project/plex-api-client/0.26.0 - .
- [PyPI v0.26.0] https://pypi.org/project/plex-api-client/0.26.0 - .
## 2025-05-02 00:01:14
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.542.0 (2.596.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v0.27.0] .
### Releases
- [PyPI v0.27.0] https://pypi.org/project/plex-api-client/0.27.0 - .

214
codeSamples.yaml
View File

@@ -9,7 +9,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -28,7 +28,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -47,7 +47,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -66,7 +66,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -85,8 +85,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -116,7 +116,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -135,7 +135,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -154,7 +154,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -173,7 +173,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -192,7 +192,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -211,7 +211,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -230,8 +230,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -250,8 +250,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -270,7 +270,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -289,7 +289,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -308,7 +308,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -327,7 +327,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -346,7 +346,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI() as plex_api:
@@ -363,7 +363,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -382,7 +382,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -401,8 +401,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -425,7 +425,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -444,7 +444,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -463,7 +463,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -482,7 +482,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI() as plex_api:
@@ -499,8 +499,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -519,7 +519,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -538,7 +538,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -572,7 +572,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -591,7 +591,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -610,7 +610,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -636,7 +636,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -655,7 +655,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -674,7 +674,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -693,7 +693,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -719,8 +719,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -757,8 +757,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -783,7 +783,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -802,8 +802,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -825,7 +825,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -844,7 +844,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -863,8 +863,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -883,8 +883,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -906,8 +906,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -926,8 +926,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -946,8 +946,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -966,8 +966,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -986,8 +986,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -1010,8 +1010,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -1030,7 +1030,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1051,7 +1051,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1070,7 +1070,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1089,7 +1089,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1108,8 +1108,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -1136,7 +1136,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI() as plex_api:
@@ -1159,7 +1159,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI() as plex_api:
@@ -1183,7 +1183,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1202,8 +1202,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -1227,8 +1227,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -1247,7 +1247,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1266,7 +1266,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1285,7 +1285,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1304,7 +1304,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1323,8 +1323,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -1343,7 +1343,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1362,7 +1362,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1381,7 +1381,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1400,7 +1400,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1419,8 +1419,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -1439,7 +1439,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1458,7 +1458,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1477,7 +1477,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1496,7 +1496,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1515,7 +1515,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1534,7 +1534,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1553,7 +1553,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1572,7 +1572,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1591,8 +1591,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -1611,8 +1611,8 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
from import PlexAPI
from .models import operations
with PlexAPI(
@@ -1631,7 +1631,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1650,7 +1650,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(
@@ -1669,7 +1669,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI() as plex_api:
@@ -1700,7 +1700,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI() as plex_api:
@@ -1728,7 +1728,7 @@ actions:
- lang: python
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from import PlexAPI
with PlexAPI(

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

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

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

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

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

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

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

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

16
docs/models/operations/getallmedialibrarystreamtype.md Normal file
View File

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

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

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

15
docs/models/operations/getmediametadatadirector.md
View File

@@ -3,11 +3,10 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique role identifier. | 109501 |
| `filter_` | *str* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
| `tag` | *str* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
| `tag_key` | *str* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
| `role` | *Optional[str]* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
| `tag` | *str* | :heavy_check_mark: | The role of Director | Danny Boyle |
| `filter_` | *str* | :heavy_check_mark: | The filter string used to query this director. | director=235876 |
| `tag_key` | *Optional[str]* | :heavy_minus_sign: | A unique key associated with the director's tag, used for internal identification. | 5d776831151a60001f24d031 |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |

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

@@ -1,10 +1,12 @@
# GetMediaMetaDataGenre
The filter query string for similar items.
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique genre identifier. | 1057 |
| `filter_` | *str* | :heavy_check_mark: | The filter string for the genre. | genre=1057 |
| `tag` | *str* | :heavy_check_mark: | The genre name. | Crime |
| Field | Type | Required | Description | Example |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 259 |
| `tag` | *str* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
| `filter_` | *str* | :heavy_check_mark: | N/A | genre=19 |

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

@@ -3,8 +3,8 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| `alt` | *str* | :heavy_check_mark: | Alternate text for the image. | Better Call Saul |
| `type` | *str* | :heavy_check_mark: | The type of image (e.g., coverPoster, background, clearLogo). | coverPoster |
| `url` | *str* | :heavy_check_mark: | The URL of the image. | /library/metadata/44288/thumb/1736487993 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `alt` | *str* | :heavy_check_mark: | N/A | Episode 1 |
| `type` | [operations.GetMediaMetaDataLibraryType](../../models/operations/getmediametadatalibrarytype.md) | :heavy_check_mark: | N/A | background |
| `url` | *str* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |

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

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

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

@@ -1,68 +1,83 @@
# GetMediaMetaDataMetadata
Unknown
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rating_key` | *str* | :heavy_check_mark: | The rating key of the metadata item. | 44288 |
| `parent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the parent of this metadata item. | 48047 |
| `grandparent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the grandparent of this metadata item. | 45520 |
| `parent_guid` | *Optional[str]* | :heavy_minus_sign: | A GUID identifying the parent entity (e.g., season) for the item. | plex://season/618b89208dde18df707ad15c |
| `grandparent_guid` | *Optional[str]* | :heavy_minus_sign: | A GUID identifying the grandparent entity (e.g., show). | plex://show/5e16253691c20300412003a8 |
| `grandparent_slug` | *Optional[str]* | :heavy_minus_sign: | A URL-friendly identifier (slug) for the grandparent entity. | alice-in-borderland-2020 |
| `grandparent_key` | *Optional[str]* | :heavy_minus_sign: | A key identifying the grandparent metadata in the library. | /library/metadata/45520 |
| `parent_key` | *Optional[str]* | :heavy_minus_sign: | A key identifying the parent metadata in the library. | /library/metadata/48047 |
| `key` | *str* | :heavy_check_mark: | The API key to access metadata details. | /library/metadata/44288/children |
| `guid` | *str* | :heavy_check_mark: | The globally unique identifier for the item. | plex://show/5d9c08254eefaa001f5d6dcb |
| `slug` | *Optional[str]* | :heavy_minus_sign: | A URL-friendly identifier for the item. | better-call-saul |
| `studio` | *Optional[str]* | :heavy_minus_sign: | The studio that produced the content. | Sony Pictures Television |
| `type` | *str* | :heavy_check_mark: | The type of content (e.g., show, movie). | show |
| `title` | *str* | :heavy_check_mark: | The title of the content. | Better Call Saul |
| `original_title` | *Optional[str]* | :heavy_minus_sign: | The original title of the content. | Wicked: Part I |
| `library_section_title` | *str* | :heavy_check_mark: | The title of the library section. | TV Series |
| `library_section_id` | *int* | :heavy_check_mark: | The ID of the library section. | 2 |
| `library_section_key` | *str* | :heavy_check_mark: | The key of the library section. | /library/sections/2 |
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | The content rating (e.g., TV-MA). | TV-MA |
| `summary` | *str* | :heavy_check_mark: | A summary of the content. | Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to "Breaking Bad" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman. |
| `index` | *Optional[int]* | :heavy_minus_sign: | The index or order of the item. | 1 |
| `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | The title of the grandparent entity (typically the show's title). | Alice in Borderland |
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | The title of the parent entity (typically the season's title). | Season 2 |
| `audience_rating` | *Optional[float]* | :heavy_minus_sign: | The audience rating for the content. | 8.7 |
| `view_count` | *Optional[int]* | :heavy_minus_sign: | The number of times the item has been viewed. | 4 |
| `skip_count` | *Optional[int]* | :heavy_minus_sign: | The number of times the item has been skipped. | 1 |
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp of when the item was last viewed. | 1625764795 |
| `year` | *int* | :heavy_check_mark: | The release year. | 2015 |
| `rating` | *Optional[float]* | :heavy_minus_sign: | The general rating | 6 |
| `rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL or identifier for the rating image (e.g., Rotten Tomatoes rating image). | rottentomatoes://image.rating.ripe |
| `tagline` | *Optional[str]* | :heavy_minus_sign: | The tagline of the content. | Make the call |
| `chapter_source` | *Optional[str]* | :heavy_minus_sign: | N/A | media |
| `primary_extra_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/134704 |
| `thumb` | *str* | :heavy_check_mark: | URL of the thumbnail image. | /library/metadata/44288/thumb/1736487993 |
| `art` | *str* | :heavy_check_mark: | URL of the art image. | /library/metadata/44288/art/1736487993 |
| `theme` | *Optional[str]* | :heavy_minus_sign: | URL of the theme image. | /library/metadata/44288/theme/1736487993 |
| `duration` | *int* | :heavy_check_mark: | Duration of the content in milliseconds. | 2700000 |
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The original release date. | 2015-02-08 |
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | The total number of episodes (or leaves). | 63 |
| `viewed_leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of episodes that have been viewed. | 4 |
| `child_count` | *Optional[int]* | :heavy_minus_sign: | The number of child items. | 6 |
| `added_at` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `updated_at` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the audience rating image. | themoviedb://image.rating |
| `parent_index` | *Optional[int]* | :heavy_minus_sign: | The index number of the parent entity, which could indicate its order or position. | 2 |
| `parent_thumb` | *Optional[str]* | :heavy_minus_sign: | The URL of the parent's thumbnail image. | /library/metadata/48047/thumb/1671800243 |
| `grandparent_thumb` | *Optional[str]* | :heavy_minus_sign: | The URL of the grandparent's thumbnail image. | /library/metadata/45520/thumb/1736488003 |
| `grandparent_art` | *Optional[str]* | :heavy_minus_sign: | The URL of the grandparent's art image. | /library/metadata/45520/art/1736488003 |
| `media` | List[[operations.GetMediaMetaDataMedia](../../models/operations/getmediametadatamedia.md)] | :heavy_minus_sign: | N/A | |
| `image` | List[[operations.GetMediaMetaDataImage](../../models/operations/getmediametadataimage.md)] | :heavy_check_mark: | An array of image objects. | |
| `ultra_blur_colors` | [operations.GetMediaMetaDataUltraBlurColors](../../models/operations/getmediametadataultrablurcolors.md) | :heavy_check_mark: | N/A | |
| `genre` | List[[operations.GetMediaMetaDataGenre](../../models/operations/getmediametadatagenre.md)] | :heavy_minus_sign: | An array of genre tags. | |
| `country` | List[[operations.GetMediaMetaDataCountry](../../models/operations/getmediametadatacountry.md)] | :heavy_minus_sign: | An array of country tags. | |
| `guids` | List[[operations.GetMediaMetaDataGuids](../../models/operations/getmediametadataguids.md)] | :heavy_minus_sign: | An array of GUID objects. | |
| `ratings` | List[[operations.Ratings](../../models/operations/ratings.md)] | :heavy_minus_sign: | An array of rating objects. | |
| `role` | List[[operations.GetMediaMetaDataRole](../../models/operations/getmediametadatarole.md)] | :heavy_minus_sign: | An array of Actor roles. | |
| `director` | List[[operations.GetMediaMetaDataDirector](../../models/operations/getmediametadatadirector.md)] | :heavy_minus_sign: | An array of Director roles. | |
| `writer` | List[[operations.GetMediaMetaDataWriter](../../models/operations/getmediametadatawriter.md)] | :heavy_minus_sign: | An array of Writer roles. | |
| `producer` | List[[operations.GetMediaMetaDataProducer](../../models/operations/getmediametadataproducer.md)] | :heavy_minus_sign: | An array of Writer roles. | |
| `similar` | List[[operations.GetMediaMetaDataSimilar](../../models/operations/getmediametadatasimilar.md)] | :heavy_minus_sign: | An array of similar content objects. | |
| `location` | List[[operations.GetMediaMetaDataLocation](../../models/operations/getmediametadatalocation.md)] | :heavy_minus_sign: | An array of location objects. | |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rating_key` | *str* | :heavy_check_mark: | The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. | 58683 |
| `key` | *str* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
| `guid` | *str* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
| `slug` | *str* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
| `studio` | *Optional[str]* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `type` | [operations.GetMediaMetaDataType](../../models/operations/getmediametadatatype.md) | :heavy_check_mark: | N/A | movie |
| `title` | *str* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
| `title_sort` | *str* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
| `summary` | *str* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
| `rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
| `audience_rating` | *float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `year` | *Optional[int]* | :heavy_minus_sign: | The release year of the media item. | 2022 |
| `tagline` | *str* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
| `thumb` | *str* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
| `art` | *str* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
| `theme` | *str* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
| `index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `viewed_leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
| `child_count` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
| `season_count` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
| `added_at` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
| `chapter_source` | *Optional[str]* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
| `primary_extra_key` | *Optional[str]* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
| `original_title` | *Optional[str]* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
| `parent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
| `grandparent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
| `parent_guid` | *Optional[str]* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparent_guid` | *Optional[str]* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparent_slug` | *Optional[str]* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
| `grandparent_key` | *Optional[str]* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
| `parent_key` | *Optional[str]* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
| `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
| `grandparent_thumb` | *Optional[str]* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
| `grandparent_theme` | *Optional[str]* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
| `grandparent_art` | *Optional[str]* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
| `parent_index` | *Optional[int]* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
| `parent_thumb` | *Optional[str]* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
| `rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
| `view_count` | *Optional[int]* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
| `view_offset` | *Optional[int]* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
| `skip_count` | *Optional[int]* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
| `subtype` | *Optional[str]* | :heavy_minus_sign: | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
| `last_rated_at` | *Optional[int]* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
| `created_at_accuracy` | *Optional[str]* | :heavy_minus_sign: | The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). | epoch,local |
| `created_at_tz_offset` | *Optional[str]* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
| `user_rating` | *Optional[float]* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
| `image` | List[[operations.GetMediaMetaDataImage](../../models/operations/getmediametadataimage.md)] | :heavy_minus_sign: | N/A | |
| `ultra_blur_colors` | [Optional[operations.GetMediaMetaDataUltraBlurColors]](../../models/operations/getmediametadataultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `library_section_id` | *int* | :heavy_check_mark: | The identifier for the library section. | 1 |
| `library_section_title` | *str* | :heavy_check_mark: | The title of the library section. | Movies |
| `library_section_key` | *str* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
| `media` | List[[operations.GetMediaMetaDataMedia](../../models/operations/getmediametadatamedia.md)] | :heavy_minus_sign: | N/A | |
| `genre` | List[[operations.GetMediaMetaDataGenre](../../models/operations/getmediametadatagenre.md)] | :heavy_minus_sign: | N/A | |
| `country` | List[[operations.GetMediaMetaDataCountry](../../models/operations/getmediametadatacountry.md)] | :heavy_minus_sign: | N/A | |
| `director` | List[[operations.GetMediaMetaDataDirector](../../models/operations/getmediametadatadirector.md)] | :heavy_minus_sign: | N/A | |
| `writer` | List[[operations.GetMediaMetaDataWriter](../../models/operations/getmediametadatawriter.md)] | :heavy_minus_sign: | N/A | |
| `producer` | List[[operations.GetMediaMetaDataProducer](../../models/operations/getmediametadataproducer.md)] | :heavy_minus_sign: | N/A | |
| `role` | List[[operations.GetMediaMetaDataRole](../../models/operations/getmediametadatarole.md)] | :heavy_minus_sign: | N/A | |
| `guids` | List[[operations.GetMediaMetaDataGuids](../../models/operations/getmediametadataguids.md)] | :heavy_minus_sign: | N/A | |
| `ratings` | List[[operations.Ratings](../../models/operations/ratings.md)] | :heavy_minus_sign: | N/A | |
| `similar` | List[[operations.GetMediaMetaDataSimilar](../../models/operations/getmediametadatasimilar.md)] | :heavy_minus_sign: | N/A | |
| `location` | List[[operations.GetMediaMetaDataLocation](../../models/operations/getmediametadatalocation.md)] | :heavy_minus_sign: | N/A | |
| `chapter` | List[[operations.Chapter](../../models/operations/chapter.md)] | :heavy_minus_sign: | N/A | |
| `marker` | List[[operations.Marker](../../models/operations/marker.md)] | :heavy_minus_sign: | N/A | |
| `extras` | [Optional[operations.Extras]](../../models/operations/extras.md) | :heavy_minus_sign: | N/A | |

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

@@ -3,11 +3,11 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique role identifier. | 109501 |
| `filter_` | *str* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
| `tag` | *str* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
| `tag_key` | *str* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
| `role` | *Optional[str]* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique identifier for the actor or role. | 126522 |
| `tag` | *str* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
| `role` | *Optional[str]* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
| `filter_` | *str* | :heavy_check_mark: | The filter string used to query this actor. For example, it may indicate that this is an actor with a given key. | actor=126522 |
| `tag_key` | *Optional[str]* | :heavy_minus_sign: | A unique key associated with the actor's tag, used for internal identification. | 5d77683d85719b001f3a535e |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |

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

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

16
docs/models/operations/getmediametadatastreamtype.md Normal file
View File

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

16
docs/models/operations/getmediametadatatype.md Normal file
View File

@@ -0,0 +1,16 @@
# GetMediaMetaDataType
The type of media content
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | movie |
| `TV_SHOW` | show |
| `SEASON` | season |
| `EPISODE` | episode |
| `ARTIST` | artist |
| `ALBUM` | album |

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

@@ -3,9 +3,9 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
| `top_left` | *str* | :heavy_check_mark: | The top-left color value. | 11333a |
| `top_right` | *str* | :heavy_check_mark: | The top-right color value. | 1d2721 |
| `bottom_right` | *str* | :heavy_check_mark: | The bottom-right color value. | 5c451d |
| `bottom_left` | *str* | :heavy_check_mark: | The bottom-left color value. | 372c10 |
| 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 |

15
docs/models/operations/getmediametadatawriter.md
View File

@@ -3,11 +3,10 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique role identifier. | 109501 |
| `filter_` | *str* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
| `tag` | *str* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
| `tag_key` | *str* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
| `role` | *Optional[str]* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
| `tag` | *str* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
| `filter_` | *str* | :heavy_check_mark: | The filter string used to query this writer. | writer=126522 |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The URL of the thumbnail image for the writer. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
| `tag_key` | *Optional[str]* | :heavy_minus_sign: | A unique key associated with the writers tag, used for internal identification. | 5d77683d85719b001f3a535e |

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

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

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

@@ -6,10 +6,11 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `stream_type` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
| `stream_type` | [operations.StreamType](../../models/operations/streamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
| `format_` | *Optional[str]* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `codec` | *str* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
| `index` | *Optional[int]* | :heavy_minus_sign: | Index of the stream. | 0 |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `language` | *Optional[str]* | :heavy_minus_sign: | Language of the stream. | English |
| `language_tag` | *Optional[str]* | :heavy_minus_sign: | Language tag (e.g., en). | en |
@@ -34,6 +35,7 @@
| `color_space` | *Optional[str]* | :heavy_minus_sign: | Color space. | bt2020nc |
| `color_trc` | *Optional[str]* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
| `frame_rate` | *Optional[float]* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
| `key` | *Optional[str]* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
| `height` | *Optional[int]* | :heavy_minus_sign: | Height of the video stream. | 1602 |
| `level` | *Optional[int]* | :heavy_minus_sign: | Video level. | 150 |
| `original` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this is the original stream. | true |

16
docs/models/operations/streamtype.md Normal file
View File

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

56
poetry.lock generated
View File

@@ -91,21 +91,6 @@ files = [
graph = ["objgraph (>=1.7.2)"]
profile = ["gprof2dot (>=2022.7.29)"]
[[package]]
name = "eval-type-backport"
version = "0.2.0"
description = "Like `typing._eval_type`, but lets older Python versions use newer typing features."
optional = false
python-versions = ">=3.8"
groups = ["main"]
files = [
{file = "eval_type_backport-0.2.0-py3-none-any.whl", hash = "sha256:ac2f73d30d40c5a30a80b8739a789d6bb5e49fdffa66d7912667e2015d9c9933"},
{file = "eval_type_backport-0.2.0.tar.gz", hash = "sha256:68796cfbc7371ebf923f03bdf7bef415f3ec098aeced24e054b253a0e78f7b37"},
]
[package.extras]
tests = ["pytest"]
[[package]]
name = "exceptiongroup"
version = "1.2.2"
@@ -468,33 +453,6 @@ typing-extensions = {version = ">=3.10.0", markers = "python_version < \"3.10\""
spelling = ["pyenchant (>=3.2,<4.0)"]
testutils = ["gitpython (>3)"]
[[package]]
name = "python-dateutil"
version = "2.8.2"
description = "Extensions to the standard Python datetime module"
optional = false
python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7"
groups = ["main"]
files = [
{file = "python-dateutil-2.8.2.tar.gz", hash = "sha256:0123cacc1627ae19ddf3c27a5de5bd67ee4586fbdd6440d9748f8abb483d3e86"},
{file = "python_dateutil-2.8.2-py2.py3-none-any.whl", hash = "sha256:961d03dc3453ebbc59dbdea9e4e11c5651520a876d0f4db161e8674aae935da9"},
]
[package.dependencies]
six = ">=1.5"
[[package]]
name = "six"
version = "1.16.0"
description = "Python 2 and 3 compatibility utilities"
optional = false
python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*"
groups = ["main"]
files = [
{file = "six-1.16.0-py2.py3-none-any.whl", hash = "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"},
{file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"},
]
[[package]]
name = "sniffio"
version = "1.3.1"
@@ -532,18 +490,6 @@ files = [
{file = "tomlkit-0.13.2.tar.gz", hash = "sha256:fff5fe59a87295b278abd31bec92c15d9bc4a06885ab12bcea52c71119392e79"},
]
[[package]]
name = "types-python-dateutil"
version = "2.9.0.20240906"
description = "Typing stubs for python-dateutil"
optional = false
python-versions = ">=3.8"
groups = ["dev"]
files = [
{file = "types-python-dateutil-2.9.0.20240906.tar.gz", hash = "sha256:9706c3b68284c25adffc47319ecc7947e5bb86b3773f843c73906fd598bc176e"},
{file = "types_python_dateutil-2.9.0.20240906-py3-none-any.whl", hash = "sha256:27c8cc2d058ccb14946eebcaaa503088f4f6dbc4fb6093d3d456a49aef2753f6"},
]
[[package]]
name = "typing-extensions"
version = "4.12.2"
@@ -574,4 +520,4 @@ typing-extensions = ">=4.12.0"
[metadata]
lock-version = "2.1"
python-versions = ">=3.9"
content-hash = "b570ca677752265a850b31a31cd31f8424bc1c8631eaffe4593a0eef62528131"
content-hash = "6354f0f1856076ab30608ac13a9b2c92427e32d83253a3a3801e1919bb853282"

6
pyproject.toml
View File

@@ -1,16 +1,13 @@
[project]
name = "plex-api-client"
version = "0.26.0"
version = "0.27.0"
description = "Python Client SDK Generated by Speakeasy"
authors = [{ name = "Speakeasy" },]
readme = "README-PYPI.md"
requires-python = ">=3.9"
dependencies = [
"eval-type-backport >=0.2.0",
"httpx >=0.28.1",
"pydantic >=2.11.2",
"python-dateutil >=2.8.2",
"typing-inspection >=0.4.0",
]
[tool.poetry]
@@ -29,7 +26,6 @@ in-project = true
[tool.poetry.group.dev.dependencies]
mypy = "==1.15.0"
pylint = "==3.2.3"
types-python-dateutil = "^2.9.0.20240316"
[build-system]
requires = ["poetry-core"]

6
src/plex_api_client/_version.py
View File

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

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

@@ -150,6 +150,7 @@ from .get_all_media_library import (
GetAllMediaLibrarySort,
GetAllMediaLibrarySortTypedDict,
GetAllMediaLibraryStream,
GetAllMediaLibraryStreamType,
GetAllMediaLibraryStreamTypedDict,
GetAllMediaLibraryType,
GetAllMediaLibraryTypeTypedDict,
@@ -315,6 +316,12 @@ from .get_media_arts import (
GetMediaArtsResponseTypedDict,
)
from .get_media_meta_data import (
Attributes,
AttributesTypedDict,
Chapter,
ChapterTypedDict,
Extras,
ExtrasTypedDict,
GetMediaMetaDataCountry,
GetMediaMetaDataCountryTypedDict,
GetMediaMetaDataDirector,
@@ -328,6 +335,7 @@ from .get_media_meta_data import (
GetMediaMetaDataImageTypedDict,
GetMediaMetaDataLibraryOptimizedForStreaming,
GetMediaMetaDataLibraryOptimizedForStreamingTypedDict,
GetMediaMetaDataLibraryType,
GetMediaMetaDataLocation,
GetMediaMetaDataLocationTypedDict,
GetMediaMetaDataMedia,
@@ -355,11 +363,15 @@ from .get_media_meta_data import (
GetMediaMetaDataSimilar,
GetMediaMetaDataSimilarTypedDict,
GetMediaMetaDataStream,
GetMediaMetaDataStreamType,
GetMediaMetaDataStreamTypedDict,
GetMediaMetaDataType,
GetMediaMetaDataUltraBlurColors,
GetMediaMetaDataUltraBlurColorsTypedDict,
GetMediaMetaDataWriter,
GetMediaMetaDataWriterTypedDict,
Marker,
MarkerTypedDict,
Ratings,
RatingsTypedDict,
)
@@ -459,6 +471,7 @@ from .get_recently_added import (
Similar,
SimilarTypedDict,
Stream,
StreamType,
StreamTypedDict,
Type,
UltraBlurColors,
@@ -1266,6 +1279,8 @@ __all__ = [
"ApplyUpdatesRequestTypedDict",
"ApplyUpdatesResponse",
"ApplyUpdatesResponseTypedDict",
"Attributes",
"AttributesTypedDict",
"AutoSelectSubtitle",
"Billing",
"BillingTypedDict",
@@ -1277,6 +1292,8 @@ __all__ = [
"CancelServerActivitiesRequestTypedDict",
"CancelServerActivitiesResponse",
"CancelServerActivitiesResponseTypedDict",
"Chapter",
"ChapterTypedDict",
"CheckForUpdatesRequest",
"CheckForUpdatesRequestTypedDict",
"CheckForUpdatesResponse",
@@ -1326,6 +1343,8 @@ __all__ = [
"EnablePaperTrailResponse",
"EnablePaperTrailResponseTypedDict",
"EpisodeSort",
"Extras",
"ExtrasTypedDict",
"Feature",
"FeatureTypedDict",
"FieldT",
@@ -1425,6 +1444,7 @@ __all__ = [
"GetAllMediaLibrarySort",
"GetAllMediaLibrarySortTypedDict",
"GetAllMediaLibraryStream",
"GetAllMediaLibraryStreamType",
"GetAllMediaLibraryStreamTypedDict",
"GetAllMediaLibraryType",
"GetAllMediaLibraryTypeTypedDict",
@@ -1651,6 +1671,7 @@ __all__ = [
"GetMediaMetaDataImageTypedDict",
"GetMediaMetaDataLibraryOptimizedForStreaming",
"GetMediaMetaDataLibraryOptimizedForStreamingTypedDict",
"GetMediaMetaDataLibraryType",
"GetMediaMetaDataLocation",
"GetMediaMetaDataLocationTypedDict",
"GetMediaMetaDataMedia",
@@ -1678,7 +1699,9 @@ __all__ = [
"GetMediaMetaDataSimilar",
"GetMediaMetaDataSimilarTypedDict",
"GetMediaMetaDataStream",
"GetMediaMetaDataStreamType",
"GetMediaMetaDataStreamTypedDict",
"GetMediaMetaDataType",
"GetMediaMetaDataUltraBlurColors",
"GetMediaMetaDataUltraBlurColorsTypedDict",
"GetMediaMetaDataWriter",
@@ -2122,6 +2145,8 @@ __all__ = [
"MarkUnplayedRequestTypedDict",
"MarkUnplayedResponse",
"MarkUnplayedResponseTypedDict",
"Marker",
"MarkerTypedDict",
"Media",
"MediaContainer",
"MediaContainerTypedDict",
@@ -2283,6 +2308,7 @@ __all__ = [
"StopTranscodeSessionResponse",
"StopTranscodeSessionResponseTypedDict",
"Stream",
"StreamType",
"StreamTypedDict",
"Subscription",
"SubscriptionTypedDict",

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

@@ -467,21 +467,41 @@ class GetAllMediaLibraryHasThumbnail(str, Enum):
TRUE = "1"
class GetAllMediaLibraryStreamType(int, Enum, metaclass=utils.OpenEnumMeta):
r"""Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
"""
VIDEO = 1
AUDIO = 2
SUBTITLE = 3
class GetAllMediaLibraryStreamTypedDict(TypedDict):
id: int
r"""Unique stream identifier."""
stream_type: int
r"""Stream type (1=video, 2=audio, 3=subtitle)."""
stream_type: GetAllMediaLibraryStreamType
r"""Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
"""
codec: str
r"""Codec used by the stream."""
index: int
r"""Index of the stream."""
display_title: str
r"""Display title for the stream."""
extended_display_title: str
r"""Extended display title for the stream."""
format_: NotRequired[str]
r"""Format of the stream (e.g., srt)."""
default: NotRequired[bool]
r"""Indicates if this stream is default."""
index: NotRequired[int]
r"""Index of the stream."""
bitrate: NotRequired[int]
r"""Bitrate of the stream."""
language: NotRequired[str]
@@ -529,6 +549,8 @@ class GetAllMediaLibraryStreamTypedDict(TypedDict):
r"""Color transfer characteristics."""
frame_rate: NotRequired[float]
r"""Frame rate of the stream."""
key: NotRequired[str]
r"""Key to access this stream part."""
height: NotRequired[int]
r"""Height of the video stream."""
level: NotRequired[int]
@@ -567,24 +589,37 @@ class GetAllMediaLibraryStream(BaseModel):
id: int
r"""Unique stream identifier."""
stream_type: Annotated[int, pydantic.Field(alias="streamType")]
r"""Stream type (1=video, 2=audio, 3=subtitle)."""
stream_type: Annotated[
Annotated[
GetAllMediaLibraryStreamType, PlainValidator(validate_open_enum(True))
],
pydantic.Field(alias="streamType"),
]
r"""Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
"""
codec: str
r"""Codec used by the stream."""
index: int
r"""Index of the stream."""
display_title: Annotated[str, pydantic.Field(alias="displayTitle")]
r"""Display title for the stream."""
extended_display_title: Annotated[str, pydantic.Field(alias="extendedDisplayTitle")]
r"""Extended display title for the stream."""
format_: Annotated[Optional[str], pydantic.Field(alias="format")] = None
r"""Format of the stream (e.g., srt)."""
default: Optional[bool] = None
r"""Indicates if this stream is default."""
index: Optional[int] = None
r"""Index of the stream."""
bitrate: Optional[int] = None
r"""Bitrate of the stream."""
@@ -674,6 +709,9 @@ class GetAllMediaLibraryStream(BaseModel):
frame_rate: Annotated[Optional[float], pydantic.Field(alias="frameRate")] = None
r"""Frame rate of the stream."""
key: Optional[str] = None
r"""Key to access this stream part."""
height: Optional[int] = None
r"""Height of the video stream."""

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

File diff suppressed because it is too large Load Diff

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

@@ -413,21 +413,41 @@ class HasThumbnail(str, Enum):
TRUE = "1"
class StreamType(int, Enum, metaclass=utils.OpenEnumMeta):
r"""Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
"""
VIDEO = 1
AUDIO = 2
SUBTITLE = 3
class StreamTypedDict(TypedDict):
id: int
r"""Unique stream identifier."""
stream_type: int
r"""Stream type (1=video, 2=audio, 3=subtitle)."""
stream_type: StreamType
r"""Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
"""
codec: str
r"""Codec used by the stream."""
index: int
r"""Index of the stream."""
display_title: str
r"""Display title for the stream."""
extended_display_title: str
r"""Extended display title for the stream."""
format_: NotRequired[str]
r"""Format of the stream (e.g., srt)."""
default: NotRequired[bool]
r"""Indicates if this stream is default."""
index: NotRequired[int]
r"""Index of the stream."""
bitrate: NotRequired[int]
r"""Bitrate of the stream."""
language: NotRequired[str]
@@ -475,6 +495,8 @@ class StreamTypedDict(TypedDict):
r"""Color transfer characteristics."""
frame_rate: NotRequired[float]
r"""Frame rate of the stream."""
key: NotRequired[str]
r"""Key to access this stream part."""
height: NotRequired[int]
r"""Height of the video stream."""
level: NotRequired[int]
@@ -513,24 +535,35 @@ class Stream(BaseModel):
id: int
r"""Unique stream identifier."""
stream_type: Annotated[int, pydantic.Field(alias="streamType")]
r"""Stream type (1=video, 2=audio, 3=subtitle)."""
stream_type: Annotated[
Annotated[StreamType, PlainValidator(validate_open_enum(True))],
pydantic.Field(alias="streamType"),
]
r"""Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
"""
codec: str
r"""Codec used by the stream."""
index: int
r"""Index of the stream."""
display_title: Annotated[str, pydantic.Field(alias="displayTitle")]
r"""Display title for the stream."""
extended_display_title: Annotated[str, pydantic.Field(alias="extendedDisplayTitle")]
r"""Extended display title for the stream."""
format_: Annotated[Optional[str], pydantic.Field(alias="format")] = None
r"""Format of the stream (e.g., srt)."""
default: Optional[bool] = None
r"""Indicates if this stream is default."""
index: Optional[int] = None
r"""Index of the stream."""
bitrate: Optional[int] = None
r"""Bitrate of the stream."""
@@ -620,6 +653,9 @@ class Stream(BaseModel):
frame_rate: Annotated[Optional[float], pydantic.Field(alias="frameRate")] = None
r"""Frame rate of the stream."""
key: Optional[str] = None
r"""Key to access this stream part."""
height: Optional[int] = None
r"""Height of the video stream."""

2
src/plex_api_client/sdkconfiguration.py
View File

@@ -18,7 +18,7 @@ from typing import Callable, Dict, List, Optional, Tuple, Union
SERVERS = [
"https://10.10.10.47:32400",
"{protocol}://{ip}:{port}",
# The full address of your Plex Server
]
"""Contains the list of servers available to the SDK"""

1
src/plex_api_client/utils/__init__.py
View File

@@ -1,6 +1,7 @@
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
from .annotations import get_discriminator
from .datetimes import parse_datetime
from .enums import OpenEnumMeta
from .headers import get_headers, get_response_headers
from .metadata import (

23
src/plex_api_client/utils/datetimes.py Normal file
View File

@@ -0,0 +1,23 @@
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
from datetime import datetime
import sys
def parse_datetime(datetime_string: str) -> datetime:
"""
Convert a RFC 3339 / ISO 8601 formatted string into a datetime object.
Python versions 3.11 and later support parsing RFC 3339 directly with
datetime.fromisoformat(), but for earlier versions, this function
encapsulates the necessary extra logic.
"""
# Python 3.11 and later can parse RFC 3339 directly
if sys.version_info >= (3, 11):
return datetime.fromisoformat(datetime_string)
# For Python 3.10 and earlier, a common ValueError is trailing 'Z' suffix,
# so fix that upfront.
if datetime_string.endswith("Z"):
datetime_string = datetime_string[:-1] + "+00:00"
return datetime.fromisoformat(datetime_string)

35
src/plex_api_client/utils/serializers.py
View File

@@ -1,13 +1,16 @@
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
from decimal import Decimal
import functools
import json
from typing import Any, Dict, List, Union, get_args
import httpx
import typing
from typing import Any, Dict, List, Tuple, Union, get_args
import typing_extensions
from typing_extensions import get_origin
import httpx
from pydantic import ConfigDict, create_model
from pydantic_core import from_json
from typing_inspection.typing_objects import is_union
from ..types.basemodel import BaseModel, Nullable, OptionalNullable, Unset
@@ -185,6 +188,13 @@ def is_nullable(field):
return False
def is_union(obj: object) -> bool:
"""
Returns True if the given object is a typing.Union or typing_extensions.Union.
"""
return any(obj is typing_obj for typing_obj in _get_typing_objects_by_name_of("Union"))
def stream_to_text(stream: httpx.Response) -> str:
return "".join(stream.iter_text())
@@ -217,3 +227,22 @@ def _contains_pydantic_model(data: Any) -> bool:
return any(_contains_pydantic_model(value) for value in data.values())
return False
@functools.cache
def _get_typing_objects_by_name_of(name: str) -> Tuple[Any, ...]:
"""
Get typing objects by name from typing and typing_extensions.
Reference: https://typing-extensions.readthedocs.io/en/latest/#runtime-use-of-types
"""
result = tuple(
getattr(module, name)
for module in (typing, typing_extensions)
if hasattr(module, name)
)
if not result:
raise ValueError(
f"Neither typing nor typing_extensions has an object called {name!r}"
)
return result