mirror of
https://github.com/LukeHagar/plexpy.git
synced 2025-12-06 04:20:52 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.401.2
This commit is contained in:
speakeasybot
9
docs/models/operations/action.md
Normal file
9
docs/models/operations/action.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Action
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||
| `id` | *str* | :heavy_check_mark: | N/A | addToContinueWatching |
|
||||
| `key` | *str* | :heavy_check_mark: | N/A | /actions/addToContinueWatching |
|
||||
12
docs/models/operations/activedirection.md
Normal file
12
docs/models/operations/activedirection.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# ActiveDirection
|
||||
|
||||
The direction of the sort. Can be either `asc` or `desc`.
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `ASCENDING` | asc |
|
||||
| `DESCENDING` | desc |
|
||||
8
docs/models/operations/collection.md
Normal file
8
docs/models/operations/collection.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Collection
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||
12
docs/models/operations/defaultdirection.md
Normal file
12
docs/models/operations/defaultdirection.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# DefaultDirection
|
||||
|
||||
The direction of the sort. Can be either `asc` or `desc`.
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `ASCENDING` | asc |
|
||||
| `DESCENDING` | desc |
|
||||
@@ -3,8 +3,12 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||
| `directory` | List[[operations.GetMediaProvidersDirectory](../../models/operations/getmediaprovidersdirectory.md)] | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `type` | *str* | :heavy_check_mark: | N/A | |
|
||||
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | |
|
||||
| `flavor` | *Optional[str]* | :heavy_minus_sign: | N/A | global |
|
||||
| `scrobble_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /:/scrobble/new |
|
||||
| `unscrobble_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /:/unscrobble/new |
|
||||
| `directory` | List[[operations.GetMediaProvidersDirectory](../../models/operations/getmediaprovidersdirectory.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `action` | List[[operations.Action](../../models/operations/action.md)] | :heavy_minus_sign: | N/A | |
|
||||
9
docs/models/operations/flattenseasons.md
Normal file
9
docs/models/operations/flattenseasons.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# FlattenSeasons
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `FALSE` | 0 |
|
||||
| `TRUE` | 1 |
|
||||
10
docs/models/operations/getlibraryitemsimage.md
Normal file
10
docs/models/operations/getlibraryitemsimage.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryItemsImage
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `alt` | *str* | :heavy_check_mark: | N/A | Episode 1 |
|
||||
| `type` | [operations.GetLibraryItemsLibraryResponseType](../../models/operations/getlibraryitemslibraryresponsetype.md) | :heavy_check_mark: | N/A | background |
|
||||
| `url` | *str* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||
11
docs/models/operations/getlibraryitemslibraryresponsetype.md
Normal file
11
docs/models/operations/getlibraryitemslibraryresponsetype.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetLibraryItemsLibraryResponseType
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------- | -------------- |
|
||||
| `COVER_POSTER` | coverPoster |
|
||||
| `BACKGROUND` | background |
|
||||
| `SNAPSHOT` | snapshot |
|
||||
| `CLEAR_LOGO` | clearLogo |
|
||||
14
docs/models/operations/getlibraryitemslibrarytype.md
Normal file
14
docs/models/operations/getlibraryitemslibrarytype.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# GetLibraryItemsLibraryType
|
||||
|
||||
|
||||
## 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 | show |
|
||||
| `title` | *str* | :heavy_check_mark: | N/A | TV Shows |
|
||||
| `active` | *bool* | :heavy_check_mark: | N/A | false |
|
||||
| `filter_` | List[[operations.GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | List[[operations.GetLibraryItemsSort](../../models/operations/getlibraryitemssort.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `field` | List[[operations.GetLibraryItemsField](../../models/operations/getlibraryitemsfield.md)] | :heavy_minus_sign: | N/A | |
|
||||
@@ -5,17 +5,19 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 119534 |
|
||||
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | N/A | 25025 |
|
||||
| `width` | *Optional[int]* | :heavy_minus_sign: | N/A | 3840 |
|
||||
| `height` | *Optional[int]* | :heavy_minus_sign: | N/A | 2072 |
|
||||
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | N/A | 1.85 |
|
||||
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | eac3 |
|
||||
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | N/A | 4k |
|
||||
| `container` | *Optional[str]* | :heavy_minus_sign: | N/A | mkv |
|
||||
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `part` | List[[operations.GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
|
||||
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `bitrate` | *int* | :heavy_check_mark: | N/A | 25025 |
|
||||
| `width` | *int* | :heavy_check_mark: | N/A | 3840 |
|
||||
| `height` | *int* | :heavy_check_mark: | N/A | 2072 |
|
||||
| `aspect_ratio` | *float* | :heavy_check_mark: | N/A | 1.85 |
|
||||
| `audio_channels` | *int* | :heavy_check_mark: | N/A | 6 |
|
||||
| `audio_codec` | *str* | :heavy_check_mark: | N/A | eac3 |
|
||||
| `video_codec` | *str* | :heavy_check_mark: | N/A | hevc |
|
||||
| `video_resolution` | *str* | :heavy_check_mark: | N/A | 4k |
|
||||
| `container` | *str* | :heavy_check_mark: | N/A | mkv |
|
||||
| `video_frame_rate` | *str* | :heavy_check_mark: | N/A | 24p |
|
||||
| `video_profile` | *str* | :heavy_check_mark: | N/A | main 10 |
|
||||
| `part` | List[[operations.GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md)] | :heavy_check_mark: | N/A | |
|
||||
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts |
|
||||
| `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
@@ -6,6 +6,9 @@
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `size` | *int* | :heavy_check_mark: | N/A | 70 |
|
||||
| `total_size` | *int* | :heavy_check_mark: | N/A | 170 |
|
||||
| `offset` | *int* | :heavy_check_mark: | N/A | 0 |
|
||||
| `content` | *str* | :heavy_check_mark: | N/A | secondary |
|
||||
| `allow_sync` | *bool* | :heavy_check_mark: | N/A | true |
|
||||
| `art` | *str* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `identifier` | *str* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
||||
@@ -18,7 +21,8 @@
|
||||
| `title1` | *str* | :heavy_check_mark: | N/A | Movies |
|
||||
| `title2` | *str* | :heavy_check_mark: | N/A | Recently Released |
|
||||
| `view_group` | *str* | :heavy_check_mark: | N/A | movie |
|
||||
| `metadata` | List[[operations.GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md)] | :heavy_check_mark: | N/A | |
|
||||
| `nocache` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `view_mode` | *Optional[int]* | :heavy_minus_sign: | N/A | 65592 |
|
||||
| `mixed_parents` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `metadata` | List[[operations.GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `meta` | [Optional[operations.Meta]](../../models/operations/meta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||
@@ -5,25 +5,30 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `rating_key` | *str* | :heavy_check_mark: | N/A | 58683 |
|
||||
| `rating_key` | *str* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
|
||||
| `key` | *str* | :heavy_check_mark: | N/A | /library/metadata/58683 |
|
||||
| `guid` | *str* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `type` | *str* | :heavy_check_mark: | N/A | movie |
|
||||
| `type` | [operations.GetLibraryItemsType](../../models/operations/getlibraryitemstype.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
||||
| `title` | *str* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||
| `year` | *int* | :heavy_check_mark: | N/A | 2022 |
|
||||
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `media` | List[[operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md)] | :heavy_check_mark: | N/A | |
|
||||
| `summary` | *str* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
||||
| `added_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `studio` | *Optional[str]* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||
| `skip_children` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `slug` | *Optional[str]* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *Optional[str]* | :heavy_minus_sign: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
||||
| `rating` | *Optional[float]* | :heavy_minus_sign: | N/A | 7.6 |
|
||||
| `audience_rating` | *Optional[float]* | :heavy_minus_sign: | N/A | 9.2 |
|
||||
| `year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `season_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `tagline` | *Optional[str]* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||
| `flatten_seasons` | [Optional[operations.FlattenSeasons]](../../models/operations/flattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `show_ordering` | [Optional[operations.ShowOrdering]](../../models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
|
||||
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `banner` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
||||
| `added_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1680457607 |
|
||||
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1703239236 |
|
||||
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `chapter_source` | *Optional[str]* | :heavy_minus_sign: | N/A | media |
|
||||
| `primary_extra_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||
@@ -33,14 +38,19 @@
|
||||
| `grandparent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `grandparent_thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `grandparent_slug` | *Optional[str]* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `grandparent_art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||
| `grandparent_theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| `media` | List[[operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md)] | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
||||
| `genre` | List[[operations.GetLibraryItemsGenre](../../models/operations/getlibraryitemsgenre.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | List[[operations.GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `director` | List[[operations.GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | List[[operations.GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | List[[operations.Collection](../../models/operations/collection.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | List[[operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `media_guid` | List[[operations.MediaGUID](../../models/operations/mediaguid.md)] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||
| `ultra_blur_colors` | [Optional[operations.UltraBlurColors]](../../models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `image` | List[[operations.GetLibraryItemsImage](../../models/operations/getlibraryitemsimage.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `title_sort` | *Optional[str]* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `view_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||
@@ -54,7 +64,7 @@
|
||||
| `child_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `has_premium_extras` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `has_premium_primary_extra` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parent_rating_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 66 |
|
||||
| `parent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
||||
| `parent_guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `parent_studio` | *Optional[str]* | :heavy_minus_sign: | N/A | UCP |
|
||||
| `parent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
|
||||
@@ -5,10 +5,13 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 119542 |
|
||||
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `file` | *Optional[str]* | :heavy_minus_sign: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `size` | *Optional[int]* | :heavy_minus_sign: | N/A | 36158371307 |
|
||||
| `container` | *Optional[str]* | :heavy_minus_sign: | N/A | mkv |
|
||||
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 119542 |
|
||||
| `key` | *str* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `file` | *str* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `size` | *int* | :heavy_check_mark: | N/A | 36158371307 |
|
||||
| `container` | *str* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
||||
| `video_profile` | *str* | :heavy_check_mark: | N/A | main 10 |
|
||||
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts |
|
||||
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
|
||||
| `has_thumbnail` | [Optional[operations.HasThumbnail]](../../models/operations/hasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
@@ -7,8 +7,8 @@
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `section_key` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `tag` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||
| `type` | [operations.Type](../../models/operations/type.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `include_guids` | [Optional[operations.IncludeGuids]](../../models/operations/includeguids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
| `include_meta` | [Optional[operations.IncludeMeta]](../../models/operations/includemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||
| `type` | [Optional[operations.Type]](../../models/operations/type.md) | :heavy_minus_sign: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `x_plex_container_start` | *Optional[int]* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
||||
| `x_plex_container_size` | *Optional[int]* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
||||
@@ -3,11 +3,13 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `default_direction` | *str* | :heavy_check_mark: | N/A | asc |
|
||||
| `key` | *str* | :heavy_check_mark: | N/A | titleSort |
|
||||
| `title` | *str* | :heavy_check_mark: | N/A | Title |
|
||||
| `default` | *Optional[str]* | :heavy_minus_sign: | N/A | asc |
|
||||
| `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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||
| `key` | *str* | :heavy_check_mark: | N/A | titleSort |
|
||||
| `title` | *str* | :heavy_check_mark: | N/A | Title |
|
||||
| `default` | *Optional[str]* | :heavy_minus_sign: | N/A | asc |
|
||||
| `active` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `active_direction` | [Optional[operations.ActiveDirection]](../../models/operations/activedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||
| `default_direction` | [Optional[operations.DefaultDirection]](../../models/operations/defaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||
| `desc_key` | *Optional[str]* | :heavy_minus_sign: | N/A | titleSort:desc |
|
||||
| `first_character_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
||||
@@ -1,14 +1,14 @@
|
||||
# GetLibraryItemsType
|
||||
|
||||
The type of media content
|
||||
|
||||
## 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 | show |
|
||||
| `title` | *str* | :heavy_check_mark: | N/A | TV Shows |
|
||||
| `active` | *bool* | :heavy_check_mark: | N/A | false |
|
||||
| `filter_` | List[[operations.GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | List[[operations.GetLibraryItemsSort](../../models/operations/getlibraryitemssort.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `field` | List[[operations.GetLibraryItemsField](../../models/operations/getlibraryitemsfield.md)] | :heavy_minus_sign: | N/A | |
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `MOVIE` | movie |
|
||||
| `TV_SHOW` | show |
|
||||
| `SEASON` | season |
|
||||
| `EPISODE` | episode |
|
||||
@@ -14,6 +14,6 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `MOVIE` | 1 |
|
||||
| `SHOW` | 2 |
|
||||
| `TV_SHOW` | 2 |
|
||||
| `SEASON` | 3 |
|
||||
| `EPISODE` | 4 |
|
||||
@@ -32,6 +32,7 @@ Logged in user details
|
||||
| `title` | *str* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
|
||||
| `username` | *str* | :heavy_check_mark: | The account username | Username |
|
||||
| `uuid` | *str* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
|
||||
| `attribution_partner` | *Nullable[str]* | :heavy_check_mark: | N/A | <nil> |
|
||||
| `anonymous` | *OptionalNullable[bool]* | :heavy_minus_sign: | Unknown | |
|
||||
| `backup_codes_created` | *Optional[bool]* | :heavy_minus_sign: | If the two-factor authentication backup codes have been created | |
|
||||
| `confirmed` | *Optional[bool]* | :heavy_minus_sign: | If the account has been confirmed | |
|
||||
|
||||
@@ -14,6 +14,6 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `MOVIE` | 1 |
|
||||
| `SHOW` | 2 |
|
||||
| `TV_SHOW` | 2 |
|
||||
| `SEASON` | 3 |
|
||||
| `EPISODE` | 4 |
|
||||
9
docs/models/operations/hasthumbnail.md
Normal file
9
docs/models/operations/hasthumbnail.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# HasThumbnail
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `FALSE` | 0 |
|
||||
| `TRUE` | 1 |
|
||||
@@ -6,7 +6,7 @@ The Meta object is only included in the response if the `includeMeta` parameter
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `type` | List[[operations.GetLibraryItemsType](../../models/operations/getlibraryitemstype.md)] | :heavy_minus_sign: | N/A |
|
||||
| `field_type` | List[[operations.GetLibraryItemsFieldType](../../models/operations/getlibraryitemsfieldtype.md)] | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `type` | List[[operations.GetLibraryItemsLibraryType](../../models/operations/getlibraryitemslibrarytype.md)] | :heavy_minus_sign: | N/A |
|
||||
| `field_type` | List[[operations.GetLibraryItemsFieldType](../../models/operations/getlibraryitemsfieldtype.md)] | :heavy_minus_sign: | N/A |
|
||||
@@ -32,6 +32,7 @@ Returns the user account data with a valid auth token
|
||||
| `title` | *str* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
|
||||
| `username` | *str* | :heavy_check_mark: | The account username | Username |
|
||||
| `uuid` | *str* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
|
||||
| `attribution_partner` | *Nullable[str]* | :heavy_check_mark: | N/A | <nil> |
|
||||
| `past_subscriptions` | List[[operations.PastSubscription](../../models/operations/pastsubscription.md)] | :heavy_check_mark: | N/A | |
|
||||
| `trials` | List[[operations.Trials](../../models/operations/trials.md)] | :heavy_check_mark: | N/A | |
|
||||
| `anonymous` | *OptionalNullable[bool]* | :heavy_minus_sign: | Unknown | |
|
||||
|
||||
@@ -14,6 +14,6 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `MOVIE` | 1 |
|
||||
| `SHOW` | 2 |
|
||||
| `TV_SHOW` | 2 |
|
||||
| `SEASON` | 3 |
|
||||
| `EPISODE` | 4 |
|
||||
20
docs/models/operations/showordering.md
Normal file
20
docs/models/operations/showordering.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# ShowOrdering
|
||||
|
||||
Setting that indicates the episode ordering for the show
|
||||
None = Library default,
|
||||
tmdbAiring = The Movie Database (Aired),
|
||||
aired = TheTVDB (Aired),
|
||||
dvd = TheTVDB (DVD),
|
||||
absolute = TheTVDB (Absolute)).
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `NONE` | None |
|
||||
| `TMDB_AIRING` | tmdbAiring |
|
||||
| `AIRED` | aired |
|
||||
| `DVD` | dvd |
|
||||
| `ABSOLUTE` | absolute |
|
||||
@@ -14,6 +14,6 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `MOVIE` | 1 |
|
||||
| `SHOW` | 2 |
|
||||
| `TV_SHOW` | 2 |
|
||||
| `SEASON` | 3 |
|
||||
| `EPISODE` | 4 |
|
||||
11
docs/models/operations/ultrablurcolors.md
Normal file
11
docs/models/operations/ultrablurcolors.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# UltraBlurColors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `top_left` | *str* | :heavy_check_mark: | N/A | 11333b |
|
||||
| `top_right` | *str* | :heavy_check_mark: | N/A | 0a232d |
|
||||
| `bottom_right` | *str* | :heavy_check_mark: | N/A | 73958 |
|
||||
| `bottom_left` | *str* | :heavy_check_mark: | N/A | 1f5066 |
|
||||
@@ -341,9 +341,9 @@ s = PlexAPI(
|
||||
res = s.library.get_library_items(request={
|
||||
"section_key": 9518,
|
||||
"tag": operations.Tag.EDITION,
|
||||
"type": operations.Type.SHOW,
|
||||
"include_guids": operations.IncludeGuids.ENABLE,
|
||||
"include_meta": operations.IncludeMeta.ENABLE,
|
||||
"type": operations.Type.TV_SHOW,
|
||||
"x_plex_container_start": 0,
|
||||
"x_plex_container_size": 50,
|
||||
})
|
||||
@@ -460,7 +460,7 @@ s = PlexAPI(
|
||||
device_name="Linux",
|
||||
)
|
||||
|
||||
res = s.library.get_search_library(section_key=9518, type_=operations.QueryParamType.SHOW)
|
||||
res = s.library.get_search_library(section_key=9518, type_=operations.QueryParamType.TV_SHOW)
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
@@ -604,7 +604,7 @@ s = PlexAPI(
|
||||
device_name="Linux",
|
||||
)
|
||||
|
||||
res = s.library.get_top_watched_content(type_=operations.GetTopWatchedContentQueryParamType.SHOW, include_guids=1)
|
||||
res = s.library.get_top_watched_content(type_=operations.GetTopWatchedContentQueryParamType.TV_SHOW, include_guids=1)
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
|
||||
@@ -290,7 +290,7 @@ s = PlexAPI(
|
||||
device_name="Linux",
|
||||
)
|
||||
|
||||
res = s.playlists.get_playlist_contents(playlist_id=5004.46, type_=operations.GetPlaylistContentsQueryParamType.SHOW)
|
||||
res = s.playlists.get_playlist_contents(playlist_id=5004.46, type_=operations.GetPlaylistContentsQueryParamType.TV_SHOW)
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
|
||||
Reference in New Issue
Block a user