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

Browse Source
This commit is contained in:
speakeasybot
2024-08-23 00:09:43 +00:00
parent 7585dd0b5c
commit 322299ad95
653 changed files with 7027 additions and 1277 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -36,10 +36,10 @@ var res = await sdk.Activities.GetServerActivitiesAsync();
// handle response
```
### Response
**[GetServerActivitiesResponse](../../Models/Requests/GetServerActivitiesResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -47,6 +47,7 @@ var res = await sdk.Activities.GetServerActivitiesAsync();
| PlexAPI.Models.Errors.GetServerActivitiesResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## CancelServerActivities
Cancel Server Activities
@@ -55,8 +56,8 @@ Cancel Server Activities
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -73,10 +74,10 @@ var res = await sdk.Activities.CancelServerActivitiesAsync(activityUUID: "25b71e
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `ActivityUUID` | *string* | :heavy_check_mark: | The UUID of the activity to cancel. | 25b71ed5-0f9d-461c-baa7-d404e9e10d3e |
### Response
**[CancelServerActivitiesResponse](../../Models/Requests/CancelServerActivitiesResponse.md)**
### Errors
| Error Object | Status Code | Content Type |

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

@@ -20,8 +20,8 @@ This endpoint provides the caller with a temporary token with the same access le
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -41,10 +41,10 @@ var res = await sdk.Authentication.GetTransientTokenAsync(
| `Type` | [GetTransientTokenQueryParamType](../../Models/Requests/GetTransientTokenQueryParamType.md) | :heavy_check_mark: | `delegation` - This is the only supported `type` parameter. |
| `Scope` | [Scope](../../Models/Requests/Scope.md) | :heavy_check_mark: | `all` - This is the only supported `scope` parameter. |
### Response
**[GetTransientTokenResponse](../../Models/Requests/GetTransientTokenResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -52,6 +52,7 @@ var res = await sdk.Authentication.GetTransientTokenAsync(
| PlexAPI.Models.Errors.GetTransientTokenResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetSourceConnectionInformation
If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token.
@@ -62,8 +63,8 @@ Note: requires Plex Media Server >= 1.15.4.
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -80,10 +81,10 @@ var res = await sdk.Authentication.GetSourceConnectionInformationAsync(source: "
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `Source` | *string* | :heavy_check_mark: | The source identifier with an included prefix. | server://client-identifier |
### Response
**[GetSourceConnectionInformationResponse](../../Models/Requests/GetSourceConnectionInformationResponse.md)**
### Errors
| Error Object | Status Code | Content Type |

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

@@ -33,10 +33,10 @@ var res = await sdk.Butler.GetButlerTasksAsync();
// handle response
```
### Response
**[GetButlerTasksResponse](../../Models/Requests/GetButlerTasksResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -44,6 +44,7 @@ var res = await sdk.Butler.GetButlerTasksAsync();
| PlexAPI.Models.Errors.GetButlerTasksResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## StartAllTasks
This endpoint will attempt to start all Butler tasks that are enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
@@ -68,10 +69,10 @@ var res = await sdk.Butler.StartAllTasksAsync();
// handle response
```
### Response
**[StartAllTasksResponse](../../Models/Requests/StartAllTasksResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -79,6 +80,7 @@ var res = await sdk.Butler.StartAllTasksAsync();
| PlexAPI.Models.Errors.StartAllTasksResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## StopAllTasks
This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.
@@ -99,10 +101,10 @@ var res = await sdk.Butler.StopAllTasksAsync();
// handle response
```
### Response
**[StopAllTasksResponse](../../Models/Requests/StopAllTasksResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -110,6 +112,7 @@ var res = await sdk.Butler.StopAllTasksAsync();
| PlexAPI.Models.Errors.StopAllTasksResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## StartTask
This endpoint will attempt to start a single Butler task that is enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
@@ -123,8 +126,8 @@ This endpoint will attempt to start a single Butler task that is enabled in the
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -141,10 +144,10 @@ var res = await sdk.Butler.StartTaskAsync(taskName: PlexAPI.Models.Requests.Task
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| `TaskName` | [TaskName](../../Models/Requests/TaskName.md) | :heavy_check_mark: | the name of the task to be started. |
### Response
**[StartTaskResponse](../../Models/Requests/StartTaskResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -152,6 +155,7 @@ var res = await sdk.Butler.StartTaskAsync(taskName: PlexAPI.Models.Requests.Task
| PlexAPI.Models.Errors.StartTaskResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## StopTask
This endpoint will stop a currently running task by name, or remove it from the list of scheduled tasks if it exists. See the section above for a list of task names for this endpoint.
@@ -161,8 +165,8 @@ This endpoint will stop a currently running task by name, or remove it from the
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -179,10 +183,10 @@ var res = await sdk.Butler.StopTaskAsync(taskName: PlexAPI.Models.Requests.PathP
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
| `TaskName` | [PathParamTaskName](../../Models/Requests/PathParamTaskName.md) | :heavy_check_mark: | The name of the task to be started. |
### Response
**[StopTaskResponse](../../Models/Requests/StopTaskResponse.md)**
### Errors
| Error Object | Status Code | Content Type |

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

@@ -19,8 +19,8 @@ Get Global Hubs filtered by the parameters provided.
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -28,7 +28,7 @@ var sdk = new PlexAPISDK(
var res = await sdk.Hubs.GetGlobalHubsAsync(
count: 1262.49D,
onlyTransient: OnlyTransient.One);
onlyTransient: PlexAPI.Models.Requests.OnlyTransient.One);
// handle response
```
@@ -40,10 +40,10 @@ var res = await sdk.Hubs.GetGlobalHubsAsync(
| `Count` | *double* | :heavy_minus_sign: | The number of items to return with each hub. |
| `OnlyTransient` | [OnlyTransient](../../Models/Requests/OnlyTransient.md) | :heavy_minus_sign: | Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added). |
### Response
**[GetGlobalHubsResponse](../../Models/Requests/GetGlobalHubsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -51,6 +51,7 @@ var res = await sdk.Hubs.GetGlobalHubsAsync(
| PlexAPI.Models.Errors.GetGlobalHubsResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetLibraryHubs
This endpoint will return a list of library specific hubs
@@ -60,8 +61,8 @@ This endpoint will return a list of library specific hubs
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -70,7 +71,7 @@ var sdk = new PlexAPISDK(
var res = await sdk.Hubs.GetLibraryHubsAsync(
sectionId: 6728.76D,
count: 9010.22D,
onlyTransient: QueryParamOnlyTransient.Zero);
onlyTransient: PlexAPI.Models.Requests.QueryParamOnlyTransient.Zero);
// handle response
```
@@ -83,10 +84,10 @@ var res = await sdk.Hubs.GetLibraryHubsAsync(
| `Count` | *double* | :heavy_minus_sign: | The number of items to return with each hub. |
| `OnlyTransient` | [QueryParamOnlyTransient](../../Models/Requests/QueryParamOnlyTransient.md) | :heavy_minus_sign: | Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added). |
### Response
**[GetLibraryHubsResponse](../../Models/Requests/GetLibraryHubsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |

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

@@ -29,8 +29,8 @@ This resource returns hash values for local files
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -50,10 +50,10 @@ var res = await sdk.Library.GetFileHashAsync(
| `Url` | *string* | :heavy_check_mark: | This is the path to the local file, must be prefixed by `file://` | file://C:\Image.png&type=13 |
| `Type` | *double* | :heavy_minus_sign: | Item type | |
### Response
**[GetFileHashResponse](../../Models/Requests/GetFileHashResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -61,6 +61,7 @@ var res = await sdk.Library.GetFileHashAsync(
| PlexAPI.Models.Errors.GetFileHashResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetRecentlyAdded
This endpoint will return the recently added content.
@@ -81,10 +82,10 @@ var res = await sdk.Library.GetRecentlyAddedAsync();
// handle response
```
### Response
**[GetRecentlyAddedResponse](../../Models/Requests/GetRecentlyAddedResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -92,6 +93,7 @@ var res = await sdk.Library.GetRecentlyAddedAsync();
| PlexAPI.Models.Errors.GetRecentlyAddedResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetLibraries
A library section (commonly referred to as just a library) is a collection of media.
@@ -117,10 +119,10 @@ var res = await sdk.Library.GetLibrariesAsync();
// handle response
```
### Response
**[GetLibrariesResponse](../../Models/Requests/GetLibrariesResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -128,6 +130,7 @@ var res = await sdk.Library.GetLibrariesAsync();
| PlexAPI.Models.Errors.GetLibrariesResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetLibrary
## Library Details Endpoint
@@ -175,8 +178,8 @@ Each type in the library comes with a set of filters and sorts, aiding in buildi
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -184,7 +187,7 @@ var sdk = new PlexAPISDK(
var res = await sdk.Library.GetLibraryAsync(
sectionId: 1000D,
includeDetails: IncludeDetails.Zero);
includeDetails: PlexAPI.Models.Requests.IncludeDetails.Zero);
// handle response
```
@@ -196,10 +199,10 @@ var res = await sdk.Library.GetLibraryAsync(
| `SectionId` | *double* | :heavy_check_mark: | the Id of the library to query | 1000 |
| `IncludeDetails` | [IncludeDetails](../../Models/Requests/IncludeDetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
### Response
**[GetLibraryResponse](../../Models/Requests/GetLibraryResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -207,6 +210,7 @@ var res = await sdk.Library.GetLibraryAsync(
| PlexAPI.Models.Errors.GetLibraryResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## DeleteLibrary
Delate a library using a specific section
@@ -215,8 +219,8 @@ Delate a library using a specific section
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -233,10 +237,10 @@ var res = await sdk.Library.DeleteLibraryAsync(sectionId: 1000D);
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `SectionId` | *double* | :heavy_check_mark: | the Id of the library to query | 1000 |
### Response
**[DeleteLibraryResponse](../../Models/Requests/DeleteLibraryResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -244,6 +248,7 @@ var res = await sdk.Library.DeleteLibraryAsync(sectionId: 1000D);
| PlexAPI.Models.Errors.DeleteLibraryResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetLibraryItems
Fetches details from a specific section of the library identified by a section key and a tag. The tag parameter accepts the following values:
@@ -272,8 +277,8 @@ Fetches details from a specific section of the library identified by a section k
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -295,10 +300,10 @@ var res = await sdk.Library.GetLibraryItemsAsync(
| `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 |
### Response
**[GetLibraryItemsResponse](../../Models/Requests/GetLibraryItemsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -306,6 +311,7 @@ var res = await sdk.Library.GetLibraryItemsAsync(
| PlexAPI.Models.Errors.GetLibraryItemsResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## RefreshLibrary
This endpoint Refreshes the library.
@@ -315,8 +321,8 @@ This endpoint Refreshes the library.
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -333,10 +339,10 @@ var res = await sdk.Library.RefreshLibraryAsync(sectionId: 934.16D);
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `SectionId` | *double* | :heavy_check_mark: | the Id of the library to refresh |
### Response
**[RefreshLibraryResponse](../../Models/Requests/RefreshLibraryResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -344,6 +350,7 @@ var res = await sdk.Library.RefreshLibraryAsync(sectionId: 934.16D);
| PlexAPI.Models.Errors.RefreshLibraryResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## SearchLibrary
Search for content within a specific section of the library.
@@ -370,8 +377,8 @@ Each type in the library comes with a set of filters and sorts, aiding in buildi
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -391,10 +398,10 @@ var res = await sdk.Library.SearchLibraryAsync(
| `SectionId` | *long* | :heavy_check_mark: | the Id of the library to query |
| `Type` | [Type](../../Models/Requests/Type.md) | :heavy_check_mark: | Plex content type to search for |
### Response
**[SearchLibraryResponse](../../Models/Requests/SearchLibraryResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -402,6 +409,7 @@ var res = await sdk.Library.SearchLibraryAsync(
| PlexAPI.Models.Errors.SearchLibraryResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetMetadata
This endpoint will return the metadata of a library item specified with the ratingKey.
@@ -411,8 +419,8 @@ This endpoint will return the metadata of a library item specified with the rati
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -429,10 +437,10 @@ var res = await sdk.Library.GetMetadataAsync(ratingKey: 8382.31D);
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `RatingKey` | *double* | :heavy_check_mark: | the id of the library item to return the children of. |
### Response
**[GetMetadataResponse](../../Models/Requests/GetMetadataResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -440,6 +448,7 @@ var res = await sdk.Library.GetMetadataAsync(ratingKey: 8382.31D);
| PlexAPI.Models.Errors.GetMetadataResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetMetadataChildren
This endpoint will return the children of of a library item specified with the ratingKey.
@@ -449,8 +458,8 @@ This endpoint will return the children of of a library item specified with the r
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -470,10 +479,10 @@ var res = await sdk.Library.GetMetadataChildrenAsync(
| `RatingKey` | *double* | :heavy_check_mark: | the id of the library item to return the children of. |
| `IncludeElements` | *string* | :heavy_minus_sign: | Adds additional elements to the response. Supported types are (Stream)<br/> |
### Response
**[GetMetadataChildrenResponse](../../Models/Requests/GetMetadataChildrenResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -481,6 +490,7 @@ var res = await sdk.Library.GetMetadataChildrenAsync(
| PlexAPI.Models.Errors.GetMetadataChildrenResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetTopWatchedContent
This endpoint will return the top watched content from libraries of a certain type
@@ -490,8 +500,8 @@ This endpoint will return the top watched content from libraries of a certain ty
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -511,16 +521,17 @@ var res = await sdk.Library.GetTopWatchedContentAsync(
| `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 |
### Response
**[GetTopWatchedContentResponse](../../Models/Requests/GetTopWatchedContentResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetOnDeck
This endpoint will return the on deck content.
@@ -541,10 +552,10 @@ var res = await sdk.Library.GetOnDeckAsync();
// handle response
```
### Response
**[GetOnDeckResponse](../../Models/Requests/GetOnDeckResponse.md)**
### Errors
| Error Object | Status Code | Content Type |

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

@@ -21,8 +21,8 @@ This endpoint will write a single-line log message, including a level and source
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -44,10 +44,10 @@ var res = await sdk.Log.LogLineAsync(
| `Message` | *string* | :heavy_check_mark: | The text of the message to write to the log. | Test log message |
| `Source` | *string* | :heavy_check_mark: | a string indicating the source of the message. | Postman |
### Response
**[LogLineResponse](../../Models/Requests/LogLineResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -55,6 +55,7 @@ var res = await sdk.Log.LogLineAsync(
| PlexAPI.Models.Errors.LogLineResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## LogMultiLine
This endpoint allows for the batch addition of log entries to the main Plex Media Server log.
@@ -105,10 +106,10 @@ var res = await sdk.Log.LogMultiLineAsync(req);
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| `request` | *string* | :heavy_check_mark: | The request object to use for the request. |
### Response
**[LogMultiLineResponse](../../Models/Requests/LogMultiLineResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -116,6 +117,7 @@ var res = await sdk.Log.LogMultiLineAsync(req);
| PlexAPI.Models.Errors.LogMultiLineResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## EnablePaperTrail
This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail networked logging site for a period of time.
@@ -136,10 +138,10 @@ var res = await sdk.Log.EnablePaperTrailAsync();
// handle response
```
### Response
**[EnablePaperTrailResponse](../../Models/Requests/EnablePaperTrailResponse.md)**
### Errors
| Error Object | Status Code | Content Type |

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

@@ -20,8 +20,8 @@ This will mark the provided media key as Played.
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -38,10 +38,10 @@ var res = await sdk.Media.MarkPlayedAsync(key: 59398D);
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Key` | *double* | :heavy_check_mark: | The media key to mark as played | 59398 |
### Response
**[MarkPlayedResponse](../../Models/Requests/MarkPlayedResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -49,6 +49,7 @@ var res = await sdk.Media.MarkPlayedAsync(key: 59398D);
| PlexAPI.Models.Errors.MarkPlayedResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## MarkUnplayed
This will mark the provided media key as Unplayed.
@@ -57,8 +58,8 @@ This will mark the provided media key as Unplayed.
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -75,10 +76,10 @@ var res = await sdk.Media.MarkUnplayedAsync(key: 59398D);
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
| `Key` | *double* | :heavy_check_mark: | The media key to mark as Unplayed | 59398 |
### Response
**[MarkUnplayedResponse](../../Models/Requests/MarkUnplayedResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -86,6 +87,7 @@ var res = await sdk.Media.MarkUnplayedAsync(key: 59398D);
| PlexAPI.Models.Errors.MarkUnplayedResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## UpdatePlayProgress
This API command can be used to update the play progress of a media item.
@@ -95,8 +97,8 @@ This API command can be used to update the play progress of a media item.
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -118,10 +120,10 @@ var res = await sdk.Media.UpdatePlayProgressAsync(
| `Time` | *double* | :heavy_check_mark: | The time, in milliseconds, used to set the media playback progress. | 90000 |
| `State` | *string* | :heavy_check_mark: | The playback state of the media item. | played |
### Response
**[UpdatePlayProgressResponse](../../Models/Requests/UpdatePlayProgressResponse.md)**
### Errors
| Error Object | Status Code | Content Type |

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

@@ -32,8 +32,8 @@ Create a new playlist. By default the playlist is blank. To create a playlist al
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -57,10 +57,10 @@ var res = await sdk.Playlists.CreatePlaylistAsync(req);
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| `request` | [CreatePlaylistRequest](../../Models/Requests/CreatePlaylistRequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[CreatePlaylistResponse](../../Models/Requests/CreatePlaylistResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -68,6 +68,7 @@ var res = await sdk.Playlists.CreatePlaylistAsync(req);
| PlexAPI.Models.Errors.CreatePlaylistResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetPlaylists
Get All Playlists given the specified filters.
@@ -76,16 +77,16 @@ Get All Playlists given the specified filters.
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
var res = await sdk.Playlists.GetPlaylistsAsync(
playlistType: PlaylistType.Audio,
smart: QueryParamSmart.Zero);
playlistType: PlexAPI.Models.Requests.PlaylistType.Audio,
smart: PlexAPI.Models.Requests.QueryParamSmart.Zero);
// handle response
```
@@ -97,10 +98,10 @@ var res = await sdk.Playlists.GetPlaylistsAsync(
| `PlaylistType` | [PlaylistType](../../Models/Requests/PlaylistType.md) | :heavy_minus_sign: | limit to a type of playlist. |
| `Smart` | [QueryParamSmart](../../Models/Requests/QueryParamSmart.md) | :heavy_minus_sign: | type of playlists to return (default is all). |
### Response
**[GetPlaylistsResponse](../../Models/Requests/GetPlaylistsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -108,6 +109,7 @@ var res = await sdk.Playlists.GetPlaylistsAsync(
| PlexAPI.Models.Errors.GetPlaylistsResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetPlaylist
Gets detailed metadata for a playlist. A playlist for many purposes (rating, editing metadata, tagging), can be treated like a regular metadata item:
@@ -118,8 +120,8 @@ Smart playlist details contain the `content` attribute. This is the content URI
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -136,10 +138,10 @@ var res = await sdk.Playlists.GetPlaylistAsync(playlistID: 4109.48D);
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `PlaylistID` | *double* | :heavy_check_mark: | the ID of the playlist |
### Response
**[GetPlaylistResponse](../../Models/Requests/GetPlaylistResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -147,6 +149,7 @@ var res = await sdk.Playlists.GetPlaylistAsync(playlistID: 4109.48D);
| PlexAPI.Models.Errors.GetPlaylistResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## DeletePlaylist
This endpoint will delete a playlist
@@ -156,8 +159,8 @@ This endpoint will delete a playlist
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -174,10 +177,10 @@ var res = await sdk.Playlists.DeletePlaylistAsync(playlistID: 216.22D);
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `PlaylistID` | *double* | :heavy_check_mark: | the ID of the playlist |
### Response
**[DeletePlaylistResponse](../../Models/Requests/DeletePlaylistResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -185,6 +188,7 @@ var res = await sdk.Playlists.DeletePlaylistAsync(playlistID: 216.22D);
| PlexAPI.Models.Errors.DeletePlaylistResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## UpdatePlaylist
From PMS version 1.9.1 clients can also edit playlist metadata using this endpoint as they would via `PUT /library/metadata/{playlistID}`
@@ -194,8 +198,8 @@ From PMS version 1.9.1 clients can also edit playlist metadata using this endpoi
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -217,10 +221,10 @@ var res = await sdk.Playlists.UpdatePlaylistAsync(
| `Title` | *string* | :heavy_minus_sign: | name of the playlist |
| `Summary` | *string* | :heavy_minus_sign: | summary description of the playlist |
### Response
**[UpdatePlaylistResponse](../../Models/Requests/UpdatePlaylistResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -228,6 +232,7 @@ var res = await sdk.Playlists.UpdatePlaylistAsync(
| PlexAPI.Models.Errors.UpdatePlaylistResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetPlaylistContents
Gets the contents of a playlist. Should be paged by clients via standard mechanisms.
@@ -240,8 +245,8 @@ Note that for dumb playlists, items have a `playlistItemID` attribute which is u
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -261,10 +266,10 @@ var res = await sdk.Playlists.GetPlaylistContentsAsync(
| `PlaylistID` | *double* | :heavy_check_mark: | the ID of the playlist |
| `Type` | *double* | :heavy_check_mark: | the metadata type of the item to return |
### Response
**[GetPlaylistContentsResponse](../../Models/Requests/GetPlaylistContentsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -272,6 +277,7 @@ var res = await sdk.Playlists.GetPlaylistContentsAsync(
| PlexAPI.Models.Errors.GetPlaylistContentsResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## ClearPlaylistContents
Clears a playlist, only works with dumb playlists. Returns the playlist.
@@ -281,8 +287,8 @@ Clears a playlist, only works with dumb playlists. Returns the playlist.
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -299,10 +305,10 @@ var res = await sdk.Playlists.ClearPlaylistContentsAsync(playlistID: 1893.18D);
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `PlaylistID` | *double* | :heavy_check_mark: | the ID of the playlist |
### Response
**[ClearPlaylistContentsResponse](../../Models/Requests/ClearPlaylistContentsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -310,6 +316,7 @@ var res = await sdk.Playlists.ClearPlaylistContentsAsync(playlistID: 1893.18D);
| PlexAPI.Models.Errors.ClearPlaylistContentsResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## AddPlaylistContents
Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist.
@@ -320,8 +327,8 @@ With a smart playlist, passing a new `uri` parameter replaces the rules for the
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -343,10 +350,10 @@ var res = await sdk.Playlists.AddPlaylistContentsAsync(
| `Uri` | *string* | :heavy_check_mark: | the content URI for the playlist | server://12345/com.plexapp.plugins.library/library/metadata/1 |
| `PlayQueueID` | *double* | :heavy_minus_sign: | the play queue to add to a playlist | 123 |
### Response
**[AddPlaylistContentsResponse](../../Models/Requests/AddPlaylistContentsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -354,6 +361,7 @@ var res = await sdk.Playlists.AddPlaylistContentsAsync(
| PlexAPI.Models.Errors.AddPlaylistContentsResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## UploadPlaylist
Imports m3u playlists by passing a path on the server to scan for m3u-formatted playlist files, or a path to a single playlist file.
@@ -363,8 +371,8 @@ Imports m3u playlists by passing a path on the server to scan for m3u-formatted
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -384,10 +392,10 @@ var res = await sdk.Playlists.UploadPlaylistAsync(
| `Path` | *string* | :heavy_check_mark: | absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server. <br/>If the `path` argument is a directory, that path will be scanned for playlist files to be processed. <br/>Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename. <br/>If the `path` argument is a file, that file will be used to create a new playlist, with the name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename.<br/> | /home/barkley/playlist.m3u |
| `Force` | [Force](../../Models/Requests/Force.md) | :heavy_check_mark: | Force overwriting of duplicate playlists. <br/>By default, a playlist file uploaded with the same path will overwrite the existing playlist. <br/>The `force` argument is used to disable overwriting. <br/>If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.<br/> | |
### Response
**[UploadPlaylistResponse](../../Models/Requests/UploadPlaylistResponse.md)**
### Errors
| Error Object | Status Code | Content Type |

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

@@ -8,9 +8,123 @@ API Calls that perform operations directly against https://Plex.tv
### Available Operations
* [GetCompanionsData](#getcompanionsdata) - Get Companions Data
* [GetUserFriends](#getuserfriends) - Get list of friends of the user logged in
* [GetGeoData](#getgeodata) - Get Geo Data
* [GetHomeData](#gethomedata) - Get Plex Home Data
* [GetResources](#getresources) - Get Resources
* [GetPin](#getpin) - Get a Pin
* [GetToken](#gettoken) - Get Access Token
* [GetTokenByPinId](#gettokenbypinid) - Get Access Token by PinId
* [GetUserDetails](#getuserdetails) - Get UserData By Token
## GetCompanionsData
Get Companions Data
### Example Usage
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
var res = await sdk.Plex.GetCompanionsDataAsync();
// handle response
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. |
### Response
**[GetCompanionsDataResponse](../../Models/Requests/GetCompanionsDataResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| PlexAPI.Models.Errors.GetCompanionsDataResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetUserFriends
Get friends of provided auth token.
### Example Usage
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
var res = await sdk.Plex.GetUserFriendsAsync();
// handle response
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. |
### Response
**[GetUserFriendsResponse](../../Models/Requests/GetUserFriendsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
| PlexAPI.Models.Errors.GetUserFriendsResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetGeoData
Returns the geolocation and locale data of the caller
### Example Usage
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(xPlexClientIdentifier: "Postman");
var res = await sdk.Plex.GetGeoDataAsync();
// handle response
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. |
### Response
**[GetGeoDataResponse](../../Models/Requests/GetGeoDataResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| PlexAPI.Models.Errors.GetGeoDataResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetHomeData
@@ -31,10 +145,10 @@ var res = await sdk.Plex.GetHomeDataAsync();
// handle response
```
### Response
**[GetHomeDataResponse](../../Models/Requests/GetHomeDataResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -42,6 +156,51 @@ var res = await sdk.Plex.GetHomeDataAsync();
| PlexAPI.Models.Errors.GetHomeDataResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetResources
Get Resources
### Example Usage
```csharp
using PlexAPI;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(xPlexClientIdentifier: "Postman");
var res = await sdk.Plex.GetResourcesAsync(
xPlexClientIdentifier: "Postman",
includeHttps: PlexAPI.Models.Requests.IncludeHttps.Zero,
includeRelay: PlexAPI.Models.Requests.IncludeRelay.Zero,
includeIPv6: PlexAPI.Models.Requests.IncludeIPv6.One);
// handle response
```
### Parameters
| 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 |
| `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 | |
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response
**[GetResourcesResponse](../../Models/Requests/GetResourcesResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| PlexAPI.Models.Errors.GetResourcesResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetPin
Retrieve a Pin from Plex.tv for authentication flows
@@ -50,8 +209,8 @@ Retrieve a Pin from Plex.tv for authentication flows
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(xPlexClientIdentifier: "Postman");
@@ -72,10 +231,10 @@ var res = await sdk.Plex.GetPinAsync(
| `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 |
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response
**[GetPinResponse](../../Models/Requests/GetPinResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -83,21 +242,22 @@ var res = await sdk.Plex.GetPinAsync(
| PlexAPI.Models.Errors.GetPinResponseBody | 400 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetToken
Retrieve an Access Token from Plex.tv after the Pin has already been authenticated
## GetTokenByPinId
Retrieve an Access Token from Plex.tv after the Pin has been authenticated
### Example Usage
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(xPlexClientIdentifier: "Postman");
var res = await sdk.Plex.GetTokenAsync(
pinID: "<value>",
var res = await sdk.Plex.GetTokenByPinIdAsync(
pinID: 408895,
xPlexClientIdentifier: "Postman");
// handle response
@@ -107,17 +267,54 @@ var res = await sdk.Plex.GetTokenAsync(
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `PinID` | *string* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `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 |
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response
**[GetTokenByPinIdResponse](../../Models/Requests/GetTokenByPinIdResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
| PlexAPI.Models.Errors.GetTokenByPinIdResponseBody | 404 | application/json |
| 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.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
var res = await sdk.Plex.GetUserDetailsAsync();
// handle response
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. |
### Response
**[GetTokenResponse](../../Models/Requests/GetTokenResponse.md)**
**[GetUserDetailsResponse](../../Models/Requests/GetUserDetailsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| PlexAPI.Models.Errors.GetTokenResponseBody | 400 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
| PlexAPI.Models.Errors.GetUserDetailsResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |

6
docs/sdks/plexapi/README.md
View File

@@ -1,9 +1,5 @@
# PlexAPI SDK
## Overview
An Open API Spec for interacting with Plex.tv and Plex Servers
### Available Operations
Plex-API: An Open API Spec for interacting with Plex.tv

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

@@ -32,8 +32,8 @@ This request is intended to be very fast, and called as the user types.
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -55,10 +55,10 @@ var res = await sdk.Search.PerformSearchAsync(
| `SectionId` | *double* | :heavy_minus_sign: | This gives context to the search, and can result in re-ordering of search result hubs | |
| `Limit` | *double* | :heavy_minus_sign: | The number of items to return per hub | 5 |
### Response
**[PerformSearchResponse](../../Models/Requests/PerformSearchResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -66,6 +66,7 @@ var res = await sdk.Search.PerformSearchAsync(
| PlexAPI.Models.Errors.PerformSearchResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## PerformVoiceSearch
This endpoint performs a search specifically tailored towards voice or other imprecise input which may work badly with the substring and spell-checking heuristics used by the `/hubs/search` endpoint.
@@ -78,8 +79,8 @@ Results, as well as their containing per-type hubs, contain a `distance` attribu
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -101,10 +102,10 @@ var res = await sdk.Search.PerformVoiceSearchAsync(
| `SectionId` | *double* | :heavy_minus_sign: | This gives context to the search, and can result in re-ordering of search result hubs | |
| `Limit` | *double* | :heavy_minus_sign: | The number of items to return per hub | 5 |
### Response
**[PerformVoiceSearchResponse](../../Models/Requests/PerformVoiceSearchResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -112,6 +113,7 @@ var res = await sdk.Search.PerformVoiceSearchAsync(
| PlexAPI.Models.Errors.PerformVoiceSearchResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetSearchResults
This will search the database for the string provided.
@@ -120,8 +122,8 @@ This will search the database for the string provided.
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -138,10 +140,10 @@ var res = await sdk.Search.GetSearchResultsAsync(query: "110");
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `Query` | *string* | :heavy_check_mark: | The search query string to use | 110 |
### Response
**[GetSearchResultsResponse](../../Models/Requests/GetSearchResultsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |

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

@@ -36,10 +36,10 @@ var res = await sdk.Server.GetServerCapabilitiesAsync();
// handle response
```
### Response
**[GetServerCapabilitiesResponse](../../Models/Requests/GetServerCapabilitiesResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -47,6 +47,7 @@ var res = await sdk.Server.GetServerCapabilitiesAsync();
| PlexAPI.Models.Errors.GetServerCapabilitiesResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetServerPreferences
Get Server Preferences
@@ -66,10 +67,10 @@ var res = await sdk.Server.GetServerPreferencesAsync();
// handle response
```
### Response
**[GetServerPreferencesResponse](../../Models/Requests/GetServerPreferencesResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -77,6 +78,7 @@ var res = await sdk.Server.GetServerPreferencesAsync();
| PlexAPI.Models.Errors.GetServerPreferencesResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetAvailableClients
Get Available Clients
@@ -96,10 +98,10 @@ var res = await sdk.Server.GetAvailableClientsAsync();
// handle response
```
### Response
**[GetAvailableClientsResponse](../../Models/Requests/GetAvailableClientsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -107,6 +109,7 @@ var res = await sdk.Server.GetAvailableClientsAsync();
| PlexAPI.Models.Errors.GetAvailableClientsResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetDevices
Get Devices
@@ -126,10 +129,10 @@ var res = await sdk.Server.GetDevicesAsync();
// handle response
```
### Response
**[GetDevicesResponse](../../Models/Requests/GetDevicesResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -137,6 +140,7 @@ var res = await sdk.Server.GetDevicesAsync();
| PlexAPI.Models.Errors.GetDevicesResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetServerIdentity
Get Server Identity
@@ -156,10 +160,10 @@ var res = await sdk.Server.GetServerIdentityAsync();
// handle response
```
### Response
**[GetServerIdentityResponse](../../Models/Requests/GetServerIdentityResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -167,6 +171,7 @@ var res = await sdk.Server.GetServerIdentityAsync();
| PlexAPI.Models.Errors.GetServerIdentityResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetMyPlexAccount
Returns MyPlex Account Information
@@ -186,10 +191,10 @@ var res = await sdk.Server.GetMyPlexAccountAsync();
// handle response
```
### Response
**[GetMyPlexAccountResponse](../../Models/Requests/GetMyPlexAccountResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -197,6 +202,7 @@ var res = await sdk.Server.GetMyPlexAccountAsync();
| PlexAPI.Models.Errors.GetMyPlexAccountResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetResizedPhoto
Plex's Photo transcoder is used throughout the service to serve images at specified sizes.
@@ -206,8 +212,8 @@ Plex's Photo transcoder is used throughout the service to serve images at specif
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -234,10 +240,10 @@ var res = await sdk.Server.GetResizedPhotoAsync(req);
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `request` | [GetResizedPhotoRequest](../../Models/Requests/GetResizedPhotoRequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[GetResizedPhotoResponse](../../Models/Requests/GetResizedPhotoResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -245,6 +251,7 @@ var res = await sdk.Server.GetResizedPhotoAsync(req);
| PlexAPI.Models.Errors.GetResizedPhotoResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetServerList
Get Server List
@@ -264,10 +271,10 @@ var res = await sdk.Server.GetServerListAsync();
// handle response
```
### Response
**[GetServerListResponse](../../Models/Requests/GetServerListResponse.md)**
### Errors
| Error Object | Status Code | Content Type |

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

@@ -32,10 +32,10 @@ var res = await sdk.Sessions.GetSessionsAsync();
// handle response
```
### Response
**[GetSessionsResponse](../../Models/Requests/GetSessionsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -43,6 +43,7 @@ var res = await sdk.Sessions.GetSessionsAsync();
| PlexAPI.Models.Errors.GetSessionsResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetSessionHistory
This will Retrieve a listing of all history views.
@@ -51,8 +52,8 @@ This will Retrieve a listing of all history views.
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -76,10 +77,10 @@ var res = await sdk.Sessions.GetSessionHistoryAsync(
| `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/>} |
| `LibrarySectionID` | *long* | :heavy_minus_sign: | Filters the results based on the id of a valid library section<br/> | 12 |
### Response
**[GetSessionHistoryResponse](../../Models/Requests/GetSessionHistoryResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -87,6 +88,7 @@ var res = await sdk.Sessions.GetSessionHistoryAsync(
| PlexAPI.Models.Errors.GetSessionHistoryResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetTranscodeSessions
Get Transcode Sessions
@@ -106,10 +108,10 @@ var res = await sdk.Sessions.GetTranscodeSessionsAsync();
// handle response
```
### Response
**[GetTranscodeSessionsResponse](../../Models/Requests/GetTranscodeSessionsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -117,6 +119,7 @@ var res = await sdk.Sessions.GetTranscodeSessionsAsync();
| PlexAPI.Models.Errors.GetTranscodeSessionsResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## StopTranscodeSession
Stop a Transcode Session
@@ -125,8 +128,8 @@ Stop a Transcode Session
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -143,10 +146,10 @@ var res = await sdk.Sessions.StopTranscodeSessionAsync(sessionKey: "zz7llzqlx8w9
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `SessionKey` | *string* | :heavy_check_mark: | the Key of the transcode session to stop | zz7llzqlx8w9vnrsbnwhbmep |
### Response
**[StopTranscodeSessionResponse](../../Models/Requests/StopTranscodeSessionResponse.md)**
### Errors
| Error Object | Status Code | Content Type |

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

@@ -20,8 +20,8 @@ This will return the media statistics for the server
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -38,10 +38,10 @@ var res = await sdk.Statistics.GetStatisticsAsync(timespan: 4);
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `Timespan` | *long* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
### Response
**[GetStatisticsResponse](../../Models/Requests/GetStatisticsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -49,6 +49,7 @@ var res = await sdk.Statistics.GetStatisticsAsync(timespan: 4);
| PlexAPI.Models.Errors.GetStatisticsResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetResourcesStatistics
This will return the resources for the server
@@ -57,8 +58,8 @@ This will return the resources for the server
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -75,10 +76,10 @@ var res = await sdk.Statistics.GetResourcesStatisticsAsync(timespan: 4);
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `Timespan` | *long* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
### Response
**[GetResourcesStatisticsResponse](../../Models/Requests/GetResourcesStatisticsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -86,6 +87,7 @@ var res = await sdk.Statistics.GetResourcesStatisticsAsync(timespan: 4);
| PlexAPI.Models.Errors.GetResourcesStatisticsResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetBandwidthStatistics
This will return the bandwidth statistics for the server
@@ -94,8 +96,8 @@ This will return the bandwidth statistics for the server
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -112,10 +114,10 @@ var res = await sdk.Statistics.GetBandwidthStatisticsAsync(timespan: 4);
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `Timespan` | *long* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
### Response
**[GetBandwidthStatisticsResponse](../../Models/Requests/GetBandwidthStatisticsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |

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

@@ -32,10 +32,10 @@ var res = await sdk.Updater.GetUpdateStatusAsync();
// handle response
```
### Response
**[GetUpdateStatusResponse](../../Models/Requests/GetUpdateStatusResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -43,6 +43,7 @@ var res = await sdk.Updater.GetUpdateStatusAsync();
| PlexAPI.Models.Errors.GetUpdateStatusResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## CheckForUpdates
Checking for updates
@@ -51,14 +52,14 @@ Checking for updates
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
var res = await sdk.Updater.CheckForUpdatesAsync(download: Download.One);
var res = await sdk.Updater.CheckForUpdatesAsync(download: PlexAPI.Models.Requests.Download.One);
// handle response
```
@@ -69,10 +70,10 @@ var res = await sdk.Updater.CheckForUpdatesAsync(download: Download.One);
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
| `Download` | [Download](../../Models/Requests/Download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |
### Response
**[CheckForUpdatesResponse](../../Models/Requests/CheckForUpdatesResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -80,6 +81,7 @@ var res = await sdk.Updater.CheckForUpdatesAsync(download: Download.One);
| PlexAPI.Models.Errors.CheckForUpdatesResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## ApplyUpdates
Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed
@@ -89,16 +91,16 @@ Note that these two parameters are effectively mutually exclusive. The `tonight`
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
var res = await sdk.Updater.ApplyUpdatesAsync(
tonight: Tonight.One,
skip: Skip.One);
tonight: PlexAPI.Models.Requests.Tonight.One,
skip: PlexAPI.Models.Requests.Skip.One);
// handle response
```
@@ -110,10 +112,10 @@ var res = await sdk.Updater.ApplyUpdatesAsync(
| `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 |
### Response
**[ApplyUpdatesResponse](../../Models/Requests/ApplyUpdatesResponse.md)**
### Errors
| Error Object | Status Code | Content Type |

53
docs/sdks/user/README.md Normal file
View File

@@ -0,0 +1,53 @@
# User
(*User*)
## Overview
API Calls that perform operations with Plex Media Server Users
### Available Operations
* [PostUsersSigninData](#postuserssignindata) - Get User SignIn Data
## PostUsersSigninData
Sign in user with username and password and return user data with Plex authentication token
### Example Usage
```csharp
using PlexAPI;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(xPlexClientIdentifier: "Postman");
var res = await sdk.User.PostUsersSigninDataAsync(
xPlexClientIdentifier: "Postman",
requestBody: new PostUsersSigninDataRequestBody() {
Login = "username@email.com",
Password = "password123",
});
// handle response
```
### Parameters
| 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 |
| `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 |
### Response
**[PostUsersSigninDataResponse](../../Models/Requests/PostUsersSigninDataResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| PlexAPI.Models.Errors.PostUsersSigninDataResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |

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

@@ -19,8 +19,8 @@ Get the timeline for a media item
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -50,10 +50,10 @@ var res = await sdk.Video.GetTimelineAsync(req);
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
| `request` | [GetTimelineRequest](../../Models/Requests/GetTimelineRequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[GetTimelineResponse](../../Models/Requests/GetTimelineResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -61,6 +61,7 @@ var res = await sdk.Video.GetTimelineAsync(req);
| PlexAPI.Models.Errors.GetTimelineResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## StartUniversalTranscode
Begin a Universal Transcode Session
@@ -69,8 +70,8 @@ Begin a Universal Transcode Session
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -106,10 +107,10 @@ var res = await sdk.Video.StartUniversalTranscodeAsync(req);
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `request` | [StartUniversalTranscodeRequest](../../Models/Requests/StartUniversalTranscodeRequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[StartUniversalTranscodeResponse](../../Models/Requests/StartUniversalTranscodeResponse.md)**
### Errors
| Error Object | Status Code | Content Type |

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

@@ -18,8 +18,8 @@ Get User Watchlist
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -42,10 +42,10 @@ var res = await sdk.Watchlist.GetWatchlistAsync(req);
| `request` | [GetWatchlistRequest](../../Models/Requests/GetWatchlistRequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. |
### Response
**[GetWatchlistResponse](../../Models/Requests/GetWatchlistResponse.md)**
### Errors
| Error Object | Status Code | Content Type |