mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-08 04:20:59 +00:00
ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.129.1
This commit is contained in:
15
docs/models/operations/activity.md
Normal file
15
docs/models/operations/activity.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# Activity
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `uuid` | *T.nilable(String)* | :heavy_minus_sign: | N/A |
|
||||
| `type` | *T.nilable(String)* | :heavy_minus_sign: | N/A |
|
||||
| `cancellable` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A |
|
||||
| `user_id` | *T.nilable(Float)* | :heavy_minus_sign: | N/A |
|
||||
| `title` | *T.nilable(String)* | :heavy_minus_sign: | N/A |
|
||||
| `subtitle` | *T.nilable(String)* | :heavy_minus_sign: | N/A |
|
||||
| `progress` | *T.nilable(Float)* | :heavy_minus_sign: | N/A |
|
||||
| `context` | [T.nilable(Operations::Context)](../../models/operations/context.md) | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/addplaylistcontentserrors.md
Normal file
10
docs/models/operations/addplaylistcontentserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# AddPlaylistContentsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
10
docs/models/operations/addplaylistcontentsrequest.md
Normal file
10
docs/models/operations/addplaylistcontentsrequest.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# AddPlaylistContentsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `playlist_id` | *Float* | :heavy_check_mark: | the ID of the playlist | |
|
||||
| `uri` | *String* | :heavy_check_mark: | the content URI for the playlist | library://.. |
|
||||
| `play_queue_id` | *Float* | :heavy_check_mark: | the play queue to add to a playlist | 123 |
|
||||
11
docs/models/operations/addplaylistcontentsresponse.md
Normal file
11
docs/models/operations/addplaylistcontentsresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# AddPlaylistContentsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::AddPlaylistContentsResponseBody)](../../models/operations/addplaylistcontentsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/addplaylistcontentsresponsebody.md
Normal file
10
docs/models/operations/addplaylistcontentsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# AddPlaylistContentsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::AddPlaylistContentsErrors](../../models/operations/addplaylistcontentserrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/applyupdateserrors.md
Normal file
10
docs/models/operations/applyupdateserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# ApplyUpdatesErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
9
docs/models/operations/applyupdatesrequest.md
Normal file
9
docs/models/operations/applyupdatesrequest.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# ApplyUpdatesRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `tonight` | [T.nilable(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` | [T.nilable(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`. |
|
||||
11
docs/models/operations/applyupdatesresponse.md
Normal file
11
docs/models/operations/applyupdatesresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# ApplyUpdatesResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::ApplyUpdatesResponseBody)](../../models/operations/applyupdatesresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/applyupdatesresponsebody.md
Normal file
10
docs/models/operations/applyupdatesresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# ApplyUpdatesResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::ApplyUpdatesErrors](../../models/operations/applyupdateserrors.md)> | :heavy_minus_sign: | N/A |
|
||||
13
docs/models/operations/butlertask.md
Normal file
13
docs/models/operations/butlertask.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# ButlerTask
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| `name` | *T.nilable(String)* | :heavy_minus_sign: | N/A | BackupDatabase |
|
||||
| `interval` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 3 |
|
||||
| `schedule_randomized` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
|
||||
| `enabled` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
|
||||
| `title` | *T.nilable(String)* | :heavy_minus_sign: | N/A | Backup Database |
|
||||
| `description` | *T.nilable(String)* | :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
8
docs/models/operations/butlertasks.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# ButlerTasks
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `butler_task` | T::Array<[Operations::ButlerTask](../../models/operations/butlertask.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/cancelserveractivitieserrors.md
Normal file
10
docs/models/operations/cancelserveractivitieserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CancelServerActivitiesErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
8
docs/models/operations/cancelserveractivitiesrequest.md
Normal file
8
docs/models/operations/cancelserveractivitiesrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# CancelServerActivitiesRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `activity_uuid` | *String* | :heavy_check_mark: | The UUID of the activity to cancel. |
|
||||
11
docs/models/operations/cancelserveractivitiesresponse.md
Normal file
11
docs/models/operations/cancelserveractivitiesresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# CancelServerActivitiesResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::CancelServerActivitiesResponseBody)](../../models/operations/cancelserveractivitiesresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/cancelserveractivitiesresponsebody.md
Normal file
10
docs/models/operations/cancelserveractivitiesresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CancelServerActivitiesResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::CancelServerActivitiesErrors](../../models/operations/cancelserveractivitieserrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/checkforupdateserrors.md
Normal file
10
docs/models/operations/checkforupdateserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CheckForUpdatesErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
8
docs/models/operations/checkforupdatesrequest.md
Normal file
8
docs/models/operations/checkforupdatesrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# CheckForUpdatesRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| `download` | [T.nilable(Operations::Download)](../../models/operations/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. |
|
||||
11
docs/models/operations/checkforupdatesresponse.md
Normal file
11
docs/models/operations/checkforupdatesresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# CheckForUpdatesResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::CheckForUpdatesResponseBody)](../../models/operations/checkforupdatesresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/checkforupdatesresponsebody.md
Normal file
10
docs/models/operations/checkforupdatesresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CheckForUpdatesResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::CheckForUpdatesErrors](../../models/operations/checkforupdateserrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/clearplaylistcontentserrors.md
Normal file
10
docs/models/operations/clearplaylistcontentserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# ClearPlaylistContentsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
8
docs/models/operations/clearplaylistcontentsrequest.md
Normal file
8
docs/models/operations/clearplaylistcontentsrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# ClearPlaylistContentsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||
| `playlist_id` | *Float* | :heavy_check_mark: | the ID of the playlist |
|
||||
11
docs/models/operations/clearplaylistcontentsresponse.md
Normal file
11
docs/models/operations/clearplaylistcontentsresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# ClearPlaylistContentsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::ClearPlaylistContentsResponseBody)](../../models/operations/clearplaylistcontentsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/clearplaylistcontentsresponsebody.md
Normal file
10
docs/models/operations/clearplaylistcontentsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# ClearPlaylistContentsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::ClearPlaylistContentsErrors](../../models/operations/clearplaylistcontentserrors.md)> | :heavy_minus_sign: | N/A |
|
||||
8
docs/models/operations/context.md
Normal file
8
docs/models/operations/context.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Context
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------- | -------------------- | -------------------- | -------------------- |
|
||||
| `library_section_id` | *T.nilable(String)* | :heavy_minus_sign: | N/A |
|
||||
8
docs/models/operations/country.md
Normal file
8
docs/models/operations/country.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Country
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `tag` | *T.nilable(String)* | :heavy_minus_sign: | N/A | United States of America |
|
||||
10
docs/models/operations/createplaylisterrors.md
Normal file
10
docs/models/operations/createplaylisterrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CreatePlaylistErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
12
docs/models/operations/createplaylistrequest.md
Normal file
12
docs/models/operations/createplaylistrequest.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# CreatePlaylistRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `title` | *String* | :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` | *T.nilable(String)* | :heavy_minus_sign: | the content URI for the playlist |
|
||||
| `play_queue_id` | *T.nilable(Float)* | :heavy_minus_sign: | the play queue to copy to a playlist |
|
||||
11
docs/models/operations/createplaylistresponse.md
Normal file
11
docs/models/operations/createplaylistresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# CreatePlaylistResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::CreatePlaylistResponseBody)](../../models/operations/createplaylistresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/createplaylistresponsebody.md
Normal file
10
docs/models/operations/createplaylistresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CreatePlaylistResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::CreatePlaylistErrors](../../models/operations/createplaylisterrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/deletelibraryerrors.md
Normal file
10
docs/models/operations/deletelibraryerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# DeleteLibraryErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
8
docs/models/operations/deletelibraryrequest.md
Normal file
8
docs/models/operations/deletelibraryrequest.md
Normal 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 |
|
||||
11
docs/models/operations/deletelibraryresponse.md
Normal file
11
docs/models/operations/deletelibraryresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# DeleteLibraryResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::DeleteLibraryResponseBody)](../../models/operations/deletelibraryresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/deletelibraryresponsebody.md
Normal file
10
docs/models/operations/deletelibraryresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# DeleteLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::DeleteLibraryErrors](../../models/operations/deletelibraryerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/deleteplaylisterrors.md
Normal file
10
docs/models/operations/deleteplaylisterrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# DeletePlaylistErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
8
docs/models/operations/deleteplaylistrequest.md
Normal file
8
docs/models/operations/deleteplaylistrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# DeletePlaylistRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||
| `playlist_id` | *Float* | :heavy_check_mark: | the ID of the playlist |
|
||||
11
docs/models/operations/deleteplaylistresponse.md
Normal file
11
docs/models/operations/deleteplaylistresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# DeletePlaylistResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::DeletePlaylistResponseBody)](../../models/operations/deleteplaylistresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/deleteplaylistresponsebody.md
Normal file
10
docs/models/operations/deleteplaylistresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# DeletePlaylistResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::DeletePlaylistErrors](../../models/operations/deleteplaylisterrors.md)> | :heavy_minus_sign: | N/A |
|
||||
12
docs/models/operations/device.md
Normal file
12
docs/models/operations/device.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# Device
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
||||
| `id` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `name` | *T.nilable(String)* | :heavy_minus_sign: | N/A | iPhone |
|
||||
| `platform` | *T.nilable(String)* | :heavy_minus_sign: | N/A | iOS |
|
||||
| `client_identifier` | *T.nilable(String)* | :heavy_minus_sign: | N/A | |
|
||||
| `created_at` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1654131230 |
|
||||
8
docs/models/operations/director.md
Normal file
8
docs/models/operations/director.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Director
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
||||
| `tag` | *T.nilable(String)* | :heavy_minus_sign: | N/A | Peyton Reed |
|
||||
10
docs/models/operations/directory.md
Normal file
10
docs/models/operations/directory.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Directory
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------- | ------------------- | ------------------- | ------------------- |
|
||||
| `count` | *T.nilable(Float)* | :heavy_minus_sign: | N/A |
|
||||
| `key` | *T.nilable(String)* | :heavy_minus_sign: | N/A |
|
||||
| `title` | *T.nilable(String)* | :heavy_minus_sign: | N/A |
|
||||
11
docs/models/operations/download.md
Normal file
11
docs/models/operations/download.md
Normal 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/enablepapertrailerrors.md
Normal file
10
docs/models/operations/enablepapertrailerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# EnablePaperTrailErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/operations/enablepapertrailresponse.md
Normal file
11
docs/models/operations/enablepapertrailresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# EnablePaperTrailResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::EnablePaperTrailResponseBody)](../../models/operations/enablepapertrailresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/enablepapertrailresponsebody.md
Normal file
10
docs/models/operations/enablepapertrailresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# EnablePaperTrailResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::EnablePaperTrailErrors](../../models/operations/enablepapertrailerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/errors.md
Normal file
10
docs/models/operations/errors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Errors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
13
docs/models/operations/force.md
Normal file
13
docs/models/operations/force.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# 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
8
docs/models/operations/genre.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Genre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
||||
| `tag` | *T.nilable(String)* | :heavy_minus_sign: | N/A | Comedy |
|
||||
10
docs/models/operations/getavailableclientserrors.md
Normal file
10
docs/models/operations/getavailableclientserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetAvailableClientsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetAvailableClientsMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `size` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `server` | T::Array<[Operations::Server](../../models/operations/server.md)> | :heavy_minus_sign: | N/A | |
|
||||
12
docs/models/operations/getavailableclientsresponse.md
Normal file
12
docs/models/operations/getavailableclientsresponse.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetAvailableClientsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `response_bodies` | T::Array<[Operations::ResponseBody](../../models/operations/responsebody.md)> | :heavy_minus_sign: | Available Clients |
|
||||
| `object` | [T.nilable(Operations::GetAvailableClientsResponseBody)](../../models/operations/getavailableclientsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/getavailableclientsresponsebody.md
Normal file
10
docs/models/operations/getavailableclientsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetAvailableClientsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::GetAvailableClientsErrors](../../models/operations/getavailableclientserrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/getbutlertasksbutlerresponsebody.md
Normal file
10
docs/models/operations/getbutlertasksbutlerresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetButlerTasksButlerResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::GetButlerTasksErrors](../../models/operations/getbutlertaskserrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/getbutlertaskserrors.md
Normal file
10
docs/models/operations/getbutlertaskserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetButlerTasksErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
12
docs/models/operations/getbutlertasksresponse.md
Normal file
12
docs/models/operations/getbutlertasksresponse.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetButlerTasksResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `two_hundred_application_json_object` | [T.nilable(Operations::GetButlerTasksResponseBody)](../../models/operations/getbutlertasksresponsebody.md) | :heavy_minus_sign: | All butler tasks |
|
||||
| `four_hundred_and_one_application_json_object` | [T.nilable(Operations::GetButlerTasksButlerResponseBody)](../../models/operations/getbutlertasksbutlerresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/getbutlertasksresponsebody.md
Normal file
10
docs/models/operations/getbutlertasksresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetButlerTasksResponseBody
|
||||
|
||||
All butler tasks
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `butler_tasks` | [T.nilable(Operations::ButlerTasks)](../../models/operations/butlertasks.md) | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/getcommonlibraryitemserrors.md
Normal file
10
docs/models/operations/getcommonlibraryitemserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetCommonLibraryItemsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
10
docs/models/operations/getcommonlibraryitemsrequest.md
Normal file
10
docs/models/operations/getcommonlibraryitemsrequest.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetCommonLibraryItemsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||
| `section_id` | *Float* | :heavy_check_mark: | the Id of the library to query |
|
||||
| `type` | *Float* | :heavy_check_mark: | item type |
|
||||
| `filter` | *T.nilable(String)* | :heavy_minus_sign: | the filter parameter |
|
||||
11
docs/models/operations/getcommonlibraryitemsresponse.md
Normal file
11
docs/models/operations/getcommonlibraryitemsresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetCommonLibraryItemsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::GetCommonLibraryItemsResponseBody)](../../models/operations/getcommonlibraryitemsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/getcommonlibraryitemsresponsebody.md
Normal file
10
docs/models/operations/getcommonlibraryitemsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetCommonLibraryItemsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::GetCommonLibraryItemsErrors](../../models/operations/getcommonlibraryitemserrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/getdeviceserrors.md
Normal file
10
docs/models/operations/getdeviceserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetDevicesErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
10
docs/models/operations/getdevicesmediacontainer.md
Normal file
10
docs/models/operations/getdevicesmediacontainer.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetDevicesMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `size` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 151 |
|
||||
| `identifier` | *T.nilable(String)* | :heavy_minus_sign: | N/A | com.plexapp.system.devices |
|
||||
| `device` | T::Array<[Operations::Device](../../models/operations/device.md)> | :heavy_minus_sign: | N/A | |
|
||||
12
docs/models/operations/getdevicesresponse.md
Normal file
12
docs/models/operations/getdevicesresponse.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetDevicesResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `two_hundred_application_json_object` | [T.nilable(Operations::GetDevicesResponseBody)](../../models/operations/getdevicesresponsebody.md) | :heavy_minus_sign: | Devices |
|
||||
| `four_hundred_and_one_application_json_object` | [T.nilable(Operations::GetDevicesServerResponseBody)](../../models/operations/getdevicesserverresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/getdevicesresponsebody.md
Normal file
10
docs/models/operations/getdevicesresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetDevicesResponseBody
|
||||
|
||||
Devices
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `media_container` | [T.nilable(Operations::GetDevicesMediaContainer)](../../models/operations/getdevicesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/getdevicesserverresponsebody.md
Normal file
10
docs/models/operations/getdevicesserverresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetDevicesServerResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::GetDevicesErrors](../../models/operations/getdeviceserrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/getfilehasherrors.md
Normal file
10
docs/models/operations/getfilehasherrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetFileHashErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
9
docs/models/operations/getfilehashrequest.md
Normal file
9
docs/models/operations/getfilehashrequest.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetFileHashRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `url` | *String* | :heavy_check_mark: | This is the path to the local file, must be prefixed by `file://` | file://C:\Image.png&type=13 |
|
||||
| `type` | *T.nilable(Float)* | :heavy_minus_sign: | Item type | |
|
||||
11
docs/models/operations/getfilehashresponse.md
Normal file
11
docs/models/operations/getfilehashresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetFileHashResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::GetFileHashResponseBody)](../../models/operations/getfilehashresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/getfilehashresponsebody.md
Normal file
10
docs/models/operations/getfilehashresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetFileHashResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::GetFileHashErrors](../../models/operations/getfilehasherrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/getglobalhubserrors.md
Normal file
10
docs/models/operations/getglobalhubserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetGlobalHubsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
9
docs/models/operations/getglobalhubsrequest.md
Normal file
9
docs/models/operations/getglobalhubsrequest.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetGlobalHubsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `count` | *T.nilable(Float)* | :heavy_minus_sign: | The number of items to return with each hub. |
|
||||
| `only_transient` | [T.nilable(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
11
docs/models/operations/getglobalhubsresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetGlobalHubsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::GetGlobalHubsResponseBody)](../../models/operations/getglobalhubsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/getglobalhubsresponsebody.md
Normal file
10
docs/models/operations/getglobalhubsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetGlobalHubsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::GetGlobalHubsErrors](../../models/operations/getglobalhubserrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/getlatestlibraryitemserrors.md
Normal file
10
docs/models/operations/getlatestlibraryitemserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLatestLibraryItemsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
10
docs/models/operations/getlatestlibraryitemsrequest.md
Normal file
10
docs/models/operations/getlatestlibraryitemsrequest.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLatestLibraryItemsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||
| `section_id` | *Float* | :heavy_check_mark: | the Id of the library to query |
|
||||
| `type` | *Float* | :heavy_check_mark: | item type |
|
||||
| `filter` | *T.nilable(String)* | :heavy_minus_sign: | the filter parameter |
|
||||
11
docs/models/operations/getlatestlibraryitemsresponse.md
Normal file
11
docs/models/operations/getlatestlibraryitemsresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetLatestLibraryItemsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::GetLatestLibraryItemsResponseBody)](../../models/operations/getlatestlibraryitemsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/getlatestlibraryitemsresponsebody.md
Normal file
10
docs/models/operations/getlatestlibraryitemsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLatestLibraryItemsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::GetLatestLibraryItemsErrors](../../models/operations/getlatestlibraryitemserrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/getlibrarieserrors.md
Normal file
10
docs/models/operations/getlibrarieserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibrariesErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/operations/getlibrariesresponse.md
Normal file
11
docs/models/operations/getlibrariesresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetLibrariesResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::GetLibrariesResponseBody)](../../models/operations/getlibrariesresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/getlibrariesresponsebody.md
Normal file
10
docs/models/operations/getlibrariesresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibrariesResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::GetLibrariesErrors](../../models/operations/getlibrarieserrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/getlibraryerrors.md
Normal file
10
docs/models/operations/getlibraryerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
10
docs/models/operations/getlibraryhubserrors.md
Normal file
10
docs/models/operations/getlibraryhubserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryHubsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
10
docs/models/operations/getlibraryhubsrequest.md
Normal file
10
docs/models/operations/getlibraryhubsrequest.md
Normal 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` | *T.nilable(Float)* | :heavy_minus_sign: | The number of items to return with each hub. |
|
||||
| `only_transient` | [T.nilable(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
11
docs/models/operations/getlibraryhubsresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetLibraryHubsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::GetLibraryHubsResponseBody)](../../models/operations/getlibraryhubsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/getlibraryhubsresponsebody.md
Normal file
10
docs/models/operations/getlibraryhubsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryHubsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::GetLibraryHubsErrors](../../models/operations/getlibraryhubserrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/getlibraryitemserrors.md
Normal file
10
docs/models/operations/getlibraryitemserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryItemsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
10
docs/models/operations/getlibraryitemsrequest.md
Normal file
10
docs/models/operations/getlibraryitemsrequest.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryItemsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||
| `section_id` | *Float* | :heavy_check_mark: | the Id of the library to query |
|
||||
| `type` | *T.nilable(Float)* | :heavy_minus_sign: | item type |
|
||||
| `filter` | *T.nilable(String)* | :heavy_minus_sign: | the filter parameter |
|
||||
11
docs/models/operations/getlibraryitemsresponse.md
Normal file
11
docs/models/operations/getlibraryitemsresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetLibraryItemsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::GetLibraryItemsResponseBody)](../../models/operations/getlibraryitemsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/getlibraryitemsresponsebody.md
Normal file
10
docs/models/operations/getlibraryitemsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryItemsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::GetLibraryItemsErrors](../../models/operations/getlibraryitemserrors.md)> | :heavy_minus_sign: | N/A |
|
||||
9
docs/models/operations/getlibraryrequest.md
Normal file
9
docs/models/operations/getlibraryrequest.md
Normal 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` | [T.nilable(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
11
docs/models/operations/getlibraryresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetLibraryResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::GetLibraryResponseBody)](../../models/operations/getlibraryresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/getlibraryresponsebody.md
Normal file
10
docs/models/operations/getlibraryresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::GetLibraryErrors](../../models/operations/getlibraryerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/getmetadatachildrenerrors.md
Normal file
10
docs/models/operations/getmetadatachildrenerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMetadataChildrenErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
8
docs/models/operations/getmetadatachildrenrequest.md
Normal file
8
docs/models/operations/getmetadatachildrenrequest.md
Normal 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
11
docs/models/operations/getmetadatachildrenresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetMetadataChildrenResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::GetMetadataChildrenResponseBody)](../../models/operations/getmetadatachildrenresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/getmetadatachildrenresponsebody.md
Normal file
10
docs/models/operations/getmetadatachildrenresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMetadataChildrenResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::GetMetadataChildrenErrors](../../models/operations/getmetadatachildrenerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/getmetadataerrors.md
Normal file
10
docs/models/operations/getmetadataerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMetadataErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
8
docs/models/operations/getmetadatarequest.md
Normal file
8
docs/models/operations/getmetadatarequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetMetadataRequest
|
||||
|
||||
|
||||
## 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/getmetadataresponse.md
Normal file
11
docs/models/operations/getmetadataresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetMetadataResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(Operations::GetMetadataResponseBody)](../../models/operations/getmetadataresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/getmetadataresponsebody.md
Normal file
10
docs/models/operations/getmetadataresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMetadataResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[Operations::GetMetadataErrors](../../models/operations/getmetadataerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/getmyplexaccounterrors.md
Normal file
10
docs/models/operations/getmyplexaccounterrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMyPlexAccountErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user