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

ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.148.0

Browse Source
This commit is contained in:
speakeasybot
2024-01-22 17:16:32 +00:00
parent 63a743f166
commit 46ebaea489
520 changed files with 15857 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -0,0 +1,15 @@
# Activity
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `uuid` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `cancellable` | *Optional[bool]* | :heavy_minus_sign: | N/A |
| `user_id` | *Optional[float]* | :heavy_minus_sign: | N/A |
| `title` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `subtitle` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `progress` | *Optional[float]* | :heavy_minus_sign: | N/A |
| `context` | [Optional[operations.Context]](../../models/operations/context.md) | :heavy_minus_sign: | N/A |

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

@@ -0,0 +1,11 @@
# AddPlaylistContentsMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `size` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `leaf_count_added` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `leaf_count_requested` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `metadata` | List[[operations.AddPlaylistContentsMetadata](../../models/operations/addplaylistcontentsmetadata.md)] | :heavy_minus_sign: | N/A | [{"addedAt":1705716458,"composite":"/playlists/94/composite/1705800070","duration":423000,"guid":"com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2","key":"/playlists/94/items","leafCount":3,"playlistType":"video","ratingKey":"94","smart":false,"summary":"One of my great playlists","title":"A great playlist","type":"playlist","updatedAt":1705800070}] |

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

@@ -0,0 +1,20 @@
# AddPlaylistContentsMetadata
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `rating_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 94 |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | /playlists/94/items |
| `guid` | *Optional[str]* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2 |
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | playlist |
| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | A great playlist |
| `summary` | *Optional[str]* | :heavy_minus_sign: | N/A | One of my great playlists |
| `smart` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `playlist_type` | *Optional[str]* | :heavy_minus_sign: | N/A | video |
| `composite` | *Optional[str]* | :heavy_minus_sign: | N/A | /playlists/94/composite/1705800070 |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 423000 |
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 3 |
| `added_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1705716458 |
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1705800070 |

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

@@ -0,0 +1,10 @@
# AddPlaylistContentsRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| `playlist_id` | *float* | :heavy_check_mark: | the ID of the playlist | |
| `uri` | *str* | :heavy_check_mark: | the content URI for the playlist | server://12345/com.plexapp.plugins.library/library/metadata/1 |
| `play_queue_id` | *Optional[float]* | :heavy_minus_sign: | the play queue to add to a playlist | 123 |

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

@@ -0,0 +1,11 @@
# AddPlaylistContentsResponse
## 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.AddPlaylistContentsResponseBody]](../../models/operations/addplaylistcontentsresponsebody.md) | :heavy_minus_sign: | Playlist Updated |

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

@@ -0,0 +1,10 @@
# AddPlaylistContentsResponseBody
Playlist Updated
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `media_container` | [Optional[operations.AddPlaylistContentsMediaContainer]](../../models/operations/addplaylistcontentsmediacontainer.md) | :heavy_minus_sign: | N/A |

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

@@ -0,0 +1,9 @@
# ApplyUpdatesRequest
## 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`. |

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

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

13
docs/models/operations/butlertask.md Normal file
View File

@@ -0,0 +1,13 @@
# ButlerTask
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | BackupDatabase |
| `interval` | *Optional[float]* | :heavy_minus_sign: | N/A | 3 |
| `schedule_randomized` | *Optional[bool]* | :heavy_minus_sign: | N/A | |
| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | |
| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Backup Database |
| `description` | *Optional[str]* | :heavy_minus_sign: | N/A | Create a backup copy of the server's database in the configured backup directory |

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

@@ -0,0 +1,8 @@
# ButlerTasks
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `butler_task` | List[[operations.ButlerTask](../../models/operations/butlertask.md)] | :heavy_minus_sign: | N/A |

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

@@ -0,0 +1,8 @@
# CancelServerActivitiesRequest
## Fields
| Field | Type | Required | Description |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `activity_uuid` | *str* | :heavy_check_mark: | The UUID of the activity to cancel. |

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

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

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

@@ -0,0 +1,8 @@
# CheckForUpdatesRequest
## 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. |

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

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

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

@@ -0,0 +1,8 @@
# ClearPlaylistContentsRequest
## Fields
| Field | Type | Required | Description |
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `playlist_id` | *float* | :heavy_check_mark: | the ID of the playlist |

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

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

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

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

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

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

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

@@ -0,0 +1,9 @@
# CreatePlaylistMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `size` | *Optional[int]* | :heavy_minus_sign: | N/A | 7 |
| `metadata` | List[[operations.CreatePlaylistMetadata](../../models/operations/createplaylistmetadata.md)] | :heavy_minus_sign: | N/A | [{"addedAt":1705719589,"composite":"/playlists/96/composite/1705724593","duration":141000,"guid":"com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55","icon":"playlist://image.smart","key":"/playlists/96/items","lastViewedAt":1705719589,"leafCount":1,"playlistType":"video","ratingKey":"96","smart":false,"summary":"What a great playlist","title":"A Great Playlist","type":"playlist","updatedAt":1705724593,"viewCount":1}] |

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

@@ -0,0 +1,23 @@
# CreatePlaylistMetadata
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `rating_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 96 |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | /playlists/96/items |
| `guid` | *Optional[str]* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55 |
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | playlist |
| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | A Great Playlist |
| `summary` | *Optional[str]* | :heavy_minus_sign: | N/A | What a great playlist |
| `smart` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `playlist_type` | *Optional[str]* | :heavy_minus_sign: | N/A | video |
| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | playlist://image.smart |
| `view_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1705719589 |
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `added_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1705719589 |
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1705724593 |
| `composite` | *Optional[str]* | :heavy_minus_sign: | N/A | /playlists/96/composite/1705724593 |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 141000 |

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

@@ -0,0 +1,12 @@
# CreatePlaylistRequest
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| `title` | *str* | :heavy_check_mark: | name of the playlist |
| `type` | [operations.Type](../../models/operations/type.md) | :heavy_check_mark: | type of playlist to create |
| `smart` | [operations.Smart](../../models/operations/smart.md) | :heavy_check_mark: | whether the playlist is smart or not |
| `uri` | *str* | :heavy_check_mark: | the content URI for the playlist |
| `play_queue_id` | *Optional[float]* | :heavy_minus_sign: | the play queue to copy to a playlist |

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

@@ -0,0 +1,11 @@
# CreatePlaylistResponse
## 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.CreatePlaylistResponseBody]](../../models/operations/createplaylistresponsebody.md) | :heavy_minus_sign: | returns all playlists |

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

@@ -0,0 +1,10 @@
# CreatePlaylistResponseBody
returns all playlists
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `media_container` | [Optional[operations.CreatePlaylistMediaContainer]](../../models/operations/createplaylistmediacontainer.md) | :heavy_minus_sign: | N/A |

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

@@ -0,0 +1,8 @@
# DeleteLibraryRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `section_id` | *float* | :heavy_check_mark: | the Id of the library to query | 1000 |

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

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

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

@@ -0,0 +1,8 @@
# DeletePlaylistRequest
## Fields
| Field | Type | Required | Description |
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `playlist_id` | *float* | :heavy_check_mark: | the ID of the playlist |

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

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

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

@@ -0,0 +1,12 @@
# Device
## Fields
| Field | Type | Required | Description | Example |
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
| `id` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 |
| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | iPhone |
| `platform` | *Optional[str]* | :heavy_minus_sign: | N/A | iOS |
| `client_identifier` | *Optional[str]* | :heavy_minus_sign: | N/A | |
| `created_at` | *Optional[float]* | :heavy_minus_sign: | N/A | 1654131230 |

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

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

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

@@ -0,0 +1,10 @@
# Directory
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `count` | *Optional[float]* | :heavy_minus_sign: | N/A |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `title` | *Optional[str]* | :heavy_minus_sign: | N/A |

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

@@ -0,0 +1,11 @@
# Download
Indicate that you want to start download any updates found.
## Values
| Name | Value |
| ------ | ------ |
| `ZERO` | 0 |
| `ONE` | 1 |

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

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

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

@@ -0,0 +1,11 @@
# Field
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | label |
| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Label |
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | tag |
| `sub_type` | *Optional[str]* | :heavy_minus_sign: | N/A | bitrate |

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

@@ -0,0 +1,9 @@
# FieldType
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | resolution |
| `operator` | List[[operations.Operator](../../models/operations/operator.md)] | :heavy_minus_sign: | N/A | [{"key":"=","title":"is"}] |

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

@@ -0,0 +1,12 @@
# Filter
## Fields
| Field | Type | Required | Description | Example |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `filter_` | *Optional[str]* | :heavy_minus_sign: | N/A | label |
| `filter_type` | *Optional[str]* | :heavy_minus_sign: | N/A | string |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/1/label |
| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Labels |
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | filter |

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

@@ -0,0 +1,15 @@
# Force
Force overwriting of duplicate playlists.
By default, a playlist file uploaded with the same path will overwrite the existing playlist.
The `force` argument is used to disable overwriting.
If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.
## Values
| Name | Value |
| ------ | ------ |
| `ZERO` | 0 |
| `ONE` | 1 |

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

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

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

@@ -0,0 +1,9 @@
# GetAvailableClientsMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| `size` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 |
| `server` | List[[operations.Server](../../models/operations/server.md)] | :heavy_minus_sign: | N/A | |

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

@@ -0,0 +1,11 @@
# GetAvailableClientsResponse
## 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.GetAvailableClientsResponseBody]](../../models/operations/getavailableclientsresponsebody.md) | :heavy_minus_sign: | Available Clients |

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

@@ -0,0 +1,10 @@
# GetAvailableClientsResponseBody
Available Clients
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `media_container` | [Optional[operations.GetAvailableClientsMediaContainer]](../../models/operations/getavailableclientsmediacontainer.md) | :heavy_minus_sign: | N/A |

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

@@ -0,0 +1,11 @@
# GetButlerTasksResponse
## 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.GetButlerTasksResponseBody]](../../models/operations/getbutlertasksresponsebody.md) | :heavy_minus_sign: | All butler tasks |

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

@@ -0,0 +1,10 @@
# GetButlerTasksResponseBody
All butler tasks
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `butler_tasks` | [Optional[operations.ButlerTasks]](../../models/operations/butlertasks.md) | :heavy_minus_sign: | N/A |

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

@@ -0,0 +1,10 @@
# GetDevicesMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| `size` | *Optional[float]* | :heavy_minus_sign: | N/A | 151 |
| `identifier` | *Optional[str]* | :heavy_minus_sign: | N/A | com.plexapp.system.devices |
| `device` | List[[operations.Device](../../models/operations/device.md)] | :heavy_minus_sign: | N/A | |

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

@@ -0,0 +1,11 @@
# GetDevicesResponse
## 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.GetDevicesResponseBody]](../../models/operations/getdevicesresponsebody.md) | :heavy_minus_sign: | Devices |

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

@@ -0,0 +1,10 @@
# GetDevicesResponseBody
Devices
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `media_container` | [Optional[operations.GetDevicesMediaContainer]](../../models/operations/getdevicesmediacontainer.md) | :heavy_minus_sign: | N/A |

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

@@ -0,0 +1,9 @@
# GetFileHashRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
| `url` | *str* | :heavy_check_mark: | This is the path to the local file, must be prefixed by `file://` | file://C:\Image.png&type=13 |
| `type` | *Optional[float]* | :heavy_minus_sign: | Item type | |

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

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

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

File diff suppressed because one or more lines are too long

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

@@ -0,0 +1,24 @@
# GetGlobalHubsMetadata
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `rating_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 57070 |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | /playlists/57070/items |
| `guid` | *Optional[str]* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c |
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | playlist |
| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | November Movie Day |
| `title_sort` | *Optional[str]* | :heavy_minus_sign: | N/A | Tracks |
| `summary` | *Optional[str]* | :heavy_minus_sign: | N/A | |
| `smart` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `playlist_type` | *Optional[str]* | :heavy_minus_sign: | N/A | video |
| `composite` | *Optional[str]* | :heavy_minus_sign: | N/A | /playlists/57070/composite/1668787730 |
| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | playlist://image.smart |
| `view_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 2 |
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1668787732 |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 16873000 |
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 3 |
| `added_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1668779618 |
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1668787730 |

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

@@ -0,0 +1,9 @@
# GetGlobalHubsRequest
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `count` | *Optional[float]* | :heavy_minus_sign: | The number of items to return with each hub. |
| `only_transient` | [Optional[operations.OnlyTransient]](../../models/operations/onlytransient.md) | :heavy_minus_sign: | Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added). |

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

@@ -0,0 +1,11 @@
# GetGlobalHubsResponse
## 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.GetGlobalHubsResponseBody]](../../models/operations/getglobalhubsresponsebody.md) | :heavy_minus_sign: | returns global hubs |

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

@@ -0,0 +1,10 @@
# GetGlobalHubsResponseBody
returns global hubs
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `media_container` | [Optional[operations.GetGlobalHubsMediaContainer]](../../models/operations/getglobalhubsmediacontainer.md) | :heavy_minus_sign: | N/A |

28
docs/models/operations/getlibrariesdirectory.md Normal file
View File

@@ -0,0 +1,28 @@
# GetLibrariesDirectory
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
| `allow_sync` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `art` | *Optional[str]* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `composite` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/1/composite/1705615584 |
| `filters` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `refreshing` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | movie |
| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Movies |
| `agent` | *Optional[str]* | :heavy_minus_sign: | N/A | tv.plex.agents.movie |
| `scanner` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Movie |
| `language` | *Optional[str]* | :heavy_minus_sign: | N/A | en-US |
| `uuid` | *Optional[str]* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1705615634 |
| `created_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1654131312 |
| `scanned_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1705615584 |
| `content` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `directory` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `content_changed_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 3192854 |
| `hidden` | *Optional[int]* | :heavy_minus_sign: | N/A | 0 |
| `location` | List[[operations.Location](../../models/operations/location.md)] | :heavy_minus_sign: | N/A | [{"id":1,"path":"/movies"}] |

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

@@ -0,0 +1,11 @@
# GetLibrariesMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `size` | *Optional[int]* | :heavy_minus_sign: | N/A | 5 |
| `allow_sync` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `title1` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Library |
| `directory` | List[[operations.GetLibrariesDirectory](../../models/operations/getlibrariesdirectory.md)] | :heavy_minus_sign: | N/A | [{"Location":[{"id":1,"path":"/movies"}],"agent":"tv.plex.agents.movie","allowSync":true,"art":"/:/resources/movie-fanart.jpg","composite":"/library/sections/1/composite/1705615584","content":true,"contentChangedAt":3192854,"createdAt":1654131312,"directory":true,"filters":true,"hidden":0,"key":"1","language":"en-US","refreshing":false,"scannedAt":1705615584,"scanner":"Plex Movie","thumb":"/:/resources/movie.png","title":"Movies","type":"movie","updatedAt":1705615634,"uuid":"322a231a-b7f7-49f5-920f-14c61199cd30"}] |

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

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

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

@@ -0,0 +1,10 @@
# GetLibrariesResponseBody
The libraries available on the Server
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `media_container` | [Optional[operations.GetLibrariesMediaContainer]](../../models/operations/getlibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |

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

@@ -0,0 +1,12 @@
# GetLibraryDirectory
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | search?type=1 |
| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Search... |
| `secondary` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `prompt` | *Optional[str]* | :heavy_minus_sign: | N/A | Search Movies |
| `search` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |

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

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

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

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

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

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

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

File diff suppressed because one or more lines are too long

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

@@ -0,0 +1,24 @@
# GetLibraryHubsMedia
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 38247 |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 6017237 |
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | N/A | 2051 |
| `width` | *Optional[int]* | :heavy_minus_sign: | N/A | 1920 |
| `height` | *Optional[int]* | :heavy_minus_sign: | N/A | 1080 |
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | N/A | 1.78 |
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | N/A | 2 |
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | aac |
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | h264 |
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | N/A | 1080 |
| `container` | *Optional[str]* | :heavy_minus_sign: | N/A | mp4 |
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | N/A | 24p |
| `optimized_for_streaming` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | lc |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | high |
| `part` | List[[operations.GetLibraryHubsPart](../../models/operations/getlibraryhubspart.md)] | :heavy_minus_sign: | N/A | [{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}] |

14
docs/models/operations/getlibraryhubsmediacontainer.md Normal file
View File

File diff suppressed because one or more lines are too long

41
docs/models/operations/getlibraryhubsmetadata.md Normal file
View File

@@ -0,0 +1,41 @@
# GetLibraryHubsMetadata
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `rating_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 14944 |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/14944 |
| `guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://movie/5d77686eeb5d26001f1eb339 |
| `studio` | *Optional[str]* | :heavy_minus_sign: | N/A | Walt Disney Animation Studios |
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | movie |
| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Tangled |
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Movies |
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `library_section_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | N/A | PG |
| `summary` | *Optional[str]* | :heavy_minus_sign: | N/A | The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is. |
| `rating` | *Optional[float]* | :heavy_minus_sign: | N/A | 8.9 |
| `audience_rating` | *Optional[float]* | :heavy_minus_sign: | N/A | 8.7 |
| `view_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1704936047 |
| `year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2010 |
| `tagline` | *Optional[str]* | :heavy_minus_sign: | N/A | They're taking adventure to new lengths. |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/14944/thumb/1705739847 |
| `art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/14944/art/1705739847 |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 6017237 |
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | N/A | 2010-11-24 00:00:00 +0000 UTC |
| `added_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1589412494 |
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1705739847 |
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `primary_extra_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/14952 |
| `rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
| `media` | List[[operations.GetLibraryHubsMedia](../../models/operations/getlibraryhubsmedia.md)] | :heavy_minus_sign: | N/A | [{"Part":[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2051,"container":"mp4","duration":6017237,"has64bitOffsets":false,"height":1080,"id":38247,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}] |
| `genre` | List[[operations.GetLibraryHubsGenre](../../models/operations/getlibraryhubsgenre.md)] | :heavy_minus_sign: | N/A | [{"tag":"Animation"}] |
| `country` | List[[operations.GetLibraryHubsCountry](../../models/operations/getlibraryhubscountry.md)] | :heavy_minus_sign: | N/A | [{"tag":"United States of America"}] |
| `director` | List[[operations.GetLibraryHubsDirector](../../models/operations/getlibraryhubsdirector.md)] | :heavy_minus_sign: | N/A | [{"tag":"Nathan Greno"}] |
| `role` | List[[operations.GetLibraryHubsRole](../../models/operations/getlibraryhubsrole.md)] | :heavy_minus_sign: | N/A | [{"tag":"Donna Murphy"}] |
| `writer` | List[[operations.GetLibraryHubsWriter](../../models/operations/getlibraryhubswriter.md)] | :heavy_minus_sign: | N/A | [{"tag":"Wilhelm Grimm"}] |
| `skip_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `chapter_source` | *Optional[str]* | :heavy_minus_sign: | N/A | media |

17
docs/models/operations/getlibraryhubspart.md Normal file
View File

@@ -0,0 +1,17 @@
# GetLibraryHubsPart
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 38247 |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/parts/38247/1589412494/file.mp4 |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 6017237 |
| `file` | *Optional[str]* | :heavy_minus_sign: | N/A | /movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4 |
| `size` | *Optional[int]* | :heavy_minus_sign: | N/A | 1545647447 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | lc |
| `container` | *Optional[str]* | :heavy_minus_sign: | N/A | mp4 |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | high |

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

@@ -0,0 +1,10 @@
# GetLibraryHubsRequest
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `section_id` | *float* | :heavy_check_mark: | the Id of the library to query |
| `count` | *Optional[float]* | :heavy_minus_sign: | The number of items to return with each hub. |
| `only_transient` | [Optional[operations.QueryParamOnlyTransient]](../../models/operations/queryparamonlytransient.md) | :heavy_minus_sign: | Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added). |

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

@@ -0,0 +1,11 @@
# GetLibraryHubsResponse
## 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.GetLibraryHubsResponseBody]](../../models/operations/getlibraryhubsresponsebody.md) | :heavy_minus_sign: | The hubs specific to the library |

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

@@ -0,0 +1,10 @@
# GetLibraryHubsResponseBody
The hubs specific to the library
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `media_container` | [Optional[operations.GetLibraryHubsMediaContainer]](../../models/operations/getlibraryhubsmediacontainer.md) | :heavy_minus_sign: | N/A |

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

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

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

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

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

@@ -0,0 +1,8 @@
# 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 Normal file
View File

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

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

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

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

@@ -0,0 +1,21 @@
# 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 | [{"container":"mkv","duration":11558112,"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","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}] |

22
docs/models/operations/getlibraryitemsmediacontainer.md Normal file
View File

File diff suppressed because one or more lines are too long

41
docs/models/operations/getlibraryitemsmetadata.md Normal file
View File

@@ -0,0 +1,41 @@
# 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 |
| `media` | List[[operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md)] | :heavy_minus_sign: | N/A | [{"Part":[{"container":"mkv","duration":11558112,"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","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}] |
| `genre` | List[[operations.GetLibraryItemsGenre](../../models/operations/getlibraryitemsgenre.md)] | :heavy_minus_sign: | N/A | [{"tag":"Adventure"}] |
| `country` | List[[operations.GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md)] | :heavy_minus_sign: | N/A | [{"tag":"United States of America"}] |
| `director` | List[[operations.GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md)] | :heavy_minus_sign: | N/A | [{"tag":"James Cameron"}] |
| `writer` | List[[operations.GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md)] | :heavy_minus_sign: | N/A | [{"tag":"James Cameron"}] |
| `role` | List[[operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)] | :heavy_minus_sign: | N/A | [{"tag":"Sigourney Weaver"}] |
| `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 |

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

@@ -0,0 +1,14 @@
# 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 Normal file
View File

@@ -0,0 +1,9 @@
# 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 Normal file
View File

@@ -0,0 +1,11 @@
# 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 Normal file
View File

@@ -0,0 +1,10 @@
# 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 Normal file
View File

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

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

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

22
docs/models/operations/getlibrarymediacontainer.md Normal file
View File

File diff suppressed because one or more lines are too long

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

@@ -0,0 +1,9 @@
# GetLibraryRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `section_id` | *float* | :heavy_check_mark: | the Id of the library to query | 1000 |
| `include_details` | [Optional[operations.IncludeDetails]](../../models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |

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

@@ -0,0 +1,11 @@
# GetLibraryResponse
## 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.GetLibraryResponseBody]](../../models/operations/getlibraryresponsebody.md) | :heavy_minus_sign: | The details of the library |

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

@@ -0,0 +1,10 @@
# GetLibraryResponseBody
The details of the library
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `media_container` | [Optional[operations.GetLibraryMediaContainer]](../../models/operations/getlibrarymediacontainer.md) | :heavy_minus_sign: | N/A |

14
docs/models/operations/getlibrarytype.md Normal file
View File

@@ -0,0 +1,14 @@
# GetLibraryType
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/1/all?type=1 |
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | movie |
| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Movies |
| `active` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `filter_` | List[[operations.Filter](../../models/operations/filter_.md)] | :heavy_minus_sign: | N/A | [{"filter":"label","filterType":"string","key":"/library/sections/1/label","title":"Labels","type":"filter"}] |
| `sort` | List[[operations.Sort](../../models/operations/sort.md)] | :heavy_minus_sign: | N/A | [{"default":"asc","defaultDirection":"desc","descKey":"random:desc","firstCharacterKey":"/library/sections/1/firstCharacter","key":"random","title":"Randomly"}] |
| `field` | List[[operations.Field](../../models/operations/field.md)] | :heavy_minus_sign: | N/A | [{"key":"label","subType":"bitrate","title":"Label","type":"tag"}] |

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

@@ -0,0 +1,12 @@
# GetMetadataChildrenDirectory
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 16 |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/30072/thumb/1705739923 |
| `viewed_leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 16 |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/30072/allLeaves |
| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | All episodes |

30
docs/models/operations/getmetadatachildrenmediacontainer.md Normal file
View File

@@ -0,0 +1,30 @@
# GetMetadataChildrenMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `size` | *Optional[int]* | :heavy_minus_sign: | N/A | 3 |
| `allow_sync` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/30072/art/1705739923 |
| `identifier` | *Optional[str]* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | 30072 |
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | N/A | 2 |
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | N/A | TV Shows |
| `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | N/A | 4bb2521c-8ba9-459b-aaee-8ab8bc35eabd |
| `media_tag_prefix` | *Optional[str]* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `media_tag_version` | *Optional[int]* | :heavy_minus_sign: | N/A | 1701731894 |
| `nocache` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `parent_index` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Reacher |
| `parent_year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
| `summary` | *Optional[str]* | :heavy_minus_sign: | N/A | When retired Military Police Officer Jack Reacher is arrested for a murder he did not commit, he finds himself in the middle of a deadly conspiracy full of dirty cops, shady businessmen, and scheming politicians. With nothing but his wits, he must figure out what is happening in Margrave, Georgia. |
| `theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/30072/theme/1705739923 |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/30072/thumb/1705739923 |
| `title1` | *Optional[str]* | :heavy_minus_sign: | N/A | TV Shows |
| `title2` | *Optional[str]* | :heavy_minus_sign: | N/A | Reacher |
| `view_group` | *Optional[str]* | :heavy_minus_sign: | N/A | season |
| `view_mode` | *Optional[int]* | :heavy_minus_sign: | N/A | 65593 |
| `directory` | List[[operations.GetMetadataChildrenDirectory](../../models/operations/getmetadatachildrendirectory.md)] | :heavy_minus_sign: | N/A | [{"key":"/library/metadata/30072/allLeaves","leafCount":16,"thumb":"/library/metadata/30072/thumb/1705739923","title":"All episodes","viewedLeafCount":16}] |
| `metadata` | List[[operations.GetMetadataChildrenMetadata](../../models/operations/getmetadatachildrenmetadata.md)] | :heavy_minus_sign: | N/A | [{"addedAt":1702602021,"art":"/library/metadata/30072/art/1705739923","guid":"plex://season/652aea6549508477c34c6000","index":2,"key":"/library/metadata/66488/children","lastRatedAt":1703881224,"lastViewedAt":1705646565,"leafCount":8,"parentGuid":"plex://show/5d9c09190aaccd001f8f42f0","parentIndex":1,"parentKey":"/library/metadata/30072","parentRatingKey":"30072","parentStudio":"Amazon Studios","parentTheme":"/library/metadata/30072/theme/1705739923","parentThumb":"/library/metadata/30072/thumb/1705739923","parentTitle":"Reacher","parentYear":2022,"ratingKey":"66488","skipCount":1,"summary":"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.","thumb":"/library/metadata/66488/thumb/1703065033","title":"Season 2","type":"season","updatedAt":1703065033,"userRating":9,"viewCount":11,"viewedLeafCount":8}] |

34
docs/models/operations/getmetadatachildrenmetadata.md Normal file
View File

@@ -0,0 +1,34 @@
# GetMetadataChildrenMetadata
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rating_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 66488 |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66488/children |
| `parent_rating_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 30072 |
| `guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://season/652aea6549508477c34c6000 |
| `parent_guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://show/5d9c09190aaccd001f8f42f0 |
| `parent_studio` | *Optional[str]* | :heavy_minus_sign: | N/A | Amazon Studios |
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | season |
| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Season 2 |
| `parent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/30072 |
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Reacher |
| `summary` | *Optional[str]* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge. |
| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | 2 |
| `parent_index` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `view_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 11 |
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1705646565 |
| `parent_year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66488/thumb/1703065033 |
| `art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/30072/art/1705739923 |
| `parent_thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/30072/thumb/1705739923 |
| `parent_theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/30072/theme/1705739923 |
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 8 |
| `viewed_leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 8 |
| `added_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1702602021 |
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1703065033 |
| `user_rating` | *Optional[int]* | :heavy_minus_sign: | N/A | 9 |
| `skip_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
| `last_rated_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1703881224 |

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

@@ -0,0 +1,8 @@
# GetMetadataChildrenRequest
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `rating_key` | *float* | :heavy_check_mark: | the id of the library item to return the children of. |

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

@@ -0,0 +1,11 @@
# GetMetadataChildrenResponse
## 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.GetMetadataChildrenResponseBody]](../../models/operations/getmetadatachildrenresponsebody.md) | :heavy_minus_sign: | The children of the library item. |

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

@@ -0,0 +1,10 @@
# GetMetadataChildrenResponseBody
The children of the library item.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `media_container` | [Optional[operations.GetMetadataChildrenMediaContainer]](../../models/operations/getmetadatachildrenmediacontainer.md) | :heavy_minus_sign: | N/A |

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

@@ -0,0 +1,10 @@
# GetMetadataCountry
## Fields
| Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 116 |
| `filter_` | *Optional[str]* | :heavy_minus_sign: | N/A | country=116 |
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | United States of America |

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

@@ -0,0 +1,12 @@
# GetMetadataDirector
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 130 |
| `filter_` | *Optional[str]* | :heavy_minus_sign: | N/A | director=130 |
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | Joss Whedon |
| `tag_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 5d776828880197001ec90e8f |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg |

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

@@ -0,0 +1,10 @@
# GetMetadataGenre
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 184 |
| `filter_` | *Optional[str]* | :heavy_minus_sign: | N/A | genre=184 |
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | Thriller |

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

File diff suppressed because one or more lines are too long

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

File diff suppressed because one or more lines are too long

40
docs/models/operations/getmetadatametadata.md Normal file
View File

File diff suppressed because one or more lines are too long

18
docs/models/operations/getmetadatapart.md Normal file
View File

@@ -0,0 +1,18 @@
# GetMetadataPart
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 15 |
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 |
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 141417 |
| `file` | *Optional[str]* | :heavy_minus_sign: | N/A | /movies/Serenity (2005)/Serenity (2005).mp4 |
| `size` | *Optional[int]* | :heavy_minus_sign: | N/A | 40271948 |
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | lc |
| `container` | *Optional[str]* | :heavy_minus_sign: | N/A | mp4 |
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | high |
| `stream` | List[[operations.Stream](../../models/operations/stream.md)] | :heavy_minus_sign: | N/A | [{"bitDepth":8,"bitrate":128,"channels":2,"chromaLocation":"left","chromaSubsampling":14520,"codec":"aac","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","level":40,"profile":"lc","refFrames":4,"samplingRate":44100,"scanType":"progressive","selected":true,"streamIdentifier":"1","streamType":2,"width":1920}] |

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