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

ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.129.1

Browse Source
This commit is contained in:
speakeasybot
2024-01-01 14:37:30 +00:00
parent 4d1564b0b7
commit d69f35d589
621 changed files with 22413 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/Models/Components/Security.md Normal file
View File

@@ -0,0 +1,8 @@
# Security
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `AccessToken` | *string* | :heavy_check_mark: | N/A |

15
docs/Models/Requests/Activity.md Normal file
View File

@@ -0,0 +1,15 @@
# Activity
## Fields
| Field | Type | Required | Description |
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
| `Uuid` | *string* | :heavy_minus_sign: | N/A |
| `Type` | *string* | :heavy_minus_sign: | N/A |
| `Cancellable` | *bool* | :heavy_minus_sign: | N/A |
| `UserID` | *double* | :heavy_minus_sign: | N/A |
| `Title` | *string* | :heavy_minus_sign: | N/A |
| `Subtitle` | *string* | :heavy_minus_sign: | N/A |
| `Progress` | *double* | :heavy_minus_sign: | N/A |
| `Context` | [Context](../../Models/Requests/Context.md) | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/AddPlaylistContentsErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# AddPlaylistContentsErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

10
docs/Models/Requests/AddPlaylistContentsRequest.md Normal file
View File

@@ -0,0 +1,10 @@
# AddPlaylistContentsRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `PlaylistID` | *double* | :heavy_check_mark: | the ID of the playlist | |
| `Uri` | *string* | :heavy_check_mark: | the content URI for the playlist | library://.. |
| `PlayQueueID` | *double* | :heavy_check_mark: | the play queue to add to a playlist | 123 |

11
docs/Models/Requests/AddPlaylistContentsResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# AddPlaylistContentsResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [AddPlaylistContentsResponseBody](../../Models/Requests/AddPlaylistContentsResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/AddPlaylistContentsResponseBody.md Normal file
View 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` | List<[AddPlaylistContentsErrors](../../Models/Requests/AddPlaylistContentsErrors.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/ApplyUpdatesErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# ApplyUpdatesErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

9
docs/Models/Requests/ApplyUpdatesRequest.md Normal file
View File

@@ -0,0 +1,9 @@
# ApplyUpdatesRequest
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Tonight` | [Tonight](../../Models/Requests/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` | [Skip](../../Models/Requests/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/Requests/ApplyUpdatesResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# ApplyUpdatesResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [ApplyUpdatesResponseBody](../../Models/Requests/ApplyUpdatesResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/ApplyUpdatesResponseBody.md Normal file
View 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` | List<[ApplyUpdatesErrors](../../Models/Requests/ApplyUpdatesErrors.md)> | :heavy_minus_sign: | N/A |

13
docs/Models/Requests/ButlerTask.md Normal file
View File

@@ -0,0 +1,13 @@
# ButlerTask
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `Name` | *string* | :heavy_minus_sign: | N/A | BackupDatabase |
| `Interval` | *double* | :heavy_minus_sign: | N/A | 3 |
| `ScheduleRandomized` | *bool* | :heavy_minus_sign: | N/A | |
| `Enabled` | *bool* | :heavy_minus_sign: | N/A | |
| `Title` | *string* | :heavy_minus_sign: | N/A | Backup Database |
| `Description` | *string* | :heavy_minus_sign: | N/A | Create a backup copy of the server's database in the configured backup directory |

8
docs/Models/Requests/ButlerTasks.md Normal file
View File

@@ -0,0 +1,8 @@
# ButlerTasks
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `ButlerTask` | List<[ButlerTask](../../Models/Requests/ButlerTask.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/CancelServerActivitiesErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# CancelServerActivitiesErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

8
docs/Models/Requests/CancelServerActivitiesRequest.md Normal file
View File

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

11
docs/Models/Requests/CancelServerActivitiesResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# CancelServerActivitiesResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [CancelServerActivitiesResponseBody](../../Models/Requests/CancelServerActivitiesResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/CancelServerActivitiesResponseBody.md Normal file
View 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` | List<[CancelServerActivitiesErrors](../../Models/Requests/CancelServerActivitiesErrors.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/CheckForUpdatesErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# CheckForUpdatesErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

8
docs/Models/Requests/CheckForUpdatesRequest.md Normal file
View File

@@ -0,0 +1,8 @@
# CheckForUpdatesRequest
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
| `Download` | [Download](../../Models/Requests/Download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. |

11
docs/Models/Requests/CheckForUpdatesResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# CheckForUpdatesResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [CheckForUpdatesResponseBody](../../Models/Requests/CheckForUpdatesResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/CheckForUpdatesResponseBody.md Normal file
View 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` | List<[CheckForUpdatesErrors](../../Models/Requests/CheckForUpdatesErrors.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/ClearPlaylistContentsErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# ClearPlaylistContentsErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

8
docs/Models/Requests/ClearPlaylistContentsRequest.md Normal file
View File

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

11
docs/Models/Requests/ClearPlaylistContentsResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# ClearPlaylistContentsResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [ClearPlaylistContentsResponseBody](../../Models/Requests/ClearPlaylistContentsResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/ClearPlaylistContentsResponseBody.md Normal file
View 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` | List<[ClearPlaylistContentsErrors](../../Models/Requests/ClearPlaylistContentsErrors.md)> | :heavy_minus_sign: | N/A |

8
docs/Models/Requests/Context.md Normal file
View File

@@ -0,0 +1,8 @@
# Context
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `LibrarySectionID` | *string* | :heavy_minus_sign: | N/A |

8
docs/Models/Requests/Country.md Normal file
View File

@@ -0,0 +1,8 @@
# Country
## Fields
| Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `Tag` | *string* | :heavy_minus_sign: | N/A | United States of America |

10
docs/Models/Requests/CreatePlaylistErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# CreatePlaylistErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

12
docs/Models/Requests/CreatePlaylistRequest.md Normal file
View File

@@ -0,0 +1,12 @@
# CreatePlaylistRequest
## Fields
| Field | Type | Required | Description |
| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
| `Title` | *string* | :heavy_check_mark: | name of the playlist |
| `Type` | [Type](../../Models/Requests/Type.md) | :heavy_check_mark: | type of playlist to create |
| `Smart` | [Smart](../../Models/Requests/Smart.md) | :heavy_check_mark: | whether the playlist is smart or not |
| `Uri` | *string* | :heavy_minus_sign: | the content URI for the playlist |
| `PlayQueueID` | *double* | :heavy_minus_sign: | the play queue to copy to a playlist |

11
docs/Models/Requests/CreatePlaylistResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# CreatePlaylistResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [CreatePlaylistResponseBody](../../Models/Requests/CreatePlaylistResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/CreatePlaylistResponseBody.md Normal file
View 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` | List<[CreatePlaylistErrors](../../Models/Requests/CreatePlaylistErrors.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/DeleteLibraryErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# DeleteLibraryErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

8
docs/Models/Requests/DeleteLibraryRequest.md Normal file
View File

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

11
docs/Models/Requests/DeleteLibraryResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# DeleteLibraryResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [DeleteLibraryResponseBody](../../Models/Requests/DeleteLibraryResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/DeleteLibraryResponseBody.md Normal file
View 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` | List<[DeleteLibraryErrors](../../Models/Requests/DeleteLibraryErrors.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/DeletePlaylistErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# DeletePlaylistErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

8
docs/Models/Requests/DeletePlaylistRequest.md Normal file
View File

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

11
docs/Models/Requests/DeletePlaylistResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# DeletePlaylistResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [DeletePlaylistResponseBody](../../Models/Requests/DeletePlaylistResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/DeletePlaylistResponseBody.md Normal file
View 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` | List<[DeletePlaylistErrors](../../Models/Requests/DeletePlaylistErrors.md)> | :heavy_minus_sign: | N/A |

12
docs/Models/Requests/Device.md Normal file
View File

@@ -0,0 +1,12 @@
# Device
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `Id` | *double* | :heavy_minus_sign: | N/A | 1 |
| `Name` | *string* | :heavy_minus_sign: | N/A | iPhone |
| `Platform` | *string* | :heavy_minus_sign: | N/A | iOS |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | N/A | |
| `CreatedAt` | *double* | :heavy_minus_sign: | N/A | 1654131230 |

8
docs/Models/Requests/Director.md Normal file
View File

@@ -0,0 +1,8 @@
# Director
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `Tag` | *string* | :heavy_minus_sign: | N/A | Peyton Reed |

10
docs/Models/Requests/Directory.md Normal file
View File

@@ -0,0 +1,10 @@
# Directory
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `Count` | *double* | :heavy_minus_sign: | N/A |
| `Key` | *string* | :heavy_minus_sign: | N/A |
| `Title` | *string* | :heavy_minus_sign: | N/A |

11
docs/Models/Requests/Download.md Normal file
View File

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

10
docs/Models/Requests/EnablePaperTrailErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# EnablePaperTrailErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

11
docs/Models/Requests/EnablePaperTrailResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# EnablePaperTrailResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [EnablePaperTrailResponseBody](../../Models/Requests/EnablePaperTrailResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/EnablePaperTrailResponseBody.md Normal file
View 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` | List<[EnablePaperTrailErrors](../../Models/Requests/EnablePaperTrailErrors.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/Errors.md Normal file
View File

@@ -0,0 +1,10 @@
# Errors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

13
docs/Models/Requests/Force.md Normal file
View 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/Requests/Genre.md Normal file
View File

@@ -0,0 +1,8 @@
# Genre
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `Tag` | *string* | :heavy_minus_sign: | N/A | Comedy |

10
docs/Models/Requests/GetAvailableClientsErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetAvailableClientsErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

9
docs/Models/Requests/GetAvailableClientsMediaContainer.md Normal file
View File

@@ -0,0 +1,9 @@
# GetAvailableClientsMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
| `Size` | *double* | :heavy_minus_sign: | N/A | 1 |
| `Server` | List<[Models.Requests.Server](../../Models/Requests/Server.md)> | :heavy_minus_sign: | N/A | |

12
docs/Models/Requests/GetAvailableClientsResponse.md Normal file
View File

@@ -0,0 +1,12 @@
# GetAvailableClientsResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `ResponseBodies` | List<[ResponseBody](../../Models/Requests/ResponseBody.md)> | :heavy_minus_sign: | Available Clients |
| `Object` | [GetAvailableClientsResponseBody](../../Models/Requests/GetAvailableClientsResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/GetAvailableClientsResponseBody.md Normal file
View 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` | List<[GetAvailableClientsErrors](../../Models/Requests/GetAvailableClientsErrors.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/GetButlerTasksButlerResponseBody.md Normal file
View 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` | List<[GetButlerTasksErrors](../../Models/Requests/GetButlerTasksErrors.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/GetButlerTasksErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetButlerTasksErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

12
docs/Models/Requests/GetButlerTasksResponse.md Normal file
View File

@@ -0,0 +1,12 @@
# GetButlerTasksResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `TwoHundredApplicationJsonObject` | [GetButlerTasksResponseBody](../../Models/Requests/GetButlerTasksResponseBody.md) | :heavy_minus_sign: | All butler tasks |
| `FourHundredAndOneApplicationJsonObject` | [GetButlerTasksButlerResponseBody](../../Models/Requests/GetButlerTasksButlerResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/GetButlerTasksResponseBody.md Normal file
View File

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

10
docs/Models/Requests/GetCommonLibraryItemsErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetCommonLibraryItemsErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

10
docs/Models/Requests/GetCommonLibraryItemsRequest.md Normal file
View File

@@ -0,0 +1,10 @@
# GetCommonLibraryItemsRequest
## Fields
| Field | Type | Required | Description |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `SectionId` | *double* | :heavy_check_mark: | the Id of the library to query |
| `Type` | *double* | :heavy_check_mark: | item type |
| `Filter` | *string* | :heavy_minus_sign: | the filter parameter |

11
docs/Models/Requests/GetCommonLibraryItemsResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetCommonLibraryItemsResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [GetCommonLibraryItemsResponseBody](../../Models/Requests/GetCommonLibraryItemsResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/GetCommonLibraryItemsResponseBody.md Normal file
View 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` | List<[GetCommonLibraryItemsErrors](../../Models/Requests/GetCommonLibraryItemsErrors.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/GetDevicesErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetDevicesErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

10
docs/Models/Requests/GetDevicesMediaContainer.md Normal file
View File

@@ -0,0 +1,10 @@
# GetDevicesMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
| `Size` | *double* | :heavy_minus_sign: | N/A | 151 |
| `Identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.system.devices |
| `Device` | List<[Device](../../Models/Requests/Device.md)> | :heavy_minus_sign: | N/A | |

12
docs/Models/Requests/GetDevicesResponse.md Normal file
View File

@@ -0,0 +1,12 @@
# GetDevicesResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `TwoHundredApplicationJsonObject` | [GetDevicesResponseBody](../../Models/Requests/GetDevicesResponseBody.md) | :heavy_minus_sign: | Devices |
| `FourHundredAndOneApplicationJsonObject` | [GetDevicesServerResponseBody](../../Models/Requests/GetDevicesServerResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/GetDevicesResponseBody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetDevicesResponseBody
Devices
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `MediaContainer` | [GetDevicesMediaContainer](../../Models/Requests/GetDevicesMediaContainer.md) | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/GetDevicesServerResponseBody.md Normal file
View 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` | List<[GetDevicesErrors](../../Models/Requests/GetDevicesErrors.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/GetFileHashErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetFileHashErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

9
docs/Models/Requests/GetFileHashRequest.md Normal file
View 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` | *double* | :heavy_minus_sign: | Item type | |

11
docs/Models/Requests/GetFileHashResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetFileHashResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [GetFileHashResponseBody](../../Models/Requests/GetFileHashResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/GetFileHashResponseBody.md Normal file
View 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` | List<[GetFileHashErrors](../../Models/Requests/GetFileHashErrors.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/GetGlobalHubsErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetGlobalHubsErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

9
docs/Models/Requests/GetGlobalHubsRequest.md Normal file
View File

@@ -0,0 +1,9 @@
# GetGlobalHubsRequest
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Count` | *double* | :heavy_minus_sign: | The number of items to return with each hub. |
| `OnlyTransient` | [OnlyTransient](../../Models/Requests/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/Requests/GetGlobalHubsResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetGlobalHubsResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [GetGlobalHubsResponseBody](../../Models/Requests/GetGlobalHubsResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/GetGlobalHubsResponseBody.md Normal file
View 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` | List<[GetGlobalHubsErrors](../../Models/Requests/GetGlobalHubsErrors.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/GetLatestLibraryItemsErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetLatestLibraryItemsErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

10
docs/Models/Requests/GetLatestLibraryItemsRequest.md Normal file
View File

@@ -0,0 +1,10 @@
# GetLatestLibraryItemsRequest
## Fields
| Field | Type | Required | Description |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `SectionId` | *double* | :heavy_check_mark: | the Id of the library to query |
| `Type` | *double* | :heavy_check_mark: | item type |
| `Filter` | *string* | :heavy_minus_sign: | the filter parameter |

11
docs/Models/Requests/GetLatestLibraryItemsResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetLatestLibraryItemsResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [GetLatestLibraryItemsResponseBody](../../Models/Requests/GetLatestLibraryItemsResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/GetLatestLibraryItemsResponseBody.md Normal file
View 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` | List<[GetLatestLibraryItemsErrors](../../Models/Requests/GetLatestLibraryItemsErrors.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/GetLibrariesErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetLibrariesErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

11
docs/Models/Requests/GetLibrariesResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetLibrariesResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [GetLibrariesResponseBody](../../Models/Requests/GetLibrariesResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/GetLibrariesResponseBody.md Normal file
View 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` | List<[GetLibrariesErrors](../../Models/Requests/GetLibrariesErrors.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/GetLibraryErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetLibraryErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

10
docs/Models/Requests/GetLibraryHubsErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetLibraryHubsErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

10
docs/Models/Requests/GetLibraryHubsRequest.md Normal file
View File

@@ -0,0 +1,10 @@
# GetLibraryHubsRequest
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `SectionId` | *double* | :heavy_check_mark: | the Id of the library to query |
| `Count` | *double* | :heavy_minus_sign: | The number of items to return with each hub. |
| `OnlyTransient` | [QueryParamOnlyTransient](../../Models/Requests/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/Requests/GetLibraryHubsResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetLibraryHubsResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [GetLibraryHubsResponseBody](../../Models/Requests/GetLibraryHubsResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/GetLibraryHubsResponseBody.md Normal file
View 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` | List<[GetLibraryHubsErrors](../../Models/Requests/GetLibraryHubsErrors.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/GetLibraryItemsErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetLibraryItemsErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

10
docs/Models/Requests/GetLibraryItemsRequest.md Normal file
View File

@@ -0,0 +1,10 @@
# GetLibraryItemsRequest
## Fields
| Field | Type | Required | Description |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `SectionId` | *double* | :heavy_check_mark: | the Id of the library to query |
| `Type` | *double* | :heavy_minus_sign: | item type |
| `Filter` | *string* | :heavy_minus_sign: | the filter parameter |

11
docs/Models/Requests/GetLibraryItemsResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetLibraryItemsResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [GetLibraryItemsResponseBody](../../Models/Requests/GetLibraryItemsResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/GetLibraryItemsResponseBody.md Normal file
View 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` | List<[GetLibraryItemsErrors](../../Models/Requests/GetLibraryItemsErrors.md)> | :heavy_minus_sign: | N/A |

9
docs/Models/Requests/GetLibraryRequest.md Normal file
View File

@@ -0,0 +1,9 @@
# GetLibraryRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `SectionId` | *double* | :heavy_check_mark: | the Id of the library to query | 1000 |
| `IncludeDetails` | [IncludeDetails](../../Models/Requests/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/Requests/GetLibraryResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetLibraryResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [GetLibraryResponseBody](../../Models/Requests/GetLibraryResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/GetLibraryResponseBody.md Normal file
View 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` | List<[GetLibraryErrors](../../Models/Requests/GetLibraryErrors.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/GetMetadataChildrenErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetMetadataChildrenErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

8
docs/Models/Requests/GetMetadataChildrenRequest.md Normal file
View File

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

11
docs/Models/Requests/GetMetadataChildrenResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetMetadataChildrenResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [GetMetadataChildrenResponseBody](../../Models/Requests/GetMetadataChildrenResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/GetMetadataChildrenResponseBody.md Normal file
View 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` | List<[GetMetadataChildrenErrors](../../Models/Requests/GetMetadataChildrenErrors.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Requests/GetMetadataErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetMetadataErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | *double* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | *double* | :heavy_minus_sign: | N/A | 401 |

8
docs/Models/Requests/GetMetadataRequest.md Normal file
View File

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

11
docs/Models/Requests/GetMetadataResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetMetadataResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [GetMetadataResponseBody](../../Models/Requests/GetMetadataResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/Models/Requests/GetMetadataResponseBody.md Normal file
View 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` | List<[GetMetadataErrors](../../Models/Requests/GetMetadataErrors.md)> | :heavy_minus_sign: | N/A |

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