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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.555.3

Browse Source
This commit is contained in:
speakeasybot
2025-06-05 00:02:45 +00:00
parent 76f6c233ff
commit 5617d76997
121 changed files with 1509 additions and 1215 deletions
Download Patch File Download Diff File Expand all files Collapse all files

132
.speakeasy/gen.lock
View File

File diff suppressed because one or more lines are too long

2
.speakeasy/gen.yaml
View File

@@ -17,7 +17,7 @@ generation:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
python:
version: 0.28.0
version: 0.28.1
additionalDependencies:
dev: {}
main: {}

14
.speakeasy/workflow.lock
View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.554.1
speakeasyVersion: 1.555.3
sources:
my-source:
sourceNamespace: my-source
@@ -8,19 +8,19 @@ sources:
- latest
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:37adc934a79841fb00cfe6ed569f5b1c88534b20202ecbde64b4e84828cee22a
sourceBlobDigest: sha256:ffb5b8d288111a763e4d035c8c9e37f5c89690d146b7297493b43a71d8298e6c
sourceRevisionDigest: sha256:78d07ad78ff60d0e9918696208d8c68a562e170d4e9c431797c02995fb8816d0
sourceBlobDigest: sha256:d38dd2a36c1b2fd73409267f7b30c2d5d45d709616141803ea01db424ec68ae4
tags:
- latest
- speakeasy-sdk-regen-1748563292
- speakeasy-sdk-regen-1749081688
targets:
plexpy:
source: plexapi
sourceNamespace: plexapi
sourceRevisionDigest: sha256:37adc934a79841fb00cfe6ed569f5b1c88534b20202ecbde64b4e84828cee22a
sourceBlobDigest: sha256:ffb5b8d288111a763e4d035c8c9e37f5c89690d146b7297493b43a71d8298e6c
sourceRevisionDigest: sha256:78d07ad78ff60d0e9918696208d8c68a562e170d4e9c431797c02995fb8816d0
sourceBlobDigest: sha256:d38dd2a36c1b2fd73409267f7b30c2d5d45d709616141803ea01db424ec68ae4
codeSamplesNamespace: code-samples-python-plexpy
codeSamplesRevisionDigest: sha256:e1e388378c142d431c28329b4d0508c172ad2258f66e0cc12dc6edeb4124194f
codeSamplesRevisionDigest: sha256:e7e6c374b6975dfe420f76cc8aab7a5fe741a649660093c00e3c9881b19d4179
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest

2
README.md
View File

@@ -218,7 +218,7 @@ asyncio.run(main())
* [get_library_details](docs/sdks/library/README.md#get_library_details) - Get Library Details
* [delete_library](docs/sdks/library/README.md#delete_library) - Delete Library Section
* [get_library_items](docs/sdks/library/README.md#get_library_items) - Get Library Items
* [get_all_media_library](docs/sdks/library/README.md#get_all_media_library) - Get all media of library
* [get_library_sections_all](docs/sdks/library/README.md#get_library_sections_all) - Get Library section media by tag ALL
* [get_refresh_library_metadata](docs/sdks/library/README.md#get_refresh_library_metadata) - Refresh Metadata Of The Library
* [get_search_library](docs/sdks/library/README.md#get_search_library) - Search Library
* [get_genres_library](docs/sdks/library/README.md#get_genres_library) - Get Genres of library media

12
RELEASES.md
View File

@@ -1048,4 +1048,14 @@ Based on:
### Generated
- [python v0.28.0] .
### Releases
- [PyPI v0.28.0] https://pypi.org/project/plex-api-client/0.28.0 - .
- [PyPI v0.28.0] https://pypi.org/project/plex-api-client/0.28.0 - .
## 2025-06-05 00:01:12
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.555.3 (2.620.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v0.28.1] .
### Releases
- [PyPI v0.28.1] https://pypi.org/project/plex-api-client/0.28.1 - .

30
codeSamples.yaml
View File

@@ -413,6 +413,7 @@ actions:
"content_directory_id": 39486,
"section_id": 2,
"type": operations.Type.TV_SHOW,
"include_meta": operations.IncludeMeta.ENABLE,
})
assert res.object is not None
@@ -432,7 +433,7 @@ actions:
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
res = plex_api.search.perform_search(query="arnold")
res = plex_api.search.perform_search(query="arnold", limit=5)
assert res is not None
@@ -451,7 +452,7 @@ actions:
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
res = plex_api.search.perform_voice_search(query="dead+poop")
res = plex_api.search.perform_voice_search(query="dead+poop", limit=5)
assert res is not None
@@ -507,7 +508,7 @@ actions:
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
res = plex_api.library.get_top_watched_content(type_=operations.GetTopWatchedContentQueryParamType.TV_SHOW, include_guids=1)
res = plex_api.library.get_top_watched_content(type_=operations.GetTopWatchedContentQueryParamType.TV_SHOW, include_guids=operations.GetTopWatchedContentQueryParamIncludeGuids.ENABLE)
assert res.object is not None
@@ -546,7 +547,7 @@ actions:
) as plex_api:
res = plex_api.library.get_media_meta_data(request={
"rating_key": 9518,
"rating_key": "21119,21617",
"include_concerts": True,
"include_extras": True,
"include_on_deck": True,
@@ -745,6 +746,7 @@ actions:
],
"section_id": 2,
"type": operations.QueryParamType.TV_SHOW,
"include_meta": operations.QueryParamIncludeMeta.ENABLE,
})
assert res.object is not None
@@ -771,6 +773,8 @@ actions:
"search_types": [
operations.SearchTypes.PEOPLE,
],
"include_collections": operations.GetSearchAllLibrariesQueryParamIncludeCollections.ENABLE,
"include_external_media": operations.GetSearchAllLibrariesQueryParamIncludeExternalMedia.ENABLE,
})
assert res.object is not None
@@ -845,13 +849,14 @@ actions:
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
res = plex_api.library.get_library_details(section_key=9518)
res = plex_api.library.get_library_details(section_key=9518, include_details=operations.IncludeDetails.ZERO)
assert res.object is not None
@@ -891,9 +896,14 @@ actions:
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
res = plex_api.library.get_all_media_library(request={
res = plex_api.library.get_library_sections_all(request={
"section_key": 9518,
"type": operations.GetAllMediaLibraryQueryParamType.TV_SHOW,
"type": operations.GetLibrarySectionsAllQueryParamType.TV_SHOW,
"include_meta": operations.GetLibrarySectionsAllQueryParamIncludeMeta.ENABLE,
"include_guids": operations.QueryParamIncludeGuids.ENABLE,
"include_advanced": operations.IncludeAdvanced.ENABLE,
"include_collections": operations.QueryParamIncludeCollections.ENABLE,
"include_external_media": operations.QueryParamIncludeExternalMedia.ENABLE,
})
assert res.object is not None
@@ -996,8 +1006,10 @@ actions:
res = plex_api.library.get_library_items(request={
"tag": operations.Tag.NEWEST,
"include_guids": operations.IncludeGuids.ENABLE,
"type": operations.GetLibraryItemsQueryParamType.TV_SHOW,
"section_key": 9518,
"include_meta": operations.GetLibraryItemsQueryParamIncludeMeta.ENABLE,
})
assert res.object is not None
@@ -1119,7 +1131,6 @@ actions:
res = plex_api.server.get_resized_photo(request={
"width": 110,
"height": 165,
"opacity": 100,
"blur": 0,
"min_size": operations.MinSize.ZERO,
"upscale": operations.Upscale.ZERO,
@@ -1363,13 +1374,14 @@ actions:
label: PlexPy
source: |-
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
res = plex_api.plex.get_server_resources(client_id="3381b62b-9ab7-4e37-827b-203e9809eb58")
res = plex_api.plex.get_server_resources(client_id="3381b62b-9ab7-4e37-827b-203e9809eb58", include_https=operations.IncludeHTTPS.ENABLE, include_relay=operations.IncludeRelay.ENABLE, include_i_pv6=operations.IncludeIPv6.ENABLE)
assert res.plex_devices is not None

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

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

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

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

11
docs/models/errors/getlibrarysectionsallbadrequest.md Normal file
View File

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

2
docs/models/errors/getallmedialibraryerrors.md → docs/models/errors/getlibrarysectionsallerrors.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryErrors
# GetLibrarySectionsAllErrors
## Fields

2
docs/models/errors/getallmedialibrarylibraryerrors.md → docs/models/errors/getlibrarysectionsalllibraryerrors.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryLibraryErrors
# GetLibrarySectionsAllLibraryErrors
## Fields

11
docs/models/errors/getlibrarysectionsallunauthorized.md Normal file
View File

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

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

@@ -5,8 +5,8 @@ The filter query string for country media items.
## Fields
| 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 |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
| `tag` | *str* | :heavy_check_mark: | The country of origin of this media item | United States of America |
| `filter_` | *str* | :heavy_check_mark: | N/A | country=19 |

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

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

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

@@ -5,8 +5,8 @@ The filter query string for similar items.
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 259 |
| `filter_` | *str* | :heavy_check_mark: | N/A | genre=19 |
| `tag` | *str* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique identifier for the genre.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
| `filter_` | *str* | :heavy_check_mark: | N/A | genre=19 |
| `tag` | *str* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |

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

@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `AUDIO` | 8 |
| `ALBUM` | 9 |
| `TRACK` | 10 |
| Name | Value |
| ------------- | ------------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `ARTIST` | 5 |
| `ALBUM` | 6 |
| `TRACK` | 7 |
| `PHOTO_ALBUM` | 8 |
| `PHOTO` | 9 |

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

@@ -5,11 +5,15 @@ The library type
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | movie |
| `TV_SHOW` | show |
| `SEASON` | season |
| `EPISODE` | episode |
| `ARTIST` | artist |
| `ALBUM` | album |
| Name | Value |
| ------------- | ------------- |
| `MOVIE` | movie |
| `TV_SHOW` | show |
| `SEASON` | season |
| `EPISODE` | episode |
| `ARTIST` | artist |
| `ALBUM` | album |
| `TRACK` | track |
| `PHOTO_ALBUM` | photoalbum |
| `PHOTO` | photo |
| `COLLECTION` | collection |

9
docs/models/operations/getallmedialibraryfieldtype.md
View File

@@ -1,9 +0,0 @@
# GetAllMediaLibraryFieldType
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `type` | *str* | :heavy_check_mark: | N/A | tag |
| `operator` | List[[operations.GetAllMediaLibraryOperator](../../models/operations/getallmedialibraryoperator.md)] | :heavy_check_mark: | N/A | |

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

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

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

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

19
docs/models/operations/getallmedialibrarylibraryoptimizedforstreaming.md
View File

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

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

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

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

@@ -1,26 +0,0 @@
# GetAllMediaLibraryMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `total_size` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
| `offset` | *int* | :heavy_check_mark: | Offset value for pagination. | 0 |
| `allow_sync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `art` | *str* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `content` | *str* | :heavy_check_mark: | The content type or mode. | secondary |
| `identifier` | *str* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `library_section_id` | *int* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
| `library_section_title` | *str* | :heavy_check_mark: | The title of the library section. | TV Series |
| `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
| `media_tag_prefix` | *str* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `media_tag_version` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `thumb` | *str* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `nocache` | *bool* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
| `title1` | *str* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `title2` | *str* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
| `view_group` | *str* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
| `meta` | [Optional[operations.GetAllMediaLibraryMeta]](../../models/operations/getallmedialibrarymeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
| `metadata` | List[[operations.GetAllMediaLibraryMetadata](../../models/operations/getallmedialibrarymetadata.md)] | :heavy_minus_sign: | An array of metadata items. | |

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

@@ -1,12 +0,0 @@
# GetAllMediaLibraryMeta
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `type` | List[[operations.GetAllMediaLibraryType](../../models/operations/getallmedialibrarytype.md)] | :heavy_minus_sign: | N/A |
| `field_type` | List[[operations.GetAllMediaLibraryFieldType](../../models/operations/getallmedialibraryfieldtype.md)] | :heavy_minus_sign: | N/A |

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

@@ -1,23 +0,0 @@
# GetAllMediaLibraryPart
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accessible` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `exists` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `key` | *str* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
| `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `file` | *str* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `packet_length` | *Optional[int]* | :heavy_minus_sign: | N/A | 188 |
| `container` | *Optional[str]* | :heavy_minus_sign: | Container format of the part. | mkv |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile for the part. | main 10 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | [Optional[operations.GetAllMediaLibraryLibraryOptimizedForStreaming]](../../models/operations/getallmedialibrarylibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has_thumbnail` | [Optional[operations.GetAllMediaLibraryHasThumbnail]](../../models/operations/getallmedialibraryhasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | List[[operations.GetAllMediaLibraryStream](../../models/operations/getallmedialibrarystream.md)] | :heavy_minus_sign: | An array of streams for this part. | |

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

@@ -1,22 +0,0 @@
# GetAllMediaLibraryQueryParamType
The type of media to retrieve or filter by.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `AUDIO` | 8 |
| `ALBUM` | 9 |
| `TRACK` | 10 |

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

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

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

@@ -1,10 +0,0 @@
# GetAllMediaLibraryResponseBody
Successful response containing media container data.
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `media_container` | [Optional[operations.GetAllMediaLibraryMediaContainer]](../../models/operations/getallmedialibrarymediacontainer.md) | :heavy_minus_sign: | N/A |

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

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

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

@@ -1,58 +0,0 @@
# GetAllMediaLibraryStream
## Fields
| 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 |

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

@@ -1,15 +0,0 @@
# GetAllMediaLibraryType
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `key` | *str* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *str* | :heavy_check_mark: | N/A | filter |
| `subtype` | *Optional[str]* | :heavy_minus_sign: | N/A | clip |
| `title` | *str* | :heavy_check_mark: | N/A | TV Shows |
| `active` | *bool* | :heavy_check_mark: | N/A | false |
| `filter_` | List[[operations.GetAllMediaLibraryFilter](../../models/operations/getallmedialibraryfilter.md)] | :heavy_minus_sign: | N/A | |
| `sort` | List[[operations.GetAllMediaLibrarySort](../../models/operations/getallmedialibrarysort.md)] | :heavy_minus_sign: | N/A | |
| `field` | List[[operations.GetAllMediaLibraryField](../../models/operations/getallmedialibraryfield.md)] | :heavy_minus_sign: | N/A | |

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

@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `AUDIO` | 8 |
| `ALBUM` | 9 |
| `TRACK` | 10 |
| Name | Value |
| ------------- | ------------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `ARTIST` | 5 |
| `ALBUM` | 6 |
| `TRACK` | 7 |
| `PHOTO_ALBUM` | 8 |
| `PHOTO` | 9 |

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

@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `AUDIO` | 8 |
| `ALBUM` | 9 |
| `TRACK` | 10 |
| Name | Value |
| ------------- | ------------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `ARTIST` | 5 |
| `ALBUM` | 6 |
| `TRACK` | 7 |
| `PHOTO_ALBUM` | 8 |
| `PHOTO` | 9 |

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

@@ -1,16 +1,20 @@
# GetLibraryItemsLibraryType
The type of media content
The type of media content in the Plex library. This can represent videos, music, or photos.
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | movie |
| `TV_SHOW` | show |
| `SEASON` | season |
| `EPISODE` | episode |
| `ARTIST` | artist |
| `ALBUM` | album |
| Name | Value |
| ------------- | ------------- |
| `MOVIE` | movie |
| `TV_SHOW` | show |
| `SEASON` | season |
| `EPISODE` | episode |
| `ARTIST` | artist |
| `ALBUM` | album |
| `TRACK` | track |
| `PHOTO_ALBUM` | photoalbum |
| `PHOTO` | photo |
| `COLLECTION` | collection |

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

@@ -13,7 +13,7 @@
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Movies |
| `library_section_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `type` | [operations.GetLibraryItemsLibraryType](../../models/operations/getlibraryitemslibrarytype.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `type` | [operations.GetLibraryItemsLibraryType](../../models/operations/getlibraryitemslibrarytype.md) | :heavy_check_mark: | The type of media content in the Plex library. This can represent videos, music, or photos.<br/> | movie |
| `title` | *str* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `slug` | *Optional[str]* | :heavy_minus_sign: | N/A | 4-for-texas |
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | N/A | PG-13 |

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

@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `AUDIO` | 8 |
| `ALBUM` | 9 |
| `TRACK` | 10 |
| Name | Value |
| ------------- | ------------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `ARTIST` | 5 |
| `ALBUM` | 6 |
| `TRACK` | 7 |
| `PHOTO_ALBUM` | 8 |
| `PHOTO` | 9 |

2
docs/models/operations/getallmedialibraryactivedirection.md → docs/models/operations/getlibrarysectionsallactivedirection.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryActiveDirection
# GetLibrarySectionsAllActiveDirection
The direction of the sort. Can be either `asc` or `desc`.

2
docs/models/operations/getallmedialibrarycollection.md → docs/models/operations/getlibrarysectionsallcollection.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryCollection
# GetLibrarySectionsAllCollection
## Fields

2
docs/models/operations/getallmedialibrarycountry.md → docs/models/operations/getlibrarysectionsallcountry.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryCountry
# GetLibrarySectionsAllCountry
## Fields

2
docs/models/operations/getallmedialibrarydefaultdirection.md → docs/models/operations/getlibrarysectionsalldefaultdirection.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryDefaultDirection
# GetLibrarySectionsAllDefaultDirection
The direction of the sort. Can be either `asc` or `desc`.

2
docs/models/operations/getallmedialibrarydirector.md → docs/models/operations/getlibrarysectionsalldirector.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryDirector
# GetLibrarySectionsAllDirector
## Fields

2
docs/models/operations/getallmedialibraryfield.md → docs/models/operations/getlibrarysectionsallfield.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryField
# GetLibrarySectionsAllField
## Fields

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

@@ -0,0 +1,9 @@
# GetLibrarySectionsAllFieldType
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `type` | *str* | :heavy_check_mark: | N/A | tag |
| `operator` | List[[operations.GetLibrarySectionsAllOperator](../../models/operations/getlibrarysectionsalloperator.md)] | :heavy_check_mark: | N/A | |

2
docs/models/operations/getallmedialibraryfilter.md → docs/models/operations/getlibrarysectionsallfilter.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryFilter
# GetLibrarySectionsAllFilter
## Fields

2
docs/models/operations/getallmedialibrarygenre.md → docs/models/operations/getlibrarysectionsallgenre.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryGenre
# GetLibrarySectionsAllGenre
## Fields

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

@@ -0,0 +1,8 @@
# GetLibrarySectionsAllGuids
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |

2
docs/models/operations/getallmedialibraryhasthumbnail.md → docs/models/operations/getlibrarysectionsallhasthumbnail.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryHasThumbnail
# GetLibrarySectionsAllHasThumbnail
Indicates if the part has a thumbnail.

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

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

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

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

2
docs/models/operations/getallmedialibrarylibraryresponsetype.md → docs/models/operations/getlibrarysectionsalllibraryresponsetype.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryLibraryResponseType
# GetLibrarySectionsAllLibraryResponseType
## Values

20
docs/models/operations/getlibrarysectionsalllibrarytype.md Normal file
View File

@@ -0,0 +1,20 @@
# GetLibrarySectionsAllLibraryType
The type of media content in the Plex library. This can represent videos, music, or photos.
## Values
| Name | Value |
| ------------- | ------------- |
| `MOVIE` | movie |
| `TV_SHOW` | show |
| `SEASON` | season |
| `EPISODE` | episode |
| `ARTIST` | artist |
| `ALBUM` | album |
| `TRACK` | track |
| `PHOTO_ALBUM` | photoalbum |
| `PHOTO` | photo |
| `COLLECTION` | collection |

44
docs/models/operations/getallmedialibrarymedia.md → docs/models/operations/getlibrarysectionsallmedia.md
View File

@@ -1,26 +1,26 @@
# GetAllMediaLibraryMedia
# GetLibrarySectionsAllMedia
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `width` | *Optional[int]* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `height` | *Optional[int]* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `display_offset` | *Optional[int]* | :heavy_minus_sign: | N/A | 50 |
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | Audio codec used. | eac3 |
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | Video codec used. | hevc |
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `container` | *Optional[str]* | :heavy_minus_sign: | File container type. | mkv |
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `optimized_for_streaming` | [Optional[operations.GetAllMediaLibraryOptimizedForStreaming]](../../models/operations/getallmedialibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `part` | List[[operations.GetAllMediaLibraryPart](../../models/operations/getallmedialibrarypart.md)] | :heavy_minus_sign: | An array of parts for this media item. | |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `width` | *Optional[int]* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `height` | *Optional[int]* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `display_offset` | *Optional[int]* | :heavy_minus_sign: | N/A | 50 |
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | Audio codec used. | eac3 |
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | Video codec used. | hevc |
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `container` | *Optional[str]* | :heavy_minus_sign: | File container type. | mkv |
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `optimized_for_streaming` | [Optional[operations.GetLibrarySectionsAllOptimizedForStreaming]](../../models/operations/getlibrarysectionsalloptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `part` | List[[operations.GetLibrarySectionsAllPart](../../models/operations/getlibrarysectionsallpart.md)] | :heavy_minus_sign: | An array of parts for this media item. | |

26
docs/models/operations/getlibrarysectionsallmediacontainer.md Normal file
View File

@@ -0,0 +1,26 @@
# GetLibrarySectionsAllMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `total_size` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
| `offset` | *int* | :heavy_check_mark: | Offset value for pagination. | 0 |
| `allow_sync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `art` | *str* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `content` | *str* | :heavy_check_mark: | The content type or mode. | secondary |
| `identifier` | *str* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `library_section_id` | *int* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
| `library_section_title` | *str* | :heavy_check_mark: | The title of the library section. | TV Series |
| `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
| `media_tag_prefix` | *str* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `media_tag_version` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `thumb` | *str* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `nocache` | *bool* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
| `title1` | *str* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `title2` | *str* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
| `view_group` | *str* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
| `meta` | [Optional[operations.GetLibrarySectionsAllMeta]](../../models/operations/getlibrarysectionsallmeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
| `metadata` | List[[operations.GetLibrarySectionsAllMetadata](../../models/operations/getlibrarysectionsallmetadata.md)] | :heavy_minus_sign: | An array of metadata items. | |

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

@@ -0,0 +1,12 @@
# GetLibrarySectionsAllMeta
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `type` | List[[operations.GetLibrarySectionsAllType](../../models/operations/getlibrarysectionsalltype.md)] | :heavy_minus_sign: | N/A |
| `field_type` | List[[operations.GetLibrarySectionsAllFieldType](../../models/operations/getlibrarysectionsallfieldtype.md)] | :heavy_minus_sign: | N/A |

24
docs/models/operations/getallmedialibrarymetadata.md → docs/models/operations/getlibrarysectionsallmetadata.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryMetadata
# GetLibrarySectionsAllMetadata
Unknown
@@ -13,7 +13,7 @@ Unknown
| `guid` | *str* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
| `slug` | *str* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
| `studio` | *Optional[str]* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `type` | [operations.GetAllMediaLibraryLibraryType](../../models/operations/getallmedialibrarylibrarytype.md) | :heavy_check_mark: | N/A | movie |
| `type` | [operations.GetLibrarySectionsAllLibraryType](../../models/operations/getlibrarysectionsalllibrarytype.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 |
@@ -62,13 +62,13 @@ Unknown
| `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.GetAllMediaLibraryImage](../../models/operations/getallmedialibraryimage.md)] | :heavy_minus_sign: | N/A | |
| `ultra_blur_colors` | [Optional[operations.GetAllMediaLibraryUltraBlurColors]](../../models/operations/getallmedialibraryultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `media` | List[[operations.GetAllMediaLibraryMedia](../../models/operations/getallmedialibrarymedia.md)] | :heavy_minus_sign: | N/A | |
| `genre` | List[[operations.GetAllMediaLibraryGenre](../../models/operations/getallmedialibrarygenre.md)] | :heavy_minus_sign: | N/A | |
| `country` | List[[operations.GetAllMediaLibraryCountry](../../models/operations/getallmedialibrarycountry.md)] | :heavy_minus_sign: | N/A | |
| `director` | List[[operations.GetAllMediaLibraryDirector](../../models/operations/getallmedialibrarydirector.md)] | :heavy_minus_sign: | N/A | |
| `writer` | List[[operations.GetAllMediaLibraryWriter](../../models/operations/getallmedialibrarywriter.md)] | :heavy_minus_sign: | N/A | |
| `role` | List[[operations.GetAllMediaLibraryRole](../../models/operations/getallmedialibraryrole.md)] | :heavy_minus_sign: | N/A | |
| `guids` | List[[operations.GetAllMediaLibraryGuids](../../models/operations/getallmedialibraryguids.md)] | :heavy_minus_sign: | N/A | |
| `collection` | List[[operations.GetAllMediaLibraryCollection](../../models/operations/getallmedialibrarycollection.md)] | :heavy_minus_sign: | N/A | |
| `image` | List[[operations.GetLibrarySectionsAllImage](../../models/operations/getlibrarysectionsallimage.md)] | :heavy_minus_sign: | N/A | |
| `ultra_blur_colors` | [Optional[operations.GetLibrarySectionsAllUltraBlurColors]](../../models/operations/getlibrarysectionsallultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `guids` | List[[operations.GetLibrarySectionsAllGuids](../../models/operations/getlibrarysectionsallguids.md)] | :heavy_minus_sign: | N/A | |
| `media` | List[[operations.GetLibrarySectionsAllMedia](../../models/operations/getlibrarysectionsallmedia.md)] | :heavy_minus_sign: | N/A | |
| `genre` | List[[operations.GetLibrarySectionsAllGenre](../../models/operations/getlibrarysectionsallgenre.md)] | :heavy_minus_sign: | N/A | |
| `country` | List[[operations.GetLibrarySectionsAllCountry](../../models/operations/getlibrarysectionsallcountry.md)] | :heavy_minus_sign: | N/A | |
| `director` | List[[operations.GetLibrarySectionsAllDirector](../../models/operations/getlibrarysectionsalldirector.md)] | :heavy_minus_sign: | N/A | |
| `writer` | List[[operations.GetLibrarySectionsAllWriter](../../models/operations/getlibrarysectionsallwriter.md)] | :heavy_minus_sign: | N/A | |
| `role` | List[[operations.GetLibrarySectionsAllRole](../../models/operations/getlibrarysectionsallrole.md)] | :heavy_minus_sign: | N/A | |
| `collection` | List[[operations.GetLibrarySectionsAllCollection](../../models/operations/getlibrarysectionsallcollection.md)] | :heavy_minus_sign: | N/A | |

2
docs/models/operations/getallmedialibraryoperator.md → docs/models/operations/getlibrarysectionsalloperator.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryOperator
# GetLibrarySectionsAllOperator
## Fields

2
docs/models/operations/getallmedialibraryoptimizedforstreaming.md → docs/models/operations/getlibrarysectionsalloptimizedforstreaming.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryOptimizedForStreaming
# GetLibrarySectionsAllOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true

2
docs/models/operations/getallmedialibraryoptimizedforstreaming1.md → docs/models/operations/getlibrarysectionsalloptimizedforstreaming1.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryOptimizedForStreaming1
# GetLibrarySectionsAllOptimizedForStreaming1
## Values

23
docs/models/operations/getlibrarysectionsallpart.md Normal file
View File

@@ -0,0 +1,23 @@
# GetLibrarySectionsAllPart
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accessible` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `exists` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `key` | *str* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
| `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `file` | *str* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `packet_length` | *Optional[int]* | :heavy_minus_sign: | N/A | 188 |
| `container` | *Optional[str]* | :heavy_minus_sign: | Container format of the part. | mkv |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile for the part. | main 10 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | [Optional[operations.GetLibrarySectionsAllLibraryOptimizedForStreaming]](../../models/operations/getlibrarysectionsalllibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has_thumbnail` | [Optional[operations.GetLibrarySectionsAllHasThumbnail]](../../models/operations/getlibrarysectionsallhasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | List[[operations.GetLibrarySectionsAllStream](../../models/operations/getlibrarysectionsallstream.md)] | :heavy_minus_sign: | An array of streams for this part. | |

2
docs/models/operations/getallmedialibraryqueryparamincludemeta.md → docs/models/operations/getlibrarysectionsallqueryparamincludemeta.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryQueryParamIncludeMeta
# GetLibrarySectionsAllQueryParamIncludeMeta
Adds the Meta object to the response

24
docs/models/operations/getlibrarysectionsallqueryparamtype.md Normal file
View File

@@ -0,0 +1,24 @@
# GetLibrarySectionsAllQueryParamType
The type of media to retrieve or filter by.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Values
| Name | Value |
| ------------- | ------------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `ARTIST` | 5 |
| `ALBUM` | 6 |
| `TRACK` | 7 |
| `PHOTO_ALBUM` | 8 |
| `PHOTO` | 9 |

6
docs/models/operations/getallmedialibraryrequest.md → docs/models/operations/getlibrarysectionsallrequest.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryRequest
# GetLibrarySectionsAllRequest
## Fields
@@ -6,8 +6,8 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `section_key` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `type` | [operations.GetAllMediaLibraryQueryParamType](../../models/operations/getallmedialibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `include_meta` | [Optional[operations.GetAllMediaLibraryQueryParamIncludeMeta]](../../models/operations/getallmedialibraryqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `type` | [operations.GetLibrarySectionsAllQueryParamType](../../models/operations/getlibrarysectionsallqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `include_meta` | [Optional[operations.GetLibrarySectionsAllQueryParamIncludeMeta]](../../models/operations/getlibrarysectionsallqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `include_guids` | [Optional[operations.QueryParamIncludeGuids]](../../models/operations/queryparamincludeguids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
| `include_advanced` | [Optional[operations.IncludeAdvanced]](../../models/operations/includeadvanced.md) | :heavy_minus_sign: | N/A | 1 |
| `include_collections` | [Optional[operations.QueryParamIncludeCollections]](../../models/operations/queryparamincludecollections.md) | :heavy_minus_sign: | N/A | 1 |

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

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

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

@@ -0,0 +1,10 @@
# GetLibrarySectionsAllResponseBody
Successful response containing media container data.
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `media_container` | [Optional[operations.GetLibrarySectionsAllMediaContainer]](../../models/operations/getlibrarysectionsallmediacontainer.md) | :heavy_minus_sign: | N/A |

2
docs/models/operations/getallmedialibraryrole.md → docs/models/operations/getlibrarysectionsallrole.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryRole
# GetLibrarySectionsAllRole
## Fields

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

@@ -0,0 +1,15 @@
# GetLibrarySectionsAllSort
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `default` | *Optional[str]* | :heavy_minus_sign: | N/A | asc |
| `active` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `active_direction` | [Optional[operations.GetLibrarySectionsAllActiveDirection]](../../models/operations/getlibrarysectionsallactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `default_direction` | [Optional[operations.GetLibrarySectionsAllDefaultDirection]](../../models/operations/getlibrarysectionsalldefaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `desc_key` | *Optional[str]* | :heavy_minus_sign: | N/A | titleSort:desc |
| `first_character_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `key` | *str* | :heavy_check_mark: | N/A | titleSort |
| `title` | *str* | :heavy_check_mark: | N/A | Title |

58
docs/models/operations/getlibrarysectionsallstream.md Normal file
View File

@@ -0,0 +1,58 @@
# GetLibrarySectionsAllStream
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `stream_type` | [operations.GetLibrarySectionsAllStreamType](../../models/operations/getlibrarysectionsallstreamtype.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 |

2
docs/models/operations/getallmedialibrarystreamtype.md → docs/models/operations/getlibrarysectionsallstreamtype.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryStreamType
# GetLibrarySectionsAllStreamType
Stream type:
- 1 = video

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

@@ -0,0 +1,15 @@
# GetLibrarySectionsAllType
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `key` | *str* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *str* | :heavy_check_mark: | N/A | filter |
| `subtype` | *Optional[str]* | :heavy_minus_sign: | N/A | clip |
| `title` | *str* | :heavy_check_mark: | N/A | TV Shows |
| `active` | *bool* | :heavy_check_mark: | N/A | false |
| `filter_` | List[[operations.GetLibrarySectionsAllFilter](../../models/operations/getlibrarysectionsallfilter.md)] | :heavy_minus_sign: | N/A | |
| `sort` | List[[operations.GetLibrarySectionsAllSort](../../models/operations/getlibrarysectionsallsort.md)] | :heavy_minus_sign: | N/A | |
| `field` | List[[operations.GetLibrarySectionsAllField](../../models/operations/getlibrarysectionsallfield.md)] | :heavy_minus_sign: | N/A | |

2
docs/models/operations/getallmedialibraryultrablurcolors.md → docs/models/operations/getlibrarysectionsallultrablurcolors.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryUltraBlurColors
# GetLibrarySectionsAllUltraBlurColors
## Fields

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

@@ -1,4 +1,4 @@
# GetAllMediaLibraryWriter
# GetLibrarySectionsAllWriter
## Fields

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

@@ -5,8 +5,8 @@ The filter query string for country media items.
## Fields
| 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 |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
| `tag` | *str* | :heavy_check_mark: | The country of origin of this media item | United States of America |
| `filter_` | *str* | :heavy_check_mark: | N/A | country=19 |

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

@@ -3,10 +3,10 @@
## Fields
| 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 |
| 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` | *str* | :heavy_check_mark: | A unique 24-character hexadecimal key associated with the director's tag, used for internal identification. | 5d776831151a60001f24d031 |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |

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

@@ -5,8 +5,8 @@ The filter query string for similar items.
## Fields
| 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 |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique identifier for the genre.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
| `tag` | *str* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
| `filter_` | *str* | :heavy_check_mark: | N/A | genre=19 |

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

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *str* | :heavy_check_mark: | The GUID value. | imdb://tt3032476 |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |

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

@@ -67,6 +67,7 @@ Unknown
| `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 |
| `guids` | List[[operations.GetMediaMetaDataGuids](../../models/operations/getmediametadataguids.md)] | :heavy_minus_sign: | N/A | |
| `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 | |
@@ -74,7 +75,6 @@ Unknown
| `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 | |

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

@@ -3,19 +3,19 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
| `rating_key` | *int* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
| `include_concerts` | *Optional[bool]* | :heavy_minus_sign: | Include concerts data if set to true. | true |
| `include_extras` | *Optional[bool]* | :heavy_minus_sign: | Include extra content (e.g. bonus features). | true |
| `include_on_deck` | *Optional[bool]* | :heavy_minus_sign: | Include on-deck items. | true |
| `include_popular_leaves` | *Optional[bool]* | :heavy_minus_sign: | Include popular leaves (episodes/chapters). | true |
| `include_preferences` | *Optional[bool]* | :heavy_minus_sign: | Include preferences information. | true |
| `include_reviews` | *Optional[bool]* | :heavy_minus_sign: | Include reviews for the content. | true |
| `include_chapters` | *Optional[bool]* | :heavy_minus_sign: | Include chapter details. | true |
| `include_stations` | *Optional[bool]* | :heavy_minus_sign: | Include station data. | true |
| `include_external_media` | *Optional[bool]* | :heavy_minus_sign: | Include external media data. | true |
| `async_augment_metadata` | *Optional[bool]* | :heavy_minus_sign: | Trigger asynchronous metadata augmentation. | true |
| `async_check_files` | *Optional[bool]* | :heavy_minus_sign: | Trigger asynchronous file checking. | true |
| `async_refresh_analysis` | *Optional[bool]* | :heavy_minus_sign: | Trigger asynchronous refresh of analysis. | true |
| `async_refresh_local_media_agent` | *Optional[bool]* | :heavy_minus_sign: | Trigger asynchronous refresh of the local media agent. | true |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `rating_key` | *str* | :heavy_check_mark: | The id(s) of the library item(s) to return metadata for. Can be a single ID or comma-separated list of IDs. | 21119,21617 |
| `include_concerts` | *Optional[bool]* | :heavy_minus_sign: | Include concerts data if set to true. | true |
| `include_extras` | *Optional[bool]* | :heavy_minus_sign: | Include extra content (e.g. bonus features). | true |
| `include_on_deck` | *Optional[bool]* | :heavy_minus_sign: | Include on-deck items. | true |
| `include_popular_leaves` | *Optional[bool]* | :heavy_minus_sign: | Include popular leaves (episodes/chapters). | true |
| `include_preferences` | *Optional[bool]* | :heavy_minus_sign: | Include preferences information. | true |
| `include_reviews` | *Optional[bool]* | :heavy_minus_sign: | Include reviews for the content. | true |
| `include_chapters` | *Optional[bool]* | :heavy_minus_sign: | Include chapter details. | true |
| `include_stations` | *Optional[bool]* | :heavy_minus_sign: | Include station data. | true |
| `include_external_media` | *Optional[bool]* | :heavy_minus_sign: | Include external media data. | true |
| `async_augment_metadata` | *Optional[bool]* | :heavy_minus_sign: | Trigger asynchronous metadata augmentation. | true |
| `async_check_files` | *Optional[bool]* | :heavy_minus_sign: | Trigger asynchronous file checking. | true |
| `async_refresh_analysis` | *Optional[bool]* | :heavy_minus_sign: | Trigger asynchronous refresh of analysis. | true |
| `async_refresh_local_media_agent` | *Optional[bool]* | :heavy_minus_sign: | Trigger asynchronous refresh of the local media agent. | true |

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

@@ -3,11 +3,11 @@
## Fields
| 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 |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique identifier for the role.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 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` | *str* | :heavy_check_mark: | A 24-character hexadecimal unique key associated with the actor's tag, used for internal identification.<br/>NOTE: This is globally unique across all Plex Servers.<br/> | 5d77683d85719b001f3a535e |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |

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

@@ -1,16 +1,20 @@
# GetMediaMetaDataType
The type of media content
The type of media content in the Plex library. This can represent videos, music, or photos.
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | movie |
| `TV_SHOW` | show |
| `SEASON` | season |
| `EPISODE` | episode |
| `ARTIST` | artist |
| `ALBUM` | album |
| Name | Value |
| ------------- | ------------- |
| `MOVIE` | movie |
| `TV_SHOW` | show |
| `SEASON` | season |
| `EPISODE` | episode |
| `ARTIST` | artist |
| `ALBUM` | album |
| `TRACK` | track |
| `PHOTO_ALBUM` | photoalbum |
| `PHOTO` | photo |
| `COLLECTION` | collection |

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

@@ -3,10 +3,10 @@
## Fields
| 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 |
| 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 absolute 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 24-character hexadecimal unique key associated with the writer’s tag, used for internal identification. | 5d77683d85719b001f3a535e |

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

@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `AUDIO` | 8 |
| `ALBUM` | 9 |
| `TRACK` | 10 |
| Name | Value |
| ------------- | ------------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `ARTIST` | 5 |
| `ALBUM` | 6 |
| `TRACK` | 7 |
| `PHOTO_ALBUM` | 8 |
| `PHOTO` | 9 |

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

@@ -1,16 +1,20 @@
# GetRecentlyAddedHubsType
The type of media content
The type of media content in the Plex library. This can represent videos, music, or photos.
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | movie |
| `TV_SHOW` | show |
| `SEASON` | season |
| `EPISODE` | episode |
| `ARTIST` | artist |
| `ALBUM` | album |
| Name | Value |
| ------------- | ------------- |
| `MOVIE` | movie |
| `TV_SHOW` | show |
| `SEASON` | season |
| `EPISODE` | episode |
| `ARTIST` | artist |
| `ALBUM` | album |
| `TRACK` | track |
| `PHOTO_ALBUM` | photoalbum |
| `PHOTO` | photo |
| `COLLECTION` | collection |

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

@@ -71,6 +71,7 @@ Unknown
| `year` | *Optional[int]* | :heavy_minus_sign: | The release year of the media item. | 2022 |
| `image` | List[[operations.GetRecentlyAddedImage](../../models/operations/getrecentlyaddedimage.md)] | :heavy_minus_sign: | N/A | |
| `ultra_blur_colors` | [Optional[operations.UltraBlurColors]](../../models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `guids` | List[[operations.Guids](../../models/operations/guids.md)] | :heavy_minus_sign: | N/A | |
| `media` | List[[operations.Media](../../models/operations/media.md)] | :heavy_minus_sign: | N/A | |
| `genre` | List[[operations.Genre](../../models/operations/genre.md)] | :heavy_minus_sign: | N/A | |
| `country` | List[[operations.Country](../../models/operations/country.md)] | :heavy_minus_sign: | N/A | |
@@ -81,5 +82,4 @@ Unknown
| `rating1` | List[[operations.Rating](../../models/operations/rating.md)] | :heavy_minus_sign: | N/A | |
| `similar` | List[[operations.Similar](../../models/operations/similar.md)] | :heavy_minus_sign: | N/A | |
| `location` | List[[operations.Location](../../models/operations/location.md)] | :heavy_minus_sign: | N/A | |
| `guids` | List[[operations.Guids](../../models/operations/guids.md)] | :heavy_minus_sign: | N/A | |
| `collection` | List[[operations.Collection](../../models/operations/collection.md)] | :heavy_minus_sign: | N/A | |

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

@@ -13,7 +13,7 @@
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Movies |
| `library_section_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `type` | [operations.GetSearchAllLibrariesType](../../models/operations/getsearchalllibrariestype.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `type` | [operations.GetSearchAllLibrariesType](../../models/operations/getsearchalllibrariestype.md) | :heavy_check_mark: | The type of media content in the Plex library. This can represent videos, music, or photos.<br/> | movie |
| `title` | *str* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `slug` | *Optional[str]* | :heavy_minus_sign: | N/A | 4-for-texas |
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | N/A | PG-13 |

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

@@ -1,16 +1,20 @@
# GetSearchAllLibrariesType
The type of media content
The type of media content in the Plex library. This can represent videos, music, or photos.
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | movie |
| `TV_SHOW` | show |
| `SEASON` | season |
| `EPISODE` | episode |
| `ARTIST` | artist |
| `ALBUM` | album |
| Name | Value |
| ------------- | ------------- |
| `MOVIE` | movie |
| `TV_SHOW` | show |
| `SEASON` | season |
| `EPISODE` | episode |
| `ARTIST` | artist |
| `ALBUM` | album |
| `TRACK` | track |
| `PHOTO_ALBUM` | photoalbum |
| `PHOTO` | photo |
| `COLLECTION` | collection |

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

@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `AUDIO` | 8 |
| `ALBUM` | 9 |
| `TRACK` | 10 |
| Name | Value |
| ------------- | ------------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `ARTIST` | 5 |
| `ALBUM` | 6 |
| `TRACK` | 7 |
| `PHOTO_ALBUM` | 8 |
| `PHOTO` | 9 |

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

@@ -5,9 +5,9 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `size` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `allow_sync` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `identifier` | *Optional[str]* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `media_tag_prefix` | *Optional[str]* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `media_tag_version` | *Optional[int]* | :heavy_minus_sign: | N/A | 1698860922 |
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `allow_sync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `identifier` | *str* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `media_tag_prefix` | *str* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `media_tag_version` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `metadata` | List[[operations.GetTopWatchedContentMetadata](../../models/operations/gettopwatchedcontentmetadata.md)] | :heavy_minus_sign: | N/A | |

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

@@ -0,0 +1,12 @@
# GetTopWatchedContentQueryParamIncludeGuids
Adds the Guid object to the response
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

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

@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `AUDIO` | 8 |
| `ALBUM` | 9 |
| `TRACK` | 10 |
| Name | Value |
| ------------- | ------------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `ARTIST` | 5 |
| `ALBUM` | 6 |
| `TRACK` | 7 |
| `PHOTO_ALBUM` | 8 |
| `PHOTO` | 9 |

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

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

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

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337<br/> | tvdb://2337 |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |

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

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

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

@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `AUDIO` | 8 |
| `ALBUM` | 9 |
| `TRACK` | 10 |
| Name | Value |
| ------------- | ------------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `ARTIST` | 5 |
| `ALBUM` | 6 |
| `TRACK` | 7 |
| `PHOTO_ALBUM` | 8 |
| `PHOTO` | 9 |

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

@@ -5,8 +5,8 @@ The type of rating, for example 'audience' or 'critic'.
## Fields
| Field | Type | Required | Description | Example |
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
| `image` | *str* | :heavy_check_mark: | N/A | imdb://image.rating |
| `value` | *float* | :heavy_check_mark: | N/A | 5.1 |
| `type` | *str* | :heavy_check_mark: | N/A | audience |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| `image` | *str* | :heavy_check_mark: | The URL for the rating image, for example from IMDb. | imdb://image.rating |
| `value` | *float* | :heavy_check_mark: | N/A | 5.1 |
| `type` | *str* | :heavy_check_mark: | N/A | audience |

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

@@ -3,11 +3,11 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique identifier for the actor or role. | 126522 |
| `filter_` | *str* | :heavy_check_mark: | The filter string used to query this actor. For example, it may indicate that this is an actor with a given key. | actor=126522 |
| `tag` | *str* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
| `tag_key` | *Optional[str]* | :heavy_minus_sign: | A unique key associated with the actor's tag, used for internal identification. | 5d77683d85719b001f3a535e |
| `role` | *Optional[str]* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | The unique identifier for the role.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 126522 |
| `filter_` | *str* | :heavy_check_mark: | The filter string used to query this actor. For example, it may indicate that this is an actor with a given key. | actor=126522 |
| `tag` | *str* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
| `tag_key` | *str* | :heavy_check_mark: | A 24-character hexadecimal unique key associated with the actor's tag, used for internal identification.<br/>NOTE: This is globally unique across all Plex Servers.<br/> | 5d77683d85719b001f3a535e |
| `role` | *Optional[str]* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |

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

@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `AUDIO` | 8 |
| `ALBUM` | 9 |
| `TRACK` | 10 |
| Name | Value |
| ------------- | ------------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `ARTIST` | 5 |
| `ALBUM` | 6 |
| `TRACK` | 7 |
| `PHOTO_ALBUM` | 8 |
| `PHOTO` | 9 |

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

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

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

@@ -75,6 +75,7 @@ with PlexAPI(
"content_directory_id": 39486,
"section_id": 2,
"type": operations.Type.TV_SHOW,
"include_meta": operations.IncludeMeta.ENABLE,
})
assert res.object is not None

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

@@ -14,7 +14,7 @@ API Calls interacting with Plex Media Server Libraries
* [get_library_details](#get_library_details) - Get Library Details
* [delete_library](#delete_library) - Delete Library Section
* [get_library_items](#get_library_items) - Get Library Items
* [get_all_media_library](#get_all_media_library) - Get all media of library
* [get_library_sections_all](#get_library_sections_all) - Get Library section media by tag ALL
* [get_refresh_library_metadata](#get_refresh_library_metadata) - Refresh Metadata Of The Library
* [get_search_library](#get_search_library) - Search Library
* [get_genres_library](#get_genres_library) - Get Genres of library media
@@ -106,6 +106,7 @@ with PlexAPI(
],
"section_id": 2,
"type": operations.QueryParamType.TV_SHOW,
"include_meta": operations.QueryParamIncludeMeta.ENABLE,
})
assert res.object is not None
@@ -228,13 +229,14 @@ Each type in the library comes with a set of filters and sorts, aiding in buildi
```python
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
res = plex_api.library.get_library_details(section_key=9518)
res = plex_api.library.get_library_details(section_key=9518, include_details=operations.IncludeDetails.ZERO)
assert res.object is not None
@@ -343,8 +345,10 @@ with PlexAPI(
res = plex_api.library.get_library_items(request={
"tag": operations.Tag.NEWEST,
"include_guids": operations.IncludeGuids.ENABLE,
"type": operations.GetLibraryItemsQueryParamType.TV_SHOW,
"section_key": 9518,
"include_meta": operations.GetLibraryItemsQueryParamIncludeMeta.ENABLE,
})
assert res.object is not None
@@ -373,7 +377,7 @@ with PlexAPI(
| errors.GetLibraryItemsUnauthorized | 401 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## get_all_media_library
## get_library_sections_all
Retrieves a list of all general media data for this library.
@@ -389,9 +393,14 @@ with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
res = plex_api.library.get_all_media_library(request={
res = plex_api.library.get_library_sections_all(request={
"section_key": 9518,
"type": operations.GetAllMediaLibraryQueryParamType.TV_SHOW,
"type": operations.GetLibrarySectionsAllQueryParamType.TV_SHOW,
"include_meta": operations.GetLibrarySectionsAllQueryParamIncludeMeta.ENABLE,
"include_guids": operations.QueryParamIncludeGuids.ENABLE,
"include_advanced": operations.IncludeAdvanced.ENABLE,
"include_collections": operations.QueryParamIncludeCollections.ENABLE,
"include_external_media": operations.QueryParamIncludeExternalMedia.ENABLE,
})
assert res.object is not None
@@ -403,22 +412,22 @@ with PlexAPI(
### Parameters
| Parameter | Type | Required | Description |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `request` | [operations.GetAllMediaLibraryRequest](../../models/operations/getallmedialibraryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
| Parameter | Type | Required | Description |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `request` | [operations.GetLibrarySectionsAllRequest](../../models/operations/getlibrarysectionsallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
### Response
**[operations.GetAllMediaLibraryResponse](../../models/operations/getallmedialibraryresponse.md)**
**[operations.GetLibrarySectionsAllResponse](../../models/operations/getlibrarysectionsallresponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| errors.GetAllMediaLibraryBadRequest | 400 | application/json |
| errors.GetAllMediaLibraryUnauthorized | 401 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
| Error Type | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| errors.GetLibrarySectionsAllBadRequest | 400 | application/json |
| errors.GetLibrarySectionsAllUnauthorized | 401 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## get_refresh_library_metadata
@@ -684,6 +693,8 @@ with PlexAPI(
"search_types": [
operations.SearchTypes.PEOPLE,
],
"include_collections": operations.GetSearchAllLibrariesQueryParamIncludeCollections.ENABLE,
"include_external_media": operations.GetSearchAllLibrariesQueryParamIncludeExternalMedia.ENABLE,
})
assert res.object is not None
@@ -714,7 +725,8 @@ with PlexAPI(
## get_media_meta_data
This endpoint will return all the (meta)data of a library item specified with by the ratingKey.
This endpoint will return all the (meta)data of one or more library items specified by the ratingKey.
Multiple rating keys can be provided as a comma-separated list (e.g., "21119,21617").
### Example Usage
@@ -728,7 +740,7 @@ with PlexAPI(
) as plex_api:
res = plex_api.library.get_media_meta_data(request={
"rating_key": 9518,
"rating_key": "21119,21617",
"include_concerts": True,
"include_extras": True,
"include_on_deck": True,
@@ -994,7 +1006,7 @@ with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
res = plex_api.library.get_top_watched_content(type_=operations.GetTopWatchedContentQueryParamType.TV_SHOW, include_guids=1)
res = plex_api.library.get_top_watched_content(type_=operations.GetTopWatchedContentQueryParamType.TV_SHOW, include_guids=operations.GetTopWatchedContentQueryParamIncludeGuids.ENABLE)
assert res.object is not None
@@ -1008,7 +1020,7 @@ with PlexAPI(
| Parameter | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | [operations.GetTopWatchedContentQueryParamType](../../models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `include_guids` | *Optional[int]* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `include_guids` | [Optional[operations.GetTopWatchedContentQueryParamIncludeGuids]](../../models/operations/gettopwatchedcontentqueryparamincludeguids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response

3
docs/sdks/plex/README.md
View File

@@ -189,13 +189,14 @@ Get Plex server access tokens and server connections
```python
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
res = plex_api.plex.get_server_resources(client_id="3381b62b-9ab7-4e37-827b-203e9809eb58")
res = plex_api.plex.get_server_resources(client_id="3381b62b-9ab7-4e37-827b-203e9809eb58", include_https=operations.IncludeHTTPS.ENABLE, include_relay=operations.IncludeRelay.ENABLE, include_i_pv6=operations.IncludeIPv6.ENABLE)
assert res.plex_devices is not None

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