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 , Speakeasy CLI 1.390.7

Browse Source
This commit is contained in:
speakeasybot
2024-09-06 00:00:16 +00:00
parent e2d3ad2f38
commit 2b03eae316
225 changed files with 3354 additions and 1125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Models/Errors/GetResourcesErrors.md → docs/Models/Errors/GetBannerImageErrors.md
View File

@@ -1,4 +1,4 @@
# GetResourcesErrors
# GetBannerImageErrors
## Fields

4
docs/Models/Errors/GetResourcesResponseBody.md → docs/Models/Errors/GetBannerImageResponseBody.md
View File

@@ -1,4 +1,4 @@
# GetResourcesResponseBody
# GetBannerImageResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
@@ -7,5 +7,5 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `Errors` | List<[GetResourcesErrors](../../Models/Errors/GetResourcesErrors.md)> | :heavy_minus_sign: | N/A |
| `Errors` | List<[GetBannerImageErrors](../../Models/Errors/GetBannerImageErrors.md)> | :heavy_minus_sign: | N/A |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

2
docs/Models/Errors/GetServerIdentityErrors.md → docs/Models/Errors/GetMediaProvidersErrors.md
View File

@@ -1,4 +1,4 @@
# GetServerIdentityErrors
# GetMediaProvidersErrors
## Fields

11
docs/Models/Errors/GetMediaProvidersResponseBody.md Normal file
View File

@@ -0,0 +1,11 @@
# GetMediaProvidersResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `Errors` | List<[GetMediaProvidersErrors](../../Models/Errors/GetMediaProvidersErrors.md)> | :heavy_minus_sign: | N/A |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

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

@@ -0,0 +1,10 @@
# GetMetaDataByRatingKeyErrors
## 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/Errors/GetMetaDataByRatingKeyResponseBody.md Normal file
View File

@@ -0,0 +1,11 @@
# GetMetaDataByRatingKeyResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `Errors` | List<[GetMetaDataByRatingKeyErrors](../../Models/Errors/GetMetaDataByRatingKeyErrors.md)> | :heavy_minus_sign: | N/A |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

2
docs/Models/Errors/GetWatchlistErrors.md → docs/Models/Errors/GetSearchLibraryErrors.md
View File

@@ -1,4 +1,4 @@
# GetWatchlistErrors
# GetSearchLibraryErrors
## Fields

4
docs/Models/Errors/SearchLibraryResponseBody.md → docs/Models/Errors/GetSearchLibraryResponseBody.md
View File

@@ -1,4 +1,4 @@
# SearchLibraryResponseBody
# GetSearchLibraryResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
@@ -7,5 +7,5 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `Errors` | List<[SearchLibraryErrors](../../Models/Errors/SearchLibraryErrors.md)> | :heavy_minus_sign: | N/A |
| `Errors` | List<[GetSearchLibraryErrors](../../Models/Errors/GetSearchLibraryErrors.md)> | :heavy_minus_sign: | N/A |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

11
docs/Models/Errors/GetServerIdentityResponseBody.md
View File

@@ -1,11 +1,12 @@
# GetServerIdentityResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
Request Timeout
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `Errors` | List<[GetServerIdentityErrors](../../Models/Errors/GetServerIdentityErrors.md)> | :heavy_minus_sign: | N/A |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `Code` | *long* | :heavy_minus_sign: | N/A | 408 |
| `Message` | *string* | :heavy_minus_sign: | N/A | The server timed out waiting for the request. |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |

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

@@ -0,0 +1,10 @@
# GetServerResourcesErrors
## 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/Errors/GetServerResourcesResponseBody.md Normal file
View File

@@ -0,0 +1,11 @@
# GetServerResourcesResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `Errors` | List<[GetServerResourcesErrors](../../Models/Errors/GetServerResourcesErrors.md)> | :heavy_minus_sign: | N/A |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

2
docs/Models/Errors/SearchLibraryErrors.md → docs/Models/Errors/GetThumbImageErrors.md
View File

@@ -1,4 +1,4 @@
# SearchLibraryErrors
# GetThumbImageErrors
## Fields

4
docs/Models/Errors/GetMetadataResponseBody.md → docs/Models/Errors/GetThumbImageResponseBody.md
View File

@@ -1,4 +1,4 @@
# GetMetadataResponseBody
# GetThumbImageResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
@@ -7,5 +7,5 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `Errors` | List<[GetMetadataErrors](../../Models/Errors/GetMetadataErrors.md)> | :heavy_minus_sign: | N/A |
| `Errors` | List<[GetThumbImageErrors](../../Models/Errors/GetThumbImageErrors.md)> | :heavy_minus_sign: | N/A |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

9
docs/Models/Errors/GetTokenByPinIdErrors.md
View File

@@ -3,7 +3,8 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `Code` | *long* | :heavy_minus_sign: | N/A | 1020 |
| `Message` | *string* | :heavy_minus_sign: | N/A | Code not found or expired |
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `Code` | *long* | :heavy_minus_sign: | N/A | 1000 |
| `Message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
| `Status` | *long* | :heavy_minus_sign: | N/A | 400 |

9
docs/Models/Errors/GetTokenByPinIdPlexErrors.md Normal file
View File

@@ -0,0 +1,9 @@
# GetTokenByPinIdPlexErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `Code` | *long* | :heavy_minus_sign: | N/A | 1020 |
| `Message` | *string* | :heavy_minus_sign: | N/A | Code not found or expired |

11
docs/Models/Errors/GetTokenByPinIdPlexResponseBody.md Normal file
View File

@@ -0,0 +1,11 @@
# GetTokenByPinIdPlexResponseBody
Not Found or Expired
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `Errors` | List<[GetTokenByPinIdPlexErrors](../../Models/Errors/GetTokenByPinIdPlexErrors.md)> | :heavy_minus_sign: | N/A |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

2
docs/Models/Errors/GetTokenByPinIdResponseBody.md
View File

@@ -1,6 +1,6 @@
# GetTokenByPinIdResponseBody
Not Found or Expired
Bad Request response when the X-Plex-Client-Identifier is missing
## Fields

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

@@ -0,0 +1,10 @@
# GetTopWatchedContentErrors
## 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/Errors/GetTopWatchedContentResponseBody.md Normal file
View File

@@ -0,0 +1,11 @@
# GetTopWatchedContentResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `Errors` | List<[GetTopWatchedContentErrors](../../Models/Errors/GetTopWatchedContentErrors.md)> | :heavy_minus_sign: | N/A |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

2
docs/Models/Errors/GetMetadataErrors.md → docs/Models/Errors/GetWatchListErrors.md
View File

@@ -1,4 +1,4 @@
# GetMetadataErrors
# GetWatchListErrors
## Fields

4
docs/Models/Errors/GetWatchlistResponseBody.md → docs/Models/Errors/GetWatchListResponseBody.md
View File

@@ -1,4 +1,4 @@
# GetWatchlistResponseBody
# GetWatchListResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
@@ -7,5 +7,5 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `Errors` | List<[GetWatchlistErrors](../../Models/Errors/GetWatchlistErrors.md)> | :heavy_minus_sign: | N/A |
| `Errors` | List<[GetWatchListErrors](../../Models/Errors/GetWatchListErrors.md)> | :heavy_minus_sign: | N/A |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

2
docs/Models/Requests/ApplyUpdatesRequest.md
View File

@@ -6,4 +6,4 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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 | 1 |
| `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`. | 1 |
| `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`. | 1 |

14
docs/Models/Requests/Connections.md
View File

@@ -5,10 +5,10 @@
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `Protocol` | *string* | :heavy_minus_sign: | N/A |
| `Address` | *string* | :heavy_minus_sign: | N/A |
| `Port` | *double* | :heavy_minus_sign: | N/A |
| `Uri` | *string* | :heavy_minus_sign: | N/A |
| `Local` | *bool* | :heavy_minus_sign: | N/A |
| `Relay` | *bool* | :heavy_minus_sign: | N/A |
| `IPv6` | *bool* | :heavy_minus_sign: | N/A |
| `Protocol` | *string* | :heavy_check_mark: | N/A |
| `Address` | *string* | :heavy_check_mark: | N/A |
| `Port` | *double* | :heavy_check_mark: | N/A |
| `Uri` | *string* | :heavy_check_mark: | N/A |
| `Local` | *bool* | :heavy_check_mark: | N/A |
| `Relay` | *bool* | :heavy_check_mark: | N/A |
| `IPv6` | *bool* | :heavy_check_mark: | N/A |

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

@@ -0,0 +1,12 @@
# CreatePlaylistQueryParamType
type of playlist to create
## Values
| Name | Value |
| ------- | ------- |
| `Audio` | audio |
| `Video` | video |
| `Photo` | photo |

14
docs/Models/Requests/CreatePlaylistRequest.md
View File

@@ -3,10 +3,10 @@
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
| `Title` | *string* | :heavy_check_mark: | name of the playlist |
| `Type` | [QueryParamType](../../Models/Requests/QueryParamType.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_check_mark: | the content URI for the playlist |
| `PlayQueueID` | *double* | :heavy_minus_sign: | the play queue to copy to a playlist |
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `Title` | *string* | :heavy_check_mark: | name of the playlist |
| `Type` | [CreatePlaylistQueryParamType](../../Models/Requests/CreatePlaylistQueryParamType.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_check_mark: | the content URI for the playlist |
| `PlayQueueID` | *double* | :heavy_minus_sign: | the play queue to copy to a playlist |

6
docs/Models/Requests/DeleteLibraryRequest.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `SectionId` | *double* | :heavy_check_mark: | The id of the library | 15 |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |

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

@@ -0,0 +1,10 @@
# Feature
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `Key` | *string* | :heavy_minus_sign: | N/A |
| `Type` | *string* | :heavy_minus_sign: | N/A |
| `Directory` | List<[GetMediaProvidersDirectory](../../Models/Requests/GetMediaProvidersDirectory.md)> | :heavy_minus_sign: | N/A |

13
docs/Models/Requests/Filter.md
View File

@@ -1,11 +1,12 @@
# Filter
Filters content by field and direction/equality
(Unknown if viewedAt is the only supported column)
Filter
## Values
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |
| Name | Value |
| ----------- | ----------- |
| `All` | all |
| `Available` | available |
| `Released` | released |

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

@@ -0,0 +1,13 @@
# GetBannerImageRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `RatingKey` | *long* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
| `Width` | *long* | :heavy_check_mark: | N/A | 396 |
| `Height` | *long* | :heavy_check_mark: | N/A | 396 |
| `MinSize` | *long* | :heavy_check_mark: | N/A | 1 |
| `Upscale` | *long* | :heavy_check_mark: | N/A | 1 |
| `XPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |

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

@@ -0,0 +1,12 @@
# GetBannerImageResponse
## 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 |
| `Bytes` | *byte[]* | :heavy_minus_sign: | Successful response returning an image |
| `Headers` | Dictionary<String, List<*string*>> | :heavy_check_mark: | N/A |

2
docs/Models/Requests/GetLibraryDetailsRequest.md
View File

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `SectionId` | *double* | :heavy_check_mark: | The id of the library | 15 |
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `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/> | |

14
docs/Models/Requests/GetLibraryItemsRequest.md
View File

@@ -3,8 +3,12 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `SectionId` | *object* | :heavy_check_mark: | the Id of the library to query | |
| `Tag` | [Tag](../../Models/Requests/Tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
| `IncludeGuids` | *long* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `Tag` | [Tag](../../Models/Requests/Tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
| `Type` | [Models.Requests.Type](../../Models/Requests/Type.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `IncludeGuids` | [IncludeGuids](../../Models/Requests/IncludeGuids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `IncludeMeta` | [IncludeMeta](../../Models/Requests/IncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `XPlexContainerStart` | *int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `XPlexContainerSize` | *int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |

21
docs/Models/Requests/GetMediaProvidersDirectory.md Normal file
View File

@@ -0,0 +1,21 @@
# GetMediaProvidersDirectory
## Fields
| Field | Type | Required | Description |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| `HubKey` | *string* | :heavy_minus_sign: | N/A |
| `Title` | *string* | :heavy_minus_sign: | N/A |
| `Agent` | *string* | :heavy_minus_sign: | N/A |
| `Language` | *string* | :heavy_minus_sign: | N/A |
| `Refreshing` | *bool* | :heavy_minus_sign: | N/A |
| `Scanner` | *string* | :heavy_minus_sign: | N/A |
| `Uuid` | *string* | :heavy_minus_sign: | N/A |
| `Id` | *string* | :heavy_minus_sign: | N/A |
| `Key` | *string* | :heavy_minus_sign: | N/A |
| `Type` | *string* | :heavy_minus_sign: | N/A |
| `Subtype` | *string* | :heavy_minus_sign: | N/A |
| `UpdatedAt` | *long* | :heavy_minus_sign: | N/A |
| `ScannedAt` | *long* | :heavy_minus_sign: | N/A |
| `Pivot` | List<[Pivot](../../Models/Requests/Pivot.md)> | :heavy_minus_sign: | N/A |

51
docs/Models/Requests/GetMediaProvidersMediaContainer.md Normal file
View File

@@ -0,0 +1,51 @@
# GetMediaProvidersMediaContainer
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| `Size` | *long* | :heavy_minus_sign: | N/A |
| `AllowCameraUpload` | *bool* | :heavy_minus_sign: | N/A |
| `AllowChannelAccess` | *bool* | :heavy_minus_sign: | N/A |
| `AllowSharing` | *bool* | :heavy_minus_sign: | N/A |
| `AllowSync` | *bool* | :heavy_minus_sign: | N/A |
| `AllowTuners` | *bool* | :heavy_minus_sign: | N/A |
| `BackgroundProcessing` | *bool* | :heavy_minus_sign: | N/A |
| `Certificate` | *bool* | :heavy_minus_sign: | N/A |
| `CompanionProxy` | *bool* | :heavy_minus_sign: | N/A |
| `CountryCode` | *string* | :heavy_minus_sign: | N/A |
| `Diagnostics` | *string* | :heavy_minus_sign: | N/A |
| `EventStream` | *bool* | :heavy_minus_sign: | N/A |
| `FriendlyName` | *string* | :heavy_minus_sign: | N/A |
| `Livetv` | *long* | :heavy_minus_sign: | N/A |
| `MachineIdentifier` | *string* | :heavy_minus_sign: | N/A |
| `MusicAnalysis` | *long* | :heavy_minus_sign: | N/A |
| `MyPlex` | *bool* | :heavy_minus_sign: | N/A |
| `MyPlexMappingState` | *string* | :heavy_minus_sign: | N/A |
| `MyPlexSigninState` | *string* | :heavy_minus_sign: | N/A |
| `MyPlexSubscription` | *bool* | :heavy_minus_sign: | N/A |
| `MyPlexUsername` | *string* | :heavy_minus_sign: | N/A |
| `OfflineTranscode` | *long* | :heavy_minus_sign: | N/A |
| `OwnerFeatures` | *string* | :heavy_minus_sign: | N/A |
| `Platform` | *string* | :heavy_minus_sign: | N/A |
| `PlatformVersion` | *string* | :heavy_minus_sign: | N/A |
| `PluginHost` | *bool* | :heavy_minus_sign: | N/A |
| `PushNotifications` | *bool* | :heavy_minus_sign: | N/A |
| `ReadOnlyLibraries` | *bool* | :heavy_minus_sign: | N/A |
| `StreamingBrainABRVersion` | *long* | :heavy_minus_sign: | N/A |
| `StreamingBrainVersion` | *long* | :heavy_minus_sign: | N/A |
| `Sync` | *bool* | :heavy_minus_sign: | N/A |
| `TranscoderActiveVideoSessions` | *long* | :heavy_minus_sign: | N/A |
| `TranscoderAudio` | *bool* | :heavy_minus_sign: | N/A |
| `TranscoderLyrics` | *bool* | :heavy_minus_sign: | N/A |
| `TranscoderSubtitles` | *bool* | :heavy_minus_sign: | N/A |
| `TranscoderVideo` | *bool* | :heavy_minus_sign: | N/A |
| `TranscoderVideoBitrates` | *string* | :heavy_minus_sign: | N/A |
| `TranscoderVideoQualities` | *string* | :heavy_minus_sign: | N/A |
| `TranscoderVideoResolutions` | *string* | :heavy_minus_sign: | N/A |
| `UpdatedAt` | *long* | :heavy_minus_sign: | N/A |
| `Updater` | *bool* | :heavy_minus_sign: | N/A |
| `Version` | *string* | :heavy_minus_sign: | N/A |
| `VoiceSearch` | *bool* | :heavy_minus_sign: | N/A |
| `MediaProvider` | List<[MediaProvider](../../Models/Requests/MediaProvider.md)> | :heavy_minus_sign: | N/A |

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

@@ -0,0 +1,8 @@
# GetMediaProvidersRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `XPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |

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

@@ -0,0 +1,11 @@
# GetMediaProvidersResponse
## 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` | [Models.Requests.GetMediaProvidersResponseBody](../../Models/Requests/GetMediaProvidersResponseBody.md) | :heavy_minus_sign: | Media providers and their features |

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

@@ -0,0 +1,10 @@
# GetMediaProvidersResponseBody
Media providers and their features
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `MediaContainer` | [GetMediaProvidersMediaContainer](../../Models/Requests/GetMediaProvidersMediaContainer.md) | :heavy_minus_sign: | N/A |

2
docs/Models/Requests/GetMetadataCountry.md → docs/Models/Requests/GetMetaDataByRatingKeyCountry.md
View File

@@ -1,4 +1,4 @@
# GetMetadataCountry
# GetMetaDataByRatingKeyCountry
## Fields

2
docs/Models/Requests/GetMetadataDirector.md → docs/Models/Requests/GetMetaDataByRatingKeyDirector.md
View File

@@ -1,4 +1,4 @@
# GetMetadataDirector
# GetMetaDataByRatingKeyDirector
## Fields

2
docs/Models/Requests/GetMetadataGenre.md → docs/Models/Requests/GetMetaDataByRatingKeyGenre.md
View File

@@ -1,4 +1,4 @@
# GetMetadataGenre
# GetMetaDataByRatingKeyGenre
## Fields

24
docs/Models/Requests/GetMetaDataByRatingKeyMedia.md Normal file
View File

@@ -0,0 +1,24 @@
# GetMetaDataByRatingKeyMedia
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `Id` | *int* | :heavy_minus_sign: | N/A | 15 |
| `Duration` | *int* | :heavy_minus_sign: | N/A | 141417 |
| `Bitrate` | *int* | :heavy_minus_sign: | N/A | 2278 |
| `Width` | *int* | :heavy_minus_sign: | N/A | 1920 |
| `Height` | *int* | :heavy_minus_sign: | N/A | 814 |
| `AspectRatio` | *double* | :heavy_minus_sign: | N/A | 2.35 |
| `AudioChannels` | *int* | :heavy_minus_sign: | N/A | 2 |
| `AudioCodec` | *string* | :heavy_minus_sign: | N/A | aac |
| `VideoCodec` | *string* | :heavy_minus_sign: | N/A | h264 |
| `VideoResolution` | *string* | :heavy_minus_sign: | N/A | 1080 |
| `Container` | *string* | :heavy_minus_sign: | N/A | mp4 |
| `VideoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
| `OptimizedForStreaming` | *int* | :heavy_minus_sign: | N/A | 0 |
| `AudioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
| `Has64bitOffsets` | *bool* | :heavy_minus_sign: | N/A | false |
| `VideoProfile` | *string* | :heavy_minus_sign: | N/A | high |
| `Part` | List<[GetMetaDataByRatingKeyPart](../../Models/Requests/GetMetaDataByRatingKeyPart.md)> | :heavy_minus_sign: | N/A | |

16
docs/Models/Requests/GetMetaDataByRatingKeyMediaContainer.md Normal file
View File

@@ -0,0 +1,16 @@
# GetMetaDataByRatingKeyMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `Size` | *int* | :heavy_minus_sign: | N/A | 1 |
| `AllowSync` | *bool* | :heavy_minus_sign: | N/A | true |
| `Identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `LibrarySectionID` | *int* | :heavy_minus_sign: | N/A | 1 |
| `LibrarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
| `LibrarySectionUUID` | *string* | :heavy_minus_sign: | N/A | cfc899d7-3000-46f6-8489-b9592714ada5 |
| `MediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `MediaTagVersion` | *int* | :heavy_minus_sign: | N/A | 1698860922 |
| `Metadata` | List<[GetMetaDataByRatingKeyMetadata](../../Models/Requests/GetMetaDataByRatingKeyMetadata.md)> | :heavy_minus_sign: | N/A | |

14
docs/Models/Requests/GetMetadataMetadata.md → docs/Models/Requests/GetMetaDataByRatingKeyMetadata.md
View File

@@ -1,4 +1,4 @@
# GetMetadataMetadata
# GetMetaDataByRatingKeyMetadata
## Fields
@@ -29,12 +29,12 @@
| `AudienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `HasPremiumPrimaryExtra` | *string* | :heavy_minus_sign: | N/A | 1 |
| `RatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
| `Media` | List<[GetMetadataMedia](../../Models/Requests/GetMetadataMedia.md)> | :heavy_minus_sign: | N/A | |
| `Genre` | List<[GetMetadataGenre](../../Models/Requests/GetMetadataGenre.md)> | :heavy_minus_sign: | N/A | |
| `Country` | List<[GetMetadataCountry](../../Models/Requests/GetMetadataCountry.md)> | :heavy_minus_sign: | N/A | |
| `Media` | List<[GetMetaDataByRatingKeyMedia](../../Models/Requests/GetMetaDataByRatingKeyMedia.md)> | :heavy_minus_sign: | N/A | |
| `Genre` | List<[GetMetaDataByRatingKeyGenre](../../Models/Requests/GetMetaDataByRatingKeyGenre.md)> | :heavy_minus_sign: | N/A | |
| `Country` | List<[GetMetaDataByRatingKeyCountry](../../Models/Requests/GetMetaDataByRatingKeyCountry.md)> | :heavy_minus_sign: | N/A | |
| `Guids` | List<[Guids](../../Models/Requests/Guids.md)> | :heavy_minus_sign: | N/A | |
| `Ratings` | List<[Ratings](../../Models/Requests/Ratings.md)> | :heavy_minus_sign: | N/A | |
| `Director` | List<[GetMetadataDirector](../../Models/Requests/GetMetadataDirector.md)> | :heavy_minus_sign: | N/A | |
| `Writer` | List<[GetMetadataWriter](../../Models/Requests/GetMetadataWriter.md)> | :heavy_minus_sign: | N/A | |
| `Role` | List<[GetMetadataRole](../../Models/Requests/GetMetadataRole.md)> | :heavy_minus_sign: | N/A | |
| `Director` | List<[GetMetaDataByRatingKeyDirector](../../Models/Requests/GetMetaDataByRatingKeyDirector.md)> | :heavy_minus_sign: | N/A | |
| `Writer` | List<[GetMetaDataByRatingKeyWriter](../../Models/Requests/GetMetaDataByRatingKeyWriter.md)> | :heavy_minus_sign: | N/A | |
| `Role` | List<[GetMetaDataByRatingKeyRole](../../Models/Requests/GetMetaDataByRatingKeyRole.md)> | :heavy_minus_sign: | N/A | |
| `Producer` | List<[Producer](../../Models/Requests/Producer.md)> | :heavy_minus_sign: | N/A | |

2
docs/Models/Requests/GetMetadataPart.md → docs/Models/Requests/GetMetaDataByRatingKeyPart.md
View File

@@ -1,4 +1,4 @@
# GetMetadataPart
# GetMetaDataByRatingKeyPart
## Fields

8
docs/Models/Requests/GetMetadataRequest.md → docs/Models/Requests/GetMetaDataByRatingKeyRequest.md
View File

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

4
docs/Models/Requests/GetMetadataResponse.md → docs/Models/Requests/GetMetaDataByRatingKeyResponse.md
View File

@@ -1,4 +1,4 @@
# GetMetadataResponse
# GetMetaDataByRatingKeyResponse
## Fields
@@ -8,4 +8,4 @@
| `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` | [Models.Requests.GetMetadataResponseBody](../../Models/Requests/GetMetadataResponseBody.md) | :heavy_minus_sign: | The metadata of the library item. |
| `Object` | [Models.Requests.GetMetaDataByRatingKeyResponseBody](../../Models/Requests/GetMetaDataByRatingKeyResponseBody.md) | :heavy_minus_sign: | The metadata of the library item. |

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

@@ -0,0 +1,10 @@
# GetMetaDataByRatingKeyResponseBody
The metadata of the library item.
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `MediaContainer` | [GetMetaDataByRatingKeyMediaContainer](../../Models/Requests/GetMetaDataByRatingKeyMediaContainer.md) | :heavy_minus_sign: | N/A |

2
docs/Models/Requests/GetMetadataRole.md → docs/Models/Requests/GetMetaDataByRatingKeyRole.md
View File

@@ -1,4 +1,4 @@
# GetMetadataRole
# GetMetaDataByRatingKeyRole
## Fields

2
docs/Models/Requests/GetMetadataWriter.md → docs/Models/Requests/GetMetaDataByRatingKeyWriter.md
View File

@@ -1,4 +1,4 @@
# GetMetadataWriter
# GetMetaDataByRatingKeyWriter
## Fields

24
docs/Models/Requests/GetMetadataMedia.md
View File

@@ -1,24 +0,0 @@
# GetMetadataMedia
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
| `Id` | *int* | :heavy_minus_sign: | N/A | 15 |
| `Duration` | *int* | :heavy_minus_sign: | N/A | 141417 |
| `Bitrate` | *int* | :heavy_minus_sign: | N/A | 2278 |
| `Width` | *int* | :heavy_minus_sign: | N/A | 1920 |
| `Height` | *int* | :heavy_minus_sign: | N/A | 814 |
| `AspectRatio` | *double* | :heavy_minus_sign: | N/A | 2.35 |
| `AudioChannels` | *int* | :heavy_minus_sign: | N/A | 2 |
| `AudioCodec` | *string* | :heavy_minus_sign: | N/A | aac |
| `VideoCodec` | *string* | :heavy_minus_sign: | N/A | h264 |
| `VideoResolution` | *string* | :heavy_minus_sign: | N/A | 1080 |
| `Container` | *string* | :heavy_minus_sign: | N/A | mp4 |
| `VideoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
| `OptimizedForStreaming` | *int* | :heavy_minus_sign: | N/A | 0 |
| `AudioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
| `Has64bitOffsets` | *bool* | :heavy_minus_sign: | N/A | false |
| `VideoProfile` | *string* | :heavy_minus_sign: | N/A | high |
| `Part` | List<[GetMetadataPart](../../Models/Requests/GetMetadataPart.md)> | :heavy_minus_sign: | N/A | |

16
docs/Models/Requests/GetMetadataMediaContainer.md
View File

@@ -1,16 +0,0 @@
# GetMetadataMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `Size` | *int* | :heavy_minus_sign: | N/A | 1 |
| `AllowSync` | *bool* | :heavy_minus_sign: | N/A | true |
| `Identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `LibrarySectionID` | *int* | :heavy_minus_sign: | N/A | 1 |
| `LibrarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
| `LibrarySectionUUID` | *string* | :heavy_minus_sign: | N/A | cfc899d7-3000-46f6-8489-b9592714ada5 |
| `MediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `MediaTagVersion` | *int* | :heavy_minus_sign: | N/A | 1698860922 |
| `Metadata` | List<[GetMetadataMetadata](../../Models/Requests/GetMetadataMetadata.md)> | :heavy_minus_sign: | N/A | |

10
docs/Models/Requests/GetMetadataResponseBody.md
View File

@@ -1,10 +0,0 @@
# GetMetadataResponseBody
The metadata of the library item.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `MediaContainer` | [GetMetadataMediaContainer](../../Models/Requests/GetMetadataMediaContainer.md) | :heavy_minus_sign: | N/A |

4
docs/Models/Requests/GetPinRequest.md
View File

@@ -5,6 +5,6 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `XPlexProduct` | *string* | :heavy_check_mark: | Product name of the application shown in the list of devices<br/> | Postman |
| `Strong` | *bool* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
| `XPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | Postman |
| `XPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `XPlexProduct` | *string* | :heavy_minus_sign: | N/A | Plex Web |

19
docs/Models/Requests/GetPlaylistContentsQueryParamType.md Normal file
View File

@@ -0,0 +1,19 @@
# GetPlaylistContentsQueryParamType
The type of media to retrieve.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Values
| Name | Value |
| ------- | ------- |
| `One` | 1 |
| `Two` | 2 |
| `Three` | 3 |
| `Four` | 4 |

8
docs/Models/Requests/GetPlaylistContentsRequest.md
View File

@@ -3,7 +3,7 @@
## Fields
| Field | Type | Required | Description |
| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
| `PlaylistID` | *double* | :heavy_check_mark: | the ID of the playlist |
| `Type` | *double* | :heavy_check_mark: | the metadata type of the item to return |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `PlaylistID` | *double* | :heavy_check_mark: | the ID of the playlist | |
| `Type` | [GetPlaylistContentsQueryParamType](../../Models/Requests/GetPlaylistContentsQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

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

@@ -0,0 +1,9 @@
# GetRecentlyAddedRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `XPlexContainerStart` | *int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `XPlexContainerSize` | *int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |

8
docs/Models/Requests/GetRefreshLibraryMetadataRequest.md
View File

@@ -3,7 +3,7 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
| `SectionId` | *double* | :heavy_check_mark: | The id of the library | 15 |
| `Force` | [Force](../../Models/Requests/Force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `Force` | [Force](../../Models/Requests/Force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |

20
docs/Models/Requests/GetSearchLibraryMediaContainer.md Normal file
View File

@@ -0,0 +1,20 @@
# GetSearchLibraryMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `Size` | *int* | :heavy_minus_sign: | N/A | 2 |
| `AllowSync` | *bool* | :heavy_minus_sign: | N/A | false |
| `Art` | *string* | :heavy_minus_sign: | N/A | /:/resources/show-fanart.jpg |
| `Identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `MediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `MediaTagVersion` | *int* | :heavy_minus_sign: | N/A | 1698860922 |
| `Nocache` | *bool* | :heavy_minus_sign: | N/A | true |
| `Thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/show.png |
| `Title1` | *string* | :heavy_minus_sign: | N/A | TV Shows |
| `Title2` | *string* | :heavy_minus_sign: | N/A | Search for '' |
| `ViewGroup` | *string* | :heavy_minus_sign: | N/A | season |
| `ViewMode` | *int* | :heavy_minus_sign: | N/A | 65593 |
| `Metadata` | List<[GetSearchLibraryMetadata](../../Models/Requests/GetSearchLibraryMetadata.md)> | :heavy_minus_sign: | N/A | |

2
docs/Models/Requests/SearchLibraryMetadata.md → docs/Models/Requests/GetSearchLibraryMetadata.md
View File

@@ -1,4 +1,4 @@
# SearchLibraryMetadata
# GetSearchLibraryMetadata
## Fields

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

@@ -0,0 +1,9 @@
# GetSearchLibraryRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `Type` | [QueryParamType](../../Models/Requests/QueryParamType.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

4
docs/Models/Requests/SearchLibraryResponse.md → docs/Models/Requests/GetSearchLibraryResponse.md
View File

@@ -1,4 +1,4 @@
# SearchLibraryResponse
# GetSearchLibraryResponse
## Fields
@@ -8,4 +8,4 @@
| `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` | [Models.Requests.SearchLibraryResponseBody](../../Models/Requests/SearchLibraryResponseBody.md) | :heavy_minus_sign: | The contents of the library by section and type |
| `Object` | [Models.Requests.GetSearchLibraryResponseBody](../../Models/Requests/GetSearchLibraryResponseBody.md) | :heavy_minus_sign: | The contents of the library by section and type |

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

@@ -0,0 +1,10 @@
# GetSearchLibraryResponseBody
The contents of the library by section and type
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `MediaContainer` | [GetSearchLibraryMediaContainer](../../Models/Requests/GetSearchLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |

11
docs/Models/Requests/GetResourcesRequest.md → docs/Models/Requests/GetServerResourcesRequest.md
View File

@@ -1,11 +1,12 @@
# GetResourcesRequest
# GetServerResourcesRequest
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `XPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | Postman |
| `IncludeHttps` | [IncludeHttps](../../Models/Requests/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | |
| `IncludeRelay` | [IncludeRelay](../../Models/Requests/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results | |
| `IncludeIPv6` | [IncludeIPv6](../../Models/Requests/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | |
| `XPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| `XPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `IncludeHttps` | [IncludeHttps](../../Models/Requests/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `IncludeRelay` | [IncludeRelay](../../Models/Requests/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `IncludeIPv6` | [IncludeIPv6](../../Models/Requests/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |

2
docs/Models/Requests/GetResourcesResponse.md → docs/Models/Requests/GetServerResourcesResponse.md
View File

@@ -1,4 +1,4 @@
# GetResourcesResponse
# GetServerResourcesResponse
## Fields

2
docs/Models/Requests/GetSessionHistoryRequest.md
View File

@@ -7,5 +7,5 @@
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Sort` | *string* | :heavy_minus_sign: | Sorts the results by the specified field followed by the direction (asc, desc)<br/> | |
| `AccountId` | *long* | :heavy_minus_sign: | Filter results by those that are related to a specific users id<br/> | 1 |
| `Filter` | [Filter](../../Models/Requests/Filter.md) | :heavy_minus_sign: | Filters content by field and direction/equality<br/>(Unknown if viewedAt is the only supported column)<br/> | {<br/>"viewed-at-greater-than": {<br/>"value": "viewedAt\u003e"<br/>},<br/>"viewed-at-greater-than-or-equal-to": {<br/>"value": "viewedAt\u003e=\u003e"<br/>},<br/>"viewed-at-less-than": {<br/>"value": "viewedAt\u003c"<br/>}<br/>} |
| `Filter` | [QueryParamFilter](../../Models/Requests/QueryParamFilter.md) | :heavy_minus_sign: | Filters content by field and direction/equality<br/>(Unknown if viewedAt is the only supported column)<br/> | {<br/>"viewed-at-greater-than": {<br/>"value": "viewedAt\u003e"<br/>},<br/>"viewed-at-greater-than-or-equal-to": {<br/>"value": "viewedAt\u003e=\u003e"<br/>},<br/>"viewed-at-less-than": {<br/>"value": "viewedAt\u003c"<br/>}<br/>} |
| `LibrarySectionID` | *long* | :heavy_minus_sign: | Filters the results based on the id of a valid library section<br/> | 12 |

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

@@ -0,0 +1,13 @@
# GetThumbImageRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `RatingKey` | *long* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
| `Width` | *long* | :heavy_check_mark: | N/A | 396 |
| `Height` | *long* | :heavy_check_mark: | N/A | 396 |
| `MinSize` | *long* | :heavy_check_mark: | N/A | 1 |
| `Upscale` | *long* | :heavy_check_mark: | N/A | 1 |
| `XPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |

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

@@ -0,0 +1,12 @@
# GetThumbImageResponse
## 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 |
| `Bytes` | *byte[]* | :heavy_minus_sign: | Successful response returning an image |
| `Headers` | Dictionary<String, List<*string*>> | :heavy_check_mark: | N/A |

2
docs/Models/Requests/GetTokenByPinIdRequest.md
View File

@@ -6,4 +6,4 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `PinID` | *long* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `XPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | Postman |
| `XPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |

19
docs/Models/Requests/GetTopWatchedContentQueryParamType.md Normal file
View File

@@ -0,0 +1,19 @@
# GetTopWatchedContentQueryParamType
The type of media to retrieve.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Values
| Name | Value |
| ------- | ------- |
| `One` | 1 |
| `Two` | 2 |
| `Three` | 3 |
| `Four` | 4 |

8
docs/Models/Requests/GetTopWatchedContentRequest.md
View File

@@ -3,7 +3,7 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| `Type` | *long* | :heavy_check_mark: | the library type (1 - movies, 2 - shows, 3 - music) | |
| `IncludeGuids` | *long* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Type` | [GetTopWatchedContentQueryParamType](../../Models/Requests/GetTopWatchedContentQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `IncludeGuids` | *long* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |

2
docs/Models/Requests/GetTopWatchedContentResponse.md
View File

@@ -8,4 +8,4 @@
| `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` | [GetTopWatchedContentResponseBody](../../Models/Requests/GetTopWatchedContentResponseBody.md) | :heavy_minus_sign: | The metadata of the library item. |
| `Object` | [Models.Requests.GetTopWatchedContentResponseBody](../../Models/Requests/GetTopWatchedContentResponseBody.md) | :heavy_minus_sign: | The metadata of the library item. |

2
docs/Models/Requests/GetUserDetailsPlexStatus.md → docs/Models/Requests/GetUserDetailsAuthenticationResponseStatus.md
View File

@@ -1,4 +1,4 @@
# GetUserDetailsPlexStatus
# GetUserDetailsAuthenticationResponseStatus
String representation of subscriptionActive

2
docs/Models/Requests/GetUserDetailsPlexResponseStatus.md → docs/Models/Requests/GetUserDetailsAuthenticationStatus.md
View File

@@ -1,4 +1,4 @@
# GetUserDetailsPlexResponseStatus
# GetUserDetailsAuthenticationStatus
String representation of subscriptionActive

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

@@ -0,0 +1,8 @@
# GetUserDetailsRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `XPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |

16
docs/Models/Requests/GetUserDetailsSubscription.md
View File

@@ -3,11 +3,11 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `Features` | List<[GetUserDetailsFeatures](../../Models/Requests/GetUserDetailsFeatures.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `Active` | *bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `SubscribedAt` | *string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `Status` | [GetUserDetailsPlexResponseStatus](../../Models/Requests/GetUserDetailsPlexResponseStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
| `PaymentService` | *string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
| `Plan` | *string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `Features` | List<[GetUserDetailsFeatures](../../Models/Requests/GetUserDetailsFeatures.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `Active` | *bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `SubscribedAt` | *string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `Status` | [GetUserDetailsAuthenticationResponseStatus](../../Models/Requests/GetUserDetailsAuthenticationResponseStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
| `PaymentService` | *string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
| `Plan` | *string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |

24
docs/Models/Requests/GetWatchlistRequest.md → docs/Models/Requests/GetWatchListRequest.md
View File

@@ -1,16 +1,16 @@
# GetWatchlistRequest
# GetWatchListRequest
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Filter` | [PathParamFilter](../../Models/Requests/PathParamFilter.md) | :heavy_check_mark: | Filter |
| `XPlexToken` | *string* | :heavy_check_mark: | User Token |
| `Sort` | *string* | :heavy_minus_sign: | In the format "field:dir". Available fields are "watchlistedAt" (Added At),<br/>"titleSort" (Title), "originallyAvailableAt" (Release Date), or "rating" (Critic Rating).<br/>"dir" can be "asc" or "desc"<br/> |
| `Libtype` | [Libtype](../../Models/Requests/Libtype.md) | :heavy_minus_sign: | The type of library to filter. Can be "movie" or "show", or all if not present.<br/> |
| `Maxresults` | *int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/> |
| `IncludeCollections` | [IncludeCollections](../../Models/Requests/IncludeCollections.md) | :heavy_minus_sign: | include collections in the results<br/> |
| `IncludeExternalMedia` | [IncludeExternalMedia](../../Models/Requests/IncludeExternalMedia.md) | :heavy_minus_sign: | include external media in the results<br/> |
| `XPlexContainerStart` | *int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/> |
| `XPlexContainerSize` | *int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/> |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Filter` | [Filter](../../Models/Requests/Filter.md) | :heavy_check_mark: | Filter | |
| `XPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| `Sort` | *string* | :heavy_minus_sign: | In the format "field:dir". Available fields are "watchlistedAt" (Added At),<br/>"titleSort" (Title), "originallyAvailableAt" (Release Date), or "rating" (Critic Rating).<br/>"dir" can be "asc" or "desc"<br/> | |
| `Libtype` | [Libtype](../../Models/Requests/Libtype.md) | :heavy_minus_sign: | The type of library to filter. Can be "movie" or "show", or all if not present.<br/> | |
| `Maxresults` | *int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/> | |
| `IncludeCollections` | [IncludeCollections](../../Models/Requests/IncludeCollections.md) | :heavy_minus_sign: | include collections in the results<br/> | |
| `IncludeExternalMedia` | [IncludeExternalMedia](../../Models/Requests/IncludeExternalMedia.md) | :heavy_minus_sign: | include external media in the results<br/> | |
| `XPlexContainerStart` | *int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `XPlexContainerSize` | *int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |

4
docs/Models/Requests/GetWatchlistResponse.md → docs/Models/Requests/GetWatchListResponse.md
View File

@@ -1,4 +1,4 @@
# GetWatchlistResponse
# GetWatchListResponse
## Fields
@@ -8,4 +8,4 @@
| `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` | [Models.Requests.GetWatchlistResponseBody](../../Models/Requests/GetWatchlistResponseBody.md) | :heavy_minus_sign: | Watchlist Data |
| `Object` | [Models.Requests.GetWatchListResponseBody](../../Models/Requests/GetWatchListResponseBody.md) | :heavy_minus_sign: | Watchlist Data |

2
docs/Models/Requests/GetWatchlistResponseBody.md → docs/Models/Requests/GetWatchListResponseBody.md
View File

@@ -1,4 +1,4 @@
# GetWatchlistResponseBody
# GetWatchListResponseBody
Watchlist Data

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

@@ -0,0 +1,12 @@
# IncludeGuids
Adds the Guids object to the response
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

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

@@ -0,0 +1,12 @@
# IncludeMeta
Adds the Meta object to the response
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

4
docs/Models/Requests/IncludeRelay.md
View File

@@ -1,6 +1,8 @@
# IncludeRelay
Include Relay addresses in the results
Include Relay addresses in the results
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
## Values

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

@@ -0,0 +1,12 @@
# MediaProvider
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
| `Identifier` | *string* | :heavy_minus_sign: | N/A |
| `Title` | *string* | :heavy_minus_sign: | N/A |
| `Types` | *string* | :heavy_minus_sign: | N/A |
| `Protocols` | *string* | :heavy_minus_sign: | N/A |
| `Feature` | List<[Feature](../../Models/Requests/Feature.md)> | :heavy_minus_sign: | N/A |

12
docs/Models/Requests/PathParamFilter.md
View File

@@ -1,12 +0,0 @@
# PathParamFilter
Filter
## Values
| Name | Value |
| ----------- | ----------- |
| `All` | all |
| `Available` | available |
| `Released` | released |

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

@@ -0,0 +1,13 @@
# Pivot
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `Id` | *string* | :heavy_minus_sign: | N/A |
| `Key` | *string* | :heavy_minus_sign: | N/A |
| `Type` | *string* | :heavy_minus_sign: | N/A |
| `Title` | *string* | :heavy_minus_sign: | N/A |
| `Context` | *string* | :heavy_minus_sign: | N/A |
| `Symbol` | *string* | :heavy_minus_sign: | N/A |

28
docs/Models/Requests/PlexDevice.md
View File

@@ -15,17 +15,17 @@
| `CreatedAt` | [DateTime](https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-5.0) | :heavy_check_mark: | N/A |
| `LastSeenAt` | [DateTime](https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-5.0) | :heavy_check_mark: | N/A |
| `Provides` | *string* | :heavy_check_mark: | N/A |
| `OwnerId` | *string* | :heavy_minus_sign: | N/A |
| `SourceTitle` | *string* | :heavy_minus_sign: | N/A |
| `PublicAddress` | *string* | :heavy_minus_sign: | N/A |
| `AccessToken` | *string* | :heavy_minus_sign: | N/A |
| `Owned` | *bool* | :heavy_minus_sign: | N/A |
| `Home` | *bool* | :heavy_minus_sign: | N/A |
| `Synced` | *bool* | :heavy_minus_sign: | N/A |
| `Relay` | *bool* | :heavy_minus_sign: | N/A |
| `Presence` | *bool* | :heavy_minus_sign: | N/A |
| `HttpsRequired` | *bool* | :heavy_minus_sign: | N/A |
| `PublicAddressMatches` | *bool* | :heavy_minus_sign: | N/A |
| `DnsRebindingProtection` | *bool* | :heavy_minus_sign: | N/A |
| `NatLoopbackSupported` | *bool* | :heavy_minus_sign: | N/A |
| `Connections` | List<[Connections](../../Models/Requests/Connections.md)> | :heavy_minus_sign: | N/A |
| `OwnerId` | *long* | :heavy_check_mark: | ownerId is null when the device is owned by the token used to send the request |
| `SourceTitle` | *string* | :heavy_check_mark: | N/A |
| `PublicAddress` | *string* | :heavy_check_mark: | N/A |
| `AccessToken` | *string* | :heavy_check_mark: | N/A |
| `Owned` | *bool* | :heavy_check_mark: | N/A |
| `Home` | *bool* | :heavy_check_mark: | N/A |
| `Synced` | *bool* | :heavy_check_mark: | N/A |
| `Relay` | *bool* | :heavy_check_mark: | N/A |
| `Presence` | *bool* | :heavy_check_mark: | N/A |
| `HttpsRequired` | *bool* | :heavy_check_mark: | N/A |
| `PublicAddressMatches` | *bool* | :heavy_check_mark: | N/A |
| `DnsRebindingProtection` | *bool* | :heavy_check_mark: | N/A |
| `NatLoopbackSupported` | *bool* | :heavy_check_mark: | N/A |
| `Connections` | List<[Connections](../../Models/Requests/Connections.md)> | :heavy_check_mark: | N/A |

2
docs/Models/Requests/PostUsersSignInDataRequest.md
View File

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `XPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | Postman |
| `XPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `RequestBody` | [PostUsersSignInDataRequestBody](../../Models/Requests/PostUsersSignInDataRequestBody.md) | :heavy_minus_sign: | Login credentials | |

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

@@ -0,0 +1,11 @@
# QueryParamFilter
Filters content by field and direction/equality
(Unknown if viewedAt is the only supported column)
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

15
docs/Models/Requests/QueryParamType.md
View File

@@ -1,12 +1,19 @@
# QueryParamType
type of playlist to create
The type of media to retrieve.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Values
| Name | Value |
| ------- | ------- |
| `Audio` | audio |
| `Video` | video |
| `Photo` | photo |
| `One` | 1 |
| `Two` | 2 |
| `Three` | 3 |
| `Four` | 4 |

20
docs/Models/Requests/SearchLibraryMediaContainer.md
View File

@@ -1,20 +0,0 @@
# SearchLibraryMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `Size` | *int* | :heavy_minus_sign: | N/A | 2 |
| `AllowSync` | *bool* | :heavy_minus_sign: | N/A | false |
| `Art` | *string* | :heavy_minus_sign: | N/A | /:/resources/show-fanart.jpg |
| `Identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `MediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `MediaTagVersion` | *int* | :heavy_minus_sign: | N/A | 1698860922 |
| `Nocache` | *bool* | :heavy_minus_sign: | N/A | true |
| `Thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/show.png |
| `Title1` | *string* | :heavy_minus_sign: | N/A | TV Shows |
| `Title2` | *string* | :heavy_minus_sign: | N/A | Search for '' |
| `ViewGroup` | *string* | :heavy_minus_sign: | N/A | season |
| `ViewMode` | *int* | :heavy_minus_sign: | N/A | 65593 |
| `Metadata` | List<[SearchLibraryMetadata](../../Models/Requests/SearchLibraryMetadata.md)> | :heavy_minus_sign: | N/A | |

9
docs/Models/Requests/SearchLibraryRequest.md
View File

@@ -1,9 +0,0 @@
# SearchLibraryRequest
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `SectionId` | *long* | :heavy_check_mark: | the Id of the library to query |
| `Type` | [Models.Requests.Type](../../Models/Requests/Type.md) | :heavy_check_mark: | Plex content type to search for |

10
docs/Models/Requests/SearchLibraryResponseBody.md
View File

@@ -1,10 +0,0 @@
# SearchLibraryResponseBody
The contents of the library by section and type
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `MediaContainer` | [SearchLibraryMediaContainer](../../Models/Requests/SearchLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |

2
docs/Models/Requests/Skip.md
View File

@@ -1,6 +1,6 @@
# Skip
Indicate that the latest version should be marked as skipped. The <Release> entry for this version will have the `state` set to `skipped`.
Indicate that the latest version should be marked as skipped. The [Release] entry for this version will have the `state` set to `skipped`.
## Values

2
docs/Models/Requests/StatisticsBandwidth.md
View File

@@ -6,7 +6,7 @@
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `AccountID` | *int* | :heavy_minus_sign: | N/A | 238960586 |
| `DeviceID` | *int* | :heavy_minus_sign: | N/A | |
| `DeviceID` | *int* | :heavy_minus_sign: | N/A | 208 |
| `Timespan` | *long* | :heavy_minus_sign: | N/A | 6 |
| `At` | *int* | :heavy_minus_sign: | N/A | 1718387650 |
| `Lan` | *bool* | :heavy_minus_sign: | N/A | true |

16
docs/Models/Requests/Subscription.md
View File

@@ -5,11 +5,11 @@ If the account’s Plex Pass subscription is active
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `Features` | List<[Features](../../Models/Requests/Features.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `Active` | *bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `SubscribedAt` | *string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `Status` | [GetUserDetailsPlexStatus](../../Models/Requests/GetUserDetailsPlexStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
| `PaymentService` | *string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
| `Plan` | *string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `Features` | List<[Features](../../Models/Requests/Features.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `Active` | *bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `SubscribedAt` | *string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `Status` | [GetUserDetailsAuthenticationStatus](../../Models/Requests/GetUserDetailsAuthenticationStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
| `PaymentService` | *string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
| `Plan` | *string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |

8
docs/Models/Requests/Type.md
View File

@@ -1,6 +1,12 @@
# Type
Plex content type to search for
The type of media to retrieve.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Values

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

@@ -29,7 +29,7 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Activities.GetServerActivitiesAsync();
@@ -62,7 +62,7 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Activities.CancelServerActivitiesAsync(activityUUID: "25b71ed5-0f9d-461c-baa7-d404e9e10d3e");

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

@@ -10,6 +10,7 @@ API Calls regarding authentication for Plex Media Server
* [GetTransientToken](#gettransienttoken) - Get a Transient Token.
* [GetSourceConnectionInformation](#getsourceconnectioninformation) - Get Source Connection Information
* [GetUserDetails](#getuserdetails) - Get User Data By Token
* [PostUsersSignInData](#postuserssignindata) - Get User SignIn Data
## GetTransientToken
@@ -26,7 +27,7 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Authentication.GetTransientTokenAsync(
@@ -71,7 +72,7 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Authentication.GetSourceConnectionInformationAsync(source: "server://client-identifier");
@@ -97,6 +98,46 @@ var res = await sdk.Authentication.GetSourceConnectionInformationAsync(source: "
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetUserDetails
Get the User data from the provided X-Plex-Token
### Example Usage
```csharp
using PlexAPI;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Authentication.GetUserDetailsAsync(xPlexToken: "CV5xoxjTpFKUzBTShsaf");
// handle response
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `XPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response
**[GetUserDetailsResponse](../../Models/Requests/GetUserDetailsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
| PlexAPI.Models.Errors.GetUserDetailsResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## PostUsersSignInData
Sign in user with username and password and return user data with Plex authentication token
@@ -108,10 +149,10 @@ using PlexAPI;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(xPlexClientIdentifier: "Postman");
var sdk = new PlexAPISDK(xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40");
var res = await sdk.Authentication.PostUsersSignInDataAsync(
xPlexClientIdentifier: "Postman",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
requestBody: new PostUsersSignInDataRequestBody() {
Login = "username@email.com",
Password = "password123",
@@ -125,7 +166,7 @@ var res = await sdk.Authentication.PostUsersSignInDataAsync(
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `XPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | Postman |
| `XPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `RequestBody` | [PostUsersSignInDataRequestBody](../../Models/Requests/PostUsersSignInDataRequestBody.md) | :heavy_minus_sign: | Login credentials | |
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |

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

@@ -26,7 +26,7 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Butler.GetButlerTasksAsync();
@@ -63,7 +63,7 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Butler.StartAllTasksAsync();
@@ -96,7 +96,7 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Butler.StopAllTasksAsync();
@@ -134,7 +134,7 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Butler.StartTaskAsync(taskName: PlexAPI.Models.Requests.TaskName.CleanOldBundles);
@@ -174,7 +174,7 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Butler.StopTaskAsync(taskName: PlexAPI.Models.Requests.PathParamTaskName.BackupDatabase);

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

@@ -24,7 +24,7 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Hubs.GetGlobalHubsAsync(
@@ -68,7 +68,7 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Hubs.GetLibraryHubsAsync(

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

@@ -15,8 +15,8 @@ API Calls interacting with Plex Media Server Libraries
* [DeleteLibrary](#deletelibrary) - Delete Library Section
* [GetLibraryItems](#getlibraryitems) - Get Library Items
* [GetRefreshLibraryMetadata](#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
* [SearchLibrary](#searchlibrary) - Search Library
* [GetMetadata](#getmetadata) - Get Items Metadata
* [GetSearchLibrary](#getsearchlibrary) - Search Library
* [GetMetaDataByRatingKey](#getmetadatabyratingkey) - Get Metadata by RatingKey
* [GetMetadataChildren](#getmetadatachildren) - Get Items Children
* [GetTopWatchedContent](#gettopwatchedcontent) - Get Top Watched Content
* [GetOnDeck](#getondeck) - Get On Deck
@@ -34,7 +34,7 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Library.GetFileHashAsync(
@@ -73,18 +73,29 @@ This endpoint will return the recently added content.
```csharp
using PlexAPI;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Library.GetRecentlyAddedAsync();
var res = await sdk.Library.GetRecentlyAddedAsync(
xPlexContainerStart: 0,
xPlexContainerSize: 50
);
// handle response
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `XPlexContainerStart` | *int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `XPlexContainerSize` | *int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
### Response
**[GetRecentlyAddedResponse](../../Models/Requests/GetRecentlyAddedResponse.md)**
@@ -115,7 +126,7 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Library.GetAllLibrariesAsync();
@@ -187,11 +198,11 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Library.GetLibraryDetailsAsync(
sectionId: 15D,
sectionKey: 9518,
includeDetails: PlexAPI.Models.Requests.IncludeDetails.Zero
);
@@ -202,7 +213,7 @@ var res = await sdk.Library.GetLibraryDetailsAsync(
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `SectionId` | *double* | :heavy_check_mark: | The id of the library | 15 |
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `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/> | |
### Response
@@ -230,19 +241,19 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Library.DeleteLibraryAsync(sectionId: 15D);
var res = await sdk.Library.DeleteLibraryAsync(sectionKey: 9518);
// handle response
```
### Parameters
| Parameter | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `SectionId` | *double* | :heavy_check_mark: | The id of the library | 15 |
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
### Response
@@ -289,25 +300,29 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Library.GetLibraryItemsAsync(
sectionId: "<value>",
tag: PlexAPI.Models.Requests.Tag.Genre,
includeGuids: 1
);
GetLibraryItemsRequest req = new GetLibraryItemsRequest() {
SectionKey = 9518,
Tag = PlexAPI.Models.Requests.Tag.Edition,
Type = PlexAPI.Models.Requests.Type.Two,
IncludeGuids = PlexAPI.Models.Requests.IncludeGuids.One,
IncludeMeta = PlexAPI.Models.Requests.IncludeMeta.One,
XPlexContainerStart = 0,
XPlexContainerSize = 50,
};
var res = await sdk.Library.GetLibraryItemsAsync(req);
// handle response
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `SectionId` | *object* | :heavy_check_mark: | the Id of the library to query | |
| `Tag` | [Tag](../../Models/Requests/Tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
| `IncludeGuids` | *long* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `request` | [GetLibraryItemsRequest](../../Models/Requests/GetLibraryItemsRequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
@@ -335,11 +350,11 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Library.GetRefreshLibraryMetadataAsync(
sectionId: 15D,
sectionKey: 9518,
force: PlexAPI.Models.Requests.Force.One
);
@@ -348,10 +363,10 @@ var res = await sdk.Library.GetRefreshLibraryMetadataAsync(
### Parameters
| Parameter | Type | Required | Description | Example |
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
| `SectionId` | *double* | :heavy_check_mark: | The id of the library | 15 |
| `Force` | [Force](../../Models/Requests/Force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `Force` | [Force](../../Models/Requests/Force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |
### Response
@@ -365,7 +380,7 @@ var res = await sdk.Library.GetRefreshLibraryMetadataAsync(
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## SearchLibrary
## GetSearchLibrary
Search for content within a specific section of the library.
@@ -396,12 +411,12 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Library.SearchLibraryAsync(
sectionId: 933505,
type: PlexAPI.Models.Requests.Type.Four
var res = await sdk.Library.GetSearchLibraryAsync(
sectionKey: 9518,
type: PlexAPI.Models.Requests.QueryParamType.Two
);
// handle response
@@ -409,24 +424,24 @@ var res = await sdk.Library.SearchLibraryAsync(
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `SectionId` | *long* | :heavy_check_mark: | the Id of the library to query |
| `Type` | [Models.Requests.Type](../../Models/Requests/Type.md) | :heavy_check_mark: | Plex content type to search for |
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `Type` | [QueryParamType](../../Models/Requests/QueryParamType.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
### Response
**[SearchLibraryResponse](../../Models/Requests/SearchLibraryResponse.md)**
**[GetSearchLibraryResponse](../../Models/Requests/GetSearchLibraryResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
| PlexAPI.Models.Errors.SearchLibraryResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
| PlexAPI.Models.Errors.GetSearchLibraryResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetMetadata
## GetMetaDataByRatingKey
This endpoint will return the metadata of a library item specified with the ratingKey.
@@ -440,30 +455,30 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Library.GetMetadataAsync(ratingKey: 8382.31D);
var res = await sdk.Library.GetMetaDataByRatingKeyAsync(ratingKey: 9518);
// handle response
```
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `RatingKey` | *double* | :heavy_check_mark: | the id of the library item to return the children of. |
| Parameter | Type | Required | Description | Example |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `RatingKey` | *long* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
### Response
**[GetMetadataResponse](../../Models/Requests/GetMetadataResponse.md)**
**[GetMetaDataByRatingKeyResponse](../../Models/Requests/GetMetaDataByRatingKeyResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| PlexAPI.Models.Errors.GetMetadataResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
| PlexAPI.Models.Errors.GetMetaDataByRatingKeyResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetMetadataChildren
@@ -480,7 +495,7 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Library.GetMetadataChildrenAsync(
@@ -524,11 +539,11 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Library.GetTopWatchedContentAsync(
type: 505531,
type: PlexAPI.Models.Requests.GetTopWatchedContentQueryParamType.Two,
includeGuids: 1
);
@@ -537,10 +552,10 @@ var res = await sdk.Library.GetTopWatchedContentAsync(
### Parameters
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| `Type` | *long* | :heavy_check_mark: | the library type (1 - movies, 2 - shows, 3 - music) | |
| `IncludeGuids` | *long* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Type` | [GetTopWatchedContentQueryParamType](../../Models/Requests/GetTopWatchedContentQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `IncludeGuids` | *long* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
### Response
@@ -548,9 +563,10 @@ var res = await sdk.Library.GetTopWatchedContentAsync(
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
| PlexAPI.Models.Errors.GetTopWatchedContentResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetOnDeck
@@ -566,7 +582,7 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Library.GetOnDeckAsync();

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