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.285.0

Browse Source
This commit is contained in:
speakeasybot
2024-05-08 18:15:52 +00:00
parent 0547d77a9a
commit d2452a47fc
62 changed files with 879 additions and 1498 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -3,7 +3,7 @@
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tonight` | [Optional[operations.Tonight]](../../models/operations/tonight.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install |
| `skip` | [Optional[operations.Skip]](../../models/operations/skip.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The <Release> entry for this version will have the `state` set to `skipped`. |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tonight` | [Optional[operations.Tonight]](../../models/operations/tonight.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install | 1 |
| `skip` | [Optional[operations.Skip]](../../models/operations/skip.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The <Release> entry for this version will have the `state` set to `skipped`. | 1 |

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

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `activity_uuid` | *str* | :heavy_check_mark: | The UUID of the activity to cancel. |
| Field | Type | Required | Description | Example |
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `activity_uuid` | *str* | :heavy_check_mark: | The UUID of the activity to cancel. | 25b71ed5-0f9d-461c-baa7-d404e9e10d3e |

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

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `download` | [Optional[operations.Download]](../../models/operations/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `download` | [Optional[operations.Download]](../../models/operations/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |

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

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

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

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

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

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

21
docs/models/operations/getlibraryitemsmedia.md
View File

@@ -1,21 +0,0 @@
# GetLibraryItemsMedia
## Fields
| 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 | [<br/>{<br/>"id": 119542,<br/>"key": "/library/parts/119542/1680457526/file.mkv",<br/>"duration": 11558112,<br/>"file": "/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",<br/>"size": 36158371307,<br/>"container": "mkv",<br/>"videoProfile": "main 10"<br/>}<br/>] |

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

File diff suppressed because one or more lines are too long

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

@@ -1,64 +0,0 @@
# GetLibraryItemsMetadata
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rating_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 58683 |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683 |
| `guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
| `studio` | *Optional[str]* | :heavy_minus_sign: | N/A | 20th Century Studios |
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | movie |
| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Avatar: The Way of Water |
| `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 |
| `tagline` | *Optional[str]* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `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 |
| `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 |
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `chapter_source` | *Optional[str]* | :heavy_minus_sign: | N/A | media |
| `primary_extra_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
| `rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
| `grandparent_rating_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 66 |
| `grandparent_guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66 |
| `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Caprica |
| `grandparent_thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `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: | N/A | [<br/>{<br/>"id": 119534,<br/>"duration": 11558112,<br/>"bitrate": 25025,<br/>"width": 3840,<br/>"height": 2072,<br/>"aspectRatio": 1.85,<br/>"audioChannels": 6,<br/>"audioCodec": "eac3",<br/>"videoCodec": "hevc",<br/>"videoResolution": "4k",<br/>"container": "mkv",<br/>"videoFrameRate": "24p",<br/>"videoProfile": "main 10",<br/>"Part": [<br/>{<br/>"id": 119542,<br/>"key": "/library/parts/119542/1680457526/file.mkv",<br/>"duration": 11558112,<br/>"file": "/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",<br/>"size": 36158371307,<br/>"container": "mkv",<br/>"videoProfile": "main 10"<br/>}<br/>]<br/>}<br/>] |
| `genre` | List[[operations.GetLibraryItemsGenre](../../models/operations/getlibraryitemsgenre.md)] | :heavy_minus_sign: | N/A | [<br/>{<br/>"tag": "Adventure"<br/>}<br/>] |
| `country` | List[[operations.GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md)] | :heavy_minus_sign: | N/A | [<br/>{<br/>"tag": "United States of America"<br/>}<br/>] |
| `director` | List[[operations.GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md)] | :heavy_minus_sign: | N/A | [<br/>{<br/>"tag": "James Cameron"<br/>}<br/>] |
| `writer` | List[[operations.GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md)] | :heavy_minus_sign: | N/A | [<br/>{<br/>"tag": "James Cameron"<br/>}<br/>] |
| `role` | List[[operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)] | :heavy_minus_sign: | N/A | [<br/>{<br/>"tag": "Sigourney Weaver"<br/>}<br/>] |
| `title_sort` | *Optional[str]* | :heavy_minus_sign: | N/A | Whale |
| `view_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1682752242 |
| `original_title` | *Optional[str]* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
| `view_offset` | *Optional[int]* | :heavy_minus_sign: | N/A | 5222500 |
| `skip_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 14 |
| `viewed_leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 0 |
| `child_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `has_premium_extras` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
| `has_premium_primary_extra` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
| `parent_rating_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 66 |
| `parent_guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
| `parent_studio` | *Optional[str]* | :heavy_minus_sign: | N/A | UCP |
| `parent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66 |
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Caprica |
| `parent_index` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `parent_year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2010 |
| `parent_thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `parent_theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |

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

@@ -1,14 +0,0 @@
# GetLibraryItemsPart
## Fields
| 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 |

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

@@ -1,9 +0,0 @@
# GetLibraryItemsRequest
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `section_id` | *int* | :heavy_check_mark: | the Id of the library to query |
| `tag` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. |

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

@@ -1,11 +0,0 @@
# GetLibraryItemsResponse
## 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` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional[operations.GetLibraryItemsResponseBody]](../../models/operations/getlibraryitemsresponsebody.md) | :heavy_minus_sign: | The contents of the library by section and tag |

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

@@ -1,10 +0,0 @@
# GetLibraryItemsResponseBody
The contents of the library by section and tag
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `media_container` | [Optional[operations.GetLibraryItemsMediaContainer]](../../models/operations/getlibraryitemsmediacontainer.md) | :heavy_minus_sign: | N/A |

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

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

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

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

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

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `timespan` | *Optional[int]* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `timespan` | *Optional[int]* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |

24
docs/models/operations/gettimelinerequest.md
View File

@@ -3,15 +3,15 @@
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| `rating_key` | *float* | :heavy_check_mark: | The rating key of the media item |
| `key` | *str* | :heavy_check_mark: | The key of the media item to get the timeline for |
| `state` | [operations.State](../../models/operations/state.md) | :heavy_check_mark: | The state of the media item |
| `has_mde` | *float* | :heavy_check_mark: | Whether the media item has MDE |
| `time` | *float* | :heavy_check_mark: | The time of the media item |
| `duration` | *float* | :heavy_check_mark: | The duration of the media item |
| `context` | *str* | :heavy_check_mark: | The context of the media item |
| `play_queue_item_id` | *float* | :heavy_check_mark: | The play queue item ID of the media item |
| `play_back_time` | *float* | :heavy_check_mark: | The playback time of the media item |
| `row` | *float* | :heavy_check_mark: | The row of the media item |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| `rating_key` | *float* | :heavy_check_mark: | The rating key of the media item | 23409 |
| `key` | *str* | :heavy_check_mark: | The key of the media item to get the timeline for | /library/metadata/23409 |
| `state` | [operations.State](../../models/operations/state.md) | :heavy_check_mark: | The state of the media item | playing |
| `has_mde` | *float* | :heavy_check_mark: | Whether the media item has MDE | 1 |
| `time` | *float* | :heavy_check_mark: | The time of the media item | 2000 |
| `duration` | *float* | :heavy_check_mark: | The duration of the media item | 10000 |
| `context` | *str* | :heavy_check_mark: | The context of the media item | home:hub.continueWatching |
| `play_queue_item_id` | *float* | :heavy_check_mark: | The play queue item ID of the media item | 1 |
| `play_back_time` | *float* | :heavy_check_mark: | The playback time of the media item | 2000 |
| `row` | *float* | :heavy_check_mark: | The row of the media item | 1 |

36
docs/models/operations/startuniversaltranscoderequest.md
View File

@@ -3,21 +3,21 @@
## Fields
| Field | Type | Required | Description |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| `has_mde` | *float* | :heavy_check_mark: | Whether the media item has MDE |
| `path` | *str* | :heavy_check_mark: | The path to the media item to transcode |
| `media_index` | *float* | :heavy_check_mark: | The index of the media item to transcode |
| `part_index` | *float* | :heavy_check_mark: | The index of the part to transcode |
| `protocol` | *str* | :heavy_check_mark: | The protocol to use for the transcode session |
| `fast_seek` | *Optional[float]* | :heavy_minus_sign: | Whether to use fast seek or not |
| `direct_play` | *Optional[float]* | :heavy_minus_sign: | Whether to use direct play or not |
| `direct_stream` | *Optional[float]* | :heavy_minus_sign: | Whether to use direct stream or not |
| `subtitle_size` | *Optional[float]* | :heavy_minus_sign: | The size of the subtitles |
| `subtites` | *Optional[str]* | :heavy_minus_sign: | The subtitles |
| `audio_boost` | *Optional[float]* | :heavy_minus_sign: | The audio boost |
| `location` | *Optional[str]* | :heavy_minus_sign: | The location of the transcode session |
| `media_buffer_size` | *Optional[float]* | :heavy_minus_sign: | The size of the media buffer |
| `session` | *Optional[str]* | :heavy_minus_sign: | The session ID |
| `add_debug_overlay` | *Optional[float]* | :heavy_minus_sign: | Whether to add a debug overlay or not |
| `auto_adjust_quality` | *Optional[float]* | :heavy_minus_sign: | Whether to auto adjust quality or not |
| Field | Type | Required | Description | Example |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| `has_mde` | *float* | :heavy_check_mark: | Whether the media item has MDE | 1 |
| `path` | *str* | :heavy_check_mark: | The path to the media item to transcode | /library/metadata/23409 |
| `media_index` | *float* | :heavy_check_mark: | The index of the media item to transcode | 0 |
| `part_index` | *float* | :heavy_check_mark: | The index of the part to transcode | 0 |
| `protocol` | *str* | :heavy_check_mark: | The protocol to use for the transcode session | hls |
| `fast_seek` | *Optional[float]* | :heavy_minus_sign: | Whether to use fast seek or not | 0 |
| `direct_play` | *Optional[float]* | :heavy_minus_sign: | Whether to use direct play or not | 0 |
| `direct_stream` | *Optional[float]* | :heavy_minus_sign: | Whether to use direct stream or not | 0 |
| `subtitle_size` | *Optional[float]* | :heavy_minus_sign: | The size of the subtitles | 100 |
| `subtites` | *Optional[str]* | :heavy_minus_sign: | The subtitles | burn |
| `audio_boost` | *Optional[float]* | :heavy_minus_sign: | The audio boost | 100 |
| `location` | *Optional[str]* | :heavy_minus_sign: | The location of the transcode session | lan |
| `media_buffer_size` | *Optional[float]* | :heavy_minus_sign: | The size of the media buffer | 102400 |
| `session` | *Optional[str]* | :heavy_minus_sign: | The session ID | zvcage8b7rkioqcm8f4uns4c |
| `add_debug_overlay` | *Optional[float]* | :heavy_minus_sign: | Whether to add a debug overlay or not | 0 |
| `auto_adjust_quality` | *Optional[float]* | :heavy_minus_sign: | Whether to auto adjust quality or not | 0 |

28
docs/models/operations/tag.md
View File

@@ -1,28 +0,0 @@
# Tag
A key representing a specific tag within the section.
## Values
| Name | Value |
| ----------------- | ----------------- |
| `ALL` | all |
| `UNWATCHED` | unwatched |
| `NEWEST` | newest |
| `RECENTLY_ADDED` | recentlyAdded |
| `RECENTLY_VIEWED` | recentlyViewed |
| `ON_DECK` | onDeck |
| `COLLECTION` | collection |
| `EDITION` | edition |
| `GENRE` | genre |
| `YEAR` | year |
| `DECADE` | decade |
| `DIRECTOR` | director |
| `ACTOR` | actor |
| `COUNTRY` | country |
| `CONTENT_RATING` | contentRating |
| `RATING` | rating |
| `RESOLUTION` | resolution |
| `FIRST_CHARACTER` | firstCharacter |
| `FOLDER` | folder |

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

@@ -3,8 +3,8 @@
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `key` | *str* | :heavy_check_mark: | the media key |
| `time` | *float* | :heavy_check_mark: | The time, in milliseconds, used to set the media playback progress. |
| `state` | *str* | :heavy_check_mark: | The playback state of the media item. |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `key` | *str* | :heavy_check_mark: | the media key | |
| `time` | *float* | :heavy_check_mark: | The time, in milliseconds, used to set the media playback progress. | 90000 |
| `state` | *str* | :heavy_check_mark: | The playback state of the media item. | played |

10
docs/sdks/activities/README.md
View File

@@ -31,7 +31,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.activities.get_server_activities()
if res.object is not None:
@@ -65,8 +64,7 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.activities.cancel_server_activities(activity_uuid='<value>')
res = s.activities.cancel_server_activities(activity_uuid='25b71ed5-0f9d-461c-baa7-d404e9e10d3e')
if res is not None:
# handle response
@@ -76,9 +74,9 @@ if res is not None:
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `activity_uuid` | *str* | :heavy_check_mark: | The UUID of the activity to cancel. |
| Parameter | Type | Required | Description | Example |
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `activity_uuid` | *str* | :heavy_check_mark: | The UUID of the activity to cancel. | 25b71ed5-0f9d-461c-baa7-d404e9e10d3e |
### Response

2
docs/sdks/authentication/README.md
View File

@@ -27,7 +27,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.authentication.get_transient_token(type=operations.GetTransientTokenQueryParamType.DELEGATION, scope=operations.Scope.ALL)
if res is not None:
@@ -70,7 +69,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.authentication.get_source_connection_information(source='server://client-identifier')
if res is not None:

5
docs/sdks/butler/README.md
View File

@@ -28,7 +28,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.butler.get_butler_tasks()
if res.object is not None:
@@ -67,7 +66,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.butler.start_all_tasks()
if res is not None:
@@ -102,7 +100,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.butler.stop_all_tasks()
if res is not None:
@@ -142,7 +139,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.butler.start_task(task_name=operations.TaskName.CLEAN_OLD_BUNDLES)
if res is not None:
@@ -184,7 +180,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.butler.stop_task(task_name=operations.PathParamTaskName.BACKUP_DATABASE)
if res is not None:

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

@@ -26,7 +26,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.hubs.get_global_hubs(count=1262.49, only_transient=operations.OnlyTransient.ONE)
if res.object is not None:
@@ -69,7 +68,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.hubs.get_library_hubs(section_id=6728.76, count=9010.22, only_transient=operations.QueryParamOnlyTransient.ZERO)
if res.object is not None:

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

@@ -13,7 +13,6 @@ API Calls interacting with Plex Media Server Libraries
* [get_libraries](#get_libraries) - Get All Libraries
* [get_library](#get_library) - Get Library Details
* [delete_library](#delete_library) - Delete Library Section
* [get_library_items](#get_library_items) - Get Library Items
* [refresh_library](#refresh_library) - Refresh Library
* [search_library](#search_library) - Search Library
* [get_metadata](#get_metadata) - Get Items Metadata
@@ -34,7 +33,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.get_file_hash(url='file://C:\Image.png&type=13', type=4462.17)
if res is not None:
@@ -76,7 +74,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.get_recently_added()
if res.object is not None:
@@ -116,7 +113,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.get_libraries()
if res.object is not None:
@@ -190,7 +186,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.get_library(section_id=1000, include_details=operations.IncludeDetails.ZERO)
if res.object is not None:
@@ -231,7 +226,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.delete_library(section_id=1000)
if res is not None:
@@ -257,67 +251,6 @@ if res is not None:
| errors.DeleteLibraryResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## get_library_items
Fetches details from a specific section of the library identified by a section key and a tag. The tag parameter accepts the following values:
- `all`: All items in the section.
- `unwatched`: Items that have not been played.
- `newest`: Items that are recently released.
- `recentlyAdded`: Items that are recently added to the library.
- `recentlyViewed`: Items that were recently viewed.
- `onDeck`: Items to continue watching.
- `collection`: Items categorized by collection.
- `edition`: Items categorized by edition.
- `genre`: Items categorized by genre.
- `year`: Items categorized by year of release.
- `decade`: Items categorized by decade.
- `director`: Items categorized by director.
- `actor`: Items categorized by starring actor.
- `country`: Items categorized by country of origin.
- `contentRating`: Items categorized by content rating.
- `rating`: Items categorized by rating.
- `resolution`: Items categorized by resolution.
- `firstCharacter`: Items categorized by the first letter.
- `folder`: Items categorized by folder.
### Example Usage
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='Postman',
)
res = s.library.get_library_items(section_id=451092, tag=operations.Tag.UNWATCHED)
if res.object is not None:
# handle response
pass
```
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `section_id` | *int* | :heavy_check_mark: | the Id of the library to query |
| `tag` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. |
### Response
**[operations.GetLibraryItemsResponse](../../models/operations/getlibraryitemsresponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| --------------- | --------------- | --------------- |
| errors.SDKError | 4xx-5xx | */* |
## refresh_library
This endpoint Refreshes the library.
@@ -333,7 +266,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.refresh_library(section_id=934.16)
if res is not None:
@@ -392,7 +324,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.search_library(section_id=933505, type=operations.Type.FOUR)
if res.object is not None:
@@ -433,7 +364,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.get_metadata(rating_key=8382.31)
if res.object is not None:
@@ -474,7 +404,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.get_metadata_children(rating_key=1539.14)
if res.object is not None:
@@ -515,7 +444,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.get_on_deck()
if res.object is not None:

8
docs/sdks/log/README.md
View File

@@ -28,7 +28,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.log.log_line(level=operations.Level.THREE, message='Test log message', source='Postman')
if res is not None:
@@ -91,11 +90,9 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
req = 'level=4&message=Test%20message%201&source=postman
res = s.log.log_multi_line(request='level=4&message=Test%20message%201&source=postman
level=3&message=Test%20message%202&source=postman
level=1&message=Test%20message%203&source=postman'
res = s.log.log_multi_line(req)
level=1&message=Test%20message%203&source=postman')
if res is not None:
# handle response
@@ -135,7 +132,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.log.enable_paper_trail()
if res is not None:

15
docs/sdks/media/README.md
View File

@@ -26,7 +26,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.media.mark_played(key=59398)
if res is not None:
@@ -66,7 +65,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.media.mark_unplayed(key=59398)
if res is not None:
@@ -107,8 +105,7 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.media.update_play_progress(key='<value>', time=6900.91, state='<value>')
res = s.media.update_play_progress(key='<value>', time=90000, state='played')
if res is not None:
# handle response
@@ -118,11 +115,11 @@ if res is not None:
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `key` | *str* | :heavy_check_mark: | the media key |
| `time` | *float* | :heavy_check_mark: | The time, in milliseconds, used to set the media playback progress. |
| `state` | *str* | :heavy_check_mark: | The playback state of the media item. |
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `key` | *str* | :heavy_check_mark: | the media key | |
| `time` | *float* | :heavy_check_mark: | The time, in milliseconds, used to set the media playback progress. | 90000 |
| `state` | *str* | :heavy_check_mark: | The playback state of the media item. | played |
### Response

14
docs/sdks/playlists/README.md
View File

@@ -39,14 +39,12 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
req = operations.CreatePlaylistRequest(
res = s.playlists.create_playlist(request=operations.CreatePlaylistRequest(
title='<value>',
type=operations.QueryParamType.PHOTO,
smart=operations.Smart.ONE,
uri='https://inborn-brochure.biz',
)
res = s.playlists.create_playlist(req)
))
if res.object is not None:
# handle response
@@ -86,7 +84,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.playlists.get_playlists(playlist_type=operations.PlaylistType.AUDIO, smart=operations.QueryParamSmart.ZERO)
if res.object is not None:
@@ -129,7 +126,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.playlists.get_playlist(playlist_id=4109.48)
if res.object is not None:
@@ -170,7 +166,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.playlists.delete_playlist(playlist_id=216.22)
if res is not None:
@@ -211,7 +206,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.playlists.update_playlist(playlist_id=3915, title='<value>', summary='<value>')
if res is not None:
@@ -257,7 +251,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.playlists.get_playlist_contents(playlist_id=5004.46, type=9403.59)
if res.object is not None:
@@ -299,7 +292,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.playlists.clear_playlist_contents(playlist_id=1893.18)
if res is not None:
@@ -341,7 +333,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.playlists.add_playlist_contents(playlist_id=8502.01, uri='server://12345/com.plexapp.plugins.library/library/metadata/1', play_queue_id=123)
if res.object is not None:
@@ -385,7 +376,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.playlists.upload_playlist(path='/home/barkley/playlist.m3u', force=operations.Force.ZERO)
if res is not None:

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

@@ -24,7 +24,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.plex.get_pin(strong=False, x_plex_client_identifier='Postman')
if res.object is not None:
@@ -65,7 +64,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.plex.get_token(pin_id='<value>', x_plex_client_identifier='Postman')
if res is not None:

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

@@ -38,7 +38,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.search.perform_search(query='dylan', section_id=1516.53, limit=5)
if res is not None:
@@ -84,7 +83,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.search.perform_voice_search(query='dead+poop', section_id=4094.8, limit=5)
if res is not None:
@@ -126,7 +124,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.search.get_search_results(query='110')
if res.object is not None:

13
docs/sdks/server/README.md
View File

@@ -31,7 +31,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.server.get_server_capabilities()
if res.object is not None:
@@ -65,7 +64,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.server.get_server_preferences()
if res.object is not None:
@@ -99,7 +97,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.server.get_available_clients()
if res.object is not None:
@@ -133,7 +130,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.server.get_devices()
if res.object is not None:
@@ -167,7 +163,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.server.get_server_identity()
if res.object is not None:
@@ -201,7 +196,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.server.get_my_plex_account()
if res.object is not None:
@@ -237,7 +231,7 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
req = operations.GetResizedPhotoRequest(
res = s.server.get_resized_photo(request=operations.GetResizedPhotoRequest(
width=110,
height=165,
blur=20,
@@ -245,9 +239,7 @@ req = operations.GetResizedPhotoRequest(
upscale=operations.Upscale.ZERO,
url='/library/metadata/49564/thumb/1654258204',
opacity=100,
)
res = s.server.get_resized_photo(req)
))
if res is not None:
# handle response
@@ -286,7 +278,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.server.get_server_list()
if res.object is not None:

4
docs/sdks/sessions/README.md
View File

@@ -27,7 +27,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.sessions.get_sessions()
if res.object is not None:
@@ -61,7 +60,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.sessions.get_session_history()
if res.object is not None:
@@ -95,7 +93,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.sessions.get_transcode_sessions()
if res.object is not None:
@@ -129,7 +126,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.sessions.stop_transcode_session(session_key='zz7llzqlx8w9vnrsbnwhbmep')
if res is not None:

9
docs/sdks/statistics/README.md
View File

@@ -24,8 +24,7 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.statistics.get_statistics(timespan=411769)
res = s.statistics.get_statistics(timespan=4)
if res.object is not None:
# handle response
@@ -35,9 +34,9 @@ if res.object is not None:
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `timespan` | *Optional[int]* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> |
| Parameter | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `timespan` | *Optional[int]* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
### Response

19
docs/sdks/updater/README.md
View File

@@ -27,7 +27,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.updater.get_update_status()
if res.object is not None:
@@ -62,7 +61,6 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.updater.check_for_updates(download=operations.Download.ONE)
if res is not None:
@@ -73,9 +71,9 @@ if res is not None:
### Parameters
| Parameter | Type | Required | Description |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `download` | [Optional[operations.Download]](../../models/operations/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. |
| Parameter | Type | Required | Description | Example |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `download` | [Optional[operations.Download]](../../models/operations/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |
### Response
@@ -104,8 +102,7 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.updater.apply_updates(tonight=operations.Tonight.ONE, skip=operations.Skip.ZERO)
res = s.updater.apply_updates(tonight=operations.Tonight.ONE, skip=operations.Skip.ONE)
if res is not None:
# handle response
@@ -115,10 +112,10 @@ if res is not None:
### Parameters
| Parameter | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tonight` | [Optional[operations.Tonight]](../../models/operations/tonight.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install |
| `skip` | [Optional[operations.Skip]](../../models/operations/skip.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The <Release> entry for this version will have the `state` set to `skipped`. |
| Parameter | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tonight` | [Optional[operations.Tonight]](../../models/operations/tonight.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install | 1 |
| `skip` | [Optional[operations.Skip]](../../models/operations/skip.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The <Release> entry for this version will have the `state` set to `skipped`. | 1 |
### Response

53
docs/sdks/video/README.md
View File

@@ -26,20 +26,18 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
req = operations.GetTimelineRequest(
rating_key=716.56,
key='<key>',
state=operations.State.PAUSED,
has_mde=7574.33,
time=3327.51,
duration=7585.39,
context='<value>',
play_queue_item_id=1406.21,
play_back_time=2699.34,
row=3536.42,
)
res = s.video.get_timeline(req)
res = s.video.get_timeline(request=operations.GetTimelineRequest(
rating_key=23409,
key='/library/metadata/23409',
state=operations.State.PLAYING,
has_mde=1,
time=2000,
duration=10000,
context='home:hub.continueWatching',
play_queue_item_id=1,
play_back_time=2000,
row=1,
))
if res is not None:
# handle response
@@ -79,15 +77,24 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
req = operations.StartUniversalTranscodeRequest(
has_mde=8924.99,
path='/etc/mail',
media_index=9962.95,
part_index=1232.82,
protocol='<value>',
)
res = s.video.start_universal_transcode(req)
res = s.video.start_universal_transcode(request=operations.StartUniversalTranscodeRequest(
has_mde=1,
path='/library/metadata/23409',
media_index=0,
part_index=0,
protocol='hls',
fast_seek=0,
direct_play=0,
direct_stream=0,
subtitle_size=100,
subtites='burn',
audio_boost=100,
location='lan',
media_buffer_size=102400,
session='zvcage8b7rkioqcm8f4uns4c',
add_debug_overlay=0,
auto_adjust_quality=0,
))
if res is not None:
# handle response