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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.383.2

Browse Source
This commit is contained in:
speakeasybot
2024-08-30 00:10:10 +00:00
parent cc8bc7366d
commit ec1b25e152
148 changed files with 1044 additions and 954 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

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

54
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
* [PostUsersSignInData](#postuserssignindata) - Get User SignIn Data
## GetTransientToken
@@ -25,11 +26,13 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Authentication.GetTransientTokenAsync(
type: PlexAPI.Models.Requests.GetTransientTokenQueryParamType.Delegation,
scope: PlexAPI.Models.Requests.Scope.All);
scope: PlexAPI.Models.Requests.Scope.All
);
// handle response
```
@@ -68,7 +71,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Authentication.GetSourceConnectionInformationAsync(source: "server://client-identifier");
@@ -91,3 +95,47 @@ var res = await sdk.Authentication.GetSourceConnectionInformationAsync(source: "
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
| PlexAPI.Models.Errors.GetSourceConnectionInformationResponseBody | 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
### Example Usage
```csharp
using PlexAPI;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(xPlexClientIdentifier: "Postman");
var res = await sdk.Authentication.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 | */* |

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

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

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

@@ -24,11 +24,13 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Hubs.GetGlobalHubsAsync(
count: 1262.49D,
onlyTransient: PlexAPI.Models.Requests.OnlyTransient.One);
onlyTransient: PlexAPI.Models.Requests.OnlyTransient.One
);
// handle response
```
@@ -66,12 +68,14 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Hubs.GetLibraryHubsAsync(
sectionId: 6728.76D,
count: 9010.22D,
onlyTransient: PlexAPI.Models.Requests.QueryParamOnlyTransient.Zero);
onlyTransient: PlexAPI.Models.Requests.QueryParamOnlyTransient.Zero
);
// handle response
```

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

@@ -10,11 +10,11 @@ API Calls interacting with Plex Media Server Libraries
* [GetFileHash](#getfilehash) - Get Hash Value
* [GetRecentlyAdded](#getrecentlyadded) - Get Recently Added
* [GetLibraries](#getlibraries) - Get All Libraries
* [GetLibrary](#getlibrary) - Get Library Details
* [GetAllLibraries](#getalllibraries) - Get All Libraries
* [GetLibraryDetails](#getlibrarydetails) - Get Library Details
* [DeleteLibrary](#deletelibrary) - Delete Library Section
* [GetLibraryItems](#getlibraryitems) - Get Library Items
* [RefreshLibrary](#refreshlibrary) - Refresh Library
* [GetRefreshLibraryMetadata](#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
* [SearchLibrary](#searchlibrary) - Search Library
* [GetMetadata](#getmetadata) - Get Items Metadata
* [GetMetadataChildren](#getmetadatachildren) - Get Items Children
@@ -34,11 +34,13 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Library.GetFileHashAsync(
url: "file://C:\Image.png&type=13",
type: 4462.17D);
type: 4462.17D
);
// handle response
```
@@ -75,7 +77,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Library.GetRecentlyAddedAsync();
@@ -94,7 +97,7 @@ var res = await sdk.Library.GetRecentlyAddedAsync();
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetLibraries
## GetAllLibraries
A library section (commonly referred to as just a library) is a collection of media.
Libraries are typed, and depending on their type provide either a flat or a hierarchical view of the media.
@@ -112,26 +115,27 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Library.GetLibrariesAsync();
var res = await sdk.Library.GetAllLibrariesAsync();
// handle response
```
### Response
**[GetLibrariesResponse](../../Models/Requests/GetLibrariesResponse.md)**
**[GetAllLibrariesResponse](../../Models/Requests/GetAllLibrariesResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| PlexAPI.Models.Errors.GetLibrariesResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
| PlexAPI.Models.Errors.GetAllLibrariesResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetLibrary
## GetLibraryDetails
## Library Details Endpoint
@@ -183,11 +187,13 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Library.GetLibraryAsync(
sectionId: 1000D,
includeDetails: PlexAPI.Models.Requests.IncludeDetails.Zero);
var res = await sdk.Library.GetLibraryDetailsAsync(
sectionId: 15D,
includeDetails: PlexAPI.Models.Requests.IncludeDetails.Zero
);
// handle response
```
@@ -196,24 +202,24 @@ var res = await sdk.Library.GetLibraryAsync(
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `SectionId` | *double* | :heavy_check_mark: | the Id of the library to query | 1000 |
| `SectionId` | *double* | :heavy_check_mark: | The id of the library | 15 |
| `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)**
**[GetLibraryDetailsResponse](../../Models/Requests/GetLibraryDetailsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| PlexAPI.Models.Errors.GetLibraryResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| PlexAPI.Models.Errors.GetLibraryDetailsResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## DeleteLibrary
Delate a library using a specific section
Delete a library using a specific section id
### Example Usage
@@ -224,18 +230,19 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Library.DeleteLibraryAsync(sectionId: 1000D);
var res = await sdk.Library.DeleteLibraryAsync(sectionId: 15D);
// handle response
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `SectionId` | *double* | :heavy_check_mark: | the Id of the library to query | 1000 |
| Parameter | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `SectionId` | *double* | :heavy_check_mark: | The id of the library | 15 |
### Response
@@ -282,12 +289,14 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Library.GetLibraryItemsAsync(
sectionId: "<value>",
tag: PlexAPI.Models.Requests.Tag.Genre,
includeGuids: 1);
includeGuids: 1
);
// handle response
```
@@ -312,9 +321,9 @@ var res = await sdk.Library.GetLibraryItemsAsync(
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## RefreshLibrary
## GetRefreshLibraryMetadata
This endpoint Refreshes the library.
This endpoint Refreshes all the Metadata of the library.
### Example Usage
@@ -326,29 +335,34 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Library.RefreshLibraryAsync(sectionId: 934.16D);
var res = await sdk.Library.GetRefreshLibraryMetadataAsync(
sectionId: 15D,
force: PlexAPI.Models.Requests.Force.One
);
// handle response
```
### Parameters
| Parameter | Type | Required | Description |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `SectionId` | *double* | :heavy_check_mark: | the Id of the library to refresh |
| 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 |
### Response
**[RefreshLibraryResponse](../../Models/Requests/RefreshLibraryResponse.md)**
**[GetRefreshLibraryMetadataResponse](../../Models/Requests/GetRefreshLibraryMetadataResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
| PlexAPI.Models.Errors.RefreshLibraryResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
| PlexAPI.Models.Errors.GetRefreshLibraryMetadataResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## SearchLibrary
@@ -382,21 +396,23 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Library.SearchLibraryAsync(
sectionId: 933505,
type: PlexAPI.Models.Requests.Type.Four);
type: PlexAPI.Models.Requests.Type.Four
);
// handle response
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
| `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 |
| 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 |
### Response
@@ -424,7 +440,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Library.GetMetadataAsync(ratingKey: 8382.31D);
@@ -463,11 +480,13 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Library.GetMetadataChildrenAsync(
ratingKey: 1539.14D,
includeElements: "<value>");
includeElements: "<value>"
);
// handle response
```
@@ -505,11 +524,13 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Library.GetTopWatchedContentAsync(
type: 505531,
includeGuids: 1);
includeGuids: 1
);
// handle response
```
@@ -545,7 +566,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Library.GetOnDeckAsync();

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

@@ -26,12 +26,14 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Log.LogLineAsync(
level: PlexAPI.Models.Requests.Level.Three,
message: "Test log message",
source: "Postman");
source: "Postman"
);
// handle response
```
@@ -89,7 +91,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
string req = "level=4&message=Test%20message%201&source=postman
level=3&message=Test%20message%202&source=postman
@@ -131,7 +134,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Log.EnablePaperTrailAsync();

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

@@ -25,7 +25,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Media.MarkPlayedAsync(key: 59398D);
@@ -63,7 +64,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Media.MarkUnplayedAsync(key: 59398D);
@@ -102,12 +104,14 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Media.UpdatePlayProgressAsync(
key: "<value>",
time: 90000D,
state: "played");
state: "played"
);
// handle response
```

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

@@ -37,7 +37,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
CreatePlaylistRequest req = new CreatePlaylistRequest() {
Title = "<value>",
@@ -82,11 +83,13 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Playlists.GetPlaylistsAsync(
playlistType: PlexAPI.Models.Requests.PlaylistType.Audio,
smart: PlexAPI.Models.Requests.QueryParamSmart.Zero);
smart: PlexAPI.Models.Requests.QueryParamSmart.Zero
);
// handle response
```
@@ -125,7 +128,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Playlists.GetPlaylistAsync(playlistID: 4109.48D);
@@ -164,7 +168,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Playlists.DeletePlaylistAsync(playlistID: 216.22D);
@@ -203,12 +208,14 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Playlists.UpdatePlaylistAsync(
playlistID: 3915D,
title: "<value>",
summary: "<value>");
summary: "<value>"
);
// handle response
```
@@ -250,11 +257,13 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Playlists.GetPlaylistContentsAsync(
playlistID: 5004.46D,
type: 9403.59D);
type: 9403.59D
);
// handle response
```
@@ -292,7 +301,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Playlists.ClearPlaylistContentsAsync(playlistID: 1893.18D);
@@ -332,12 +342,14 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Playlists.AddPlaylistContentsAsync(
playlistID: 8502.01D,
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
playQueueID: 123D);
playQueueID: 123D
);
// handle response
```
@@ -376,11 +388,13 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Playlists.UploadPlaylistAsync(
path: "/home/barkley/playlist.m3u",
force: PlexAPI.Models.Requests.Force.Zero);
force: PlexAPI.Models.Requests.QueryParamForce.Zero
);
// handle response
```
@@ -390,7 +404,7 @@ var res = await sdk.Playlists.UploadPlaylistAsync(
| Parameter | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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/> | |
| `Force` | [QueryParamForce](../../Models/Requests/QueryParamForce.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

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

@@ -29,7 +29,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Plex.GetCompanionsDataAsync();
@@ -66,7 +67,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Plex.GetUserFriendsAsync();
@@ -138,7 +140,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Plex.GetHomeDataAsync();
@@ -174,7 +177,8 @@ 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);
includeIPv6: PlexAPI.Models.Requests.IncludeIPv6.One
);
// handle response
```
@@ -217,7 +221,8 @@ var sdk = new PlexAPISDK(xPlexClientIdentifier: "Postman");
var res = await sdk.Plex.GetPinAsync(
xPlexProduct: "Postman",
strong: false,
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
// handle response
```
@@ -258,7 +263,8 @@ var sdk = new PlexAPISDK(xPlexClientIdentifier: "Postman");
var res = await sdk.Plex.GetTokenByPinIdAsync(
pinID: 408895,
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
// handle response
```
@@ -295,7 +301,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Plex.GetUserDetailsAsync();

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

@@ -37,12 +37,14 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Search.PerformSearchAsync(
query: "dylan",
sectionId: 1516.53D,
limit: 5D);
limit: 5D
);
// handle response
```
@@ -84,12 +86,14 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Search.PerformVoiceSearchAsync(
query: "dead+poop",
sectionId: 4094.8D,
limit: 5D);
limit: 5D
);
// handle response
```
@@ -127,7 +131,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Search.GetSearchResultsAsync(query: "110");

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

@@ -29,7 +29,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Server.GetServerCapabilitiesAsync();
@@ -60,7 +61,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Server.GetServerPreferencesAsync();
@@ -91,7 +93,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Server.GetAvailableClientsAsync();
@@ -122,7 +125,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Server.GetDevicesAsync();
@@ -153,7 +157,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Server.GetServerIdentityAsync();
@@ -184,7 +189,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Server.GetMyPlexAccountAsync();
@@ -217,7 +223,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
GetResizedPhotoRequest req = new GetResizedPhotoRequest() {
Width = 110D,
@@ -264,7 +271,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Server.GetServerListAsync();

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

@@ -25,7 +25,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Sessions.GetSessionsAsync();
@@ -57,13 +58,15 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Sessions.GetSessionHistoryAsync(
sort: "<value>",
accountId: 1,
filter: new Filter() {},
librarySectionID: 12);
librarySectionID: 12
);
// handle response
```
@@ -101,7 +104,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Sessions.GetTranscodeSessionsAsync();
@@ -133,7 +137,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Sessions.StopTranscodeSessionAsync(sessionKey: "zz7llzqlx8w9vnrsbnwhbmep");

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

@@ -25,7 +25,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Statistics.GetStatisticsAsync(timespan: 4);
@@ -63,7 +64,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Statistics.GetResourcesStatisticsAsync(timespan: 4);
@@ -101,7 +103,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Statistics.GetBandwidthStatisticsAsync(timespan: 4);

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

@@ -25,7 +25,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Updater.GetUpdateStatusAsync();
@@ -57,7 +58,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Updater.CheckForUpdatesAsync(download: PlexAPI.Models.Requests.Download.One);
@@ -96,11 +98,13 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Updater.ApplyUpdatesAsync(
tonight: PlexAPI.Models.Requests.Tonight.One,
skip: PlexAPI.Models.Requests.Skip.One);
skip: PlexAPI.Models.Requests.Skip.One
);
// handle response
```

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

@@ -1,53 +0,0 @@
# User
(*User*)
## Overview
API Calls that perform operations with Plex Media Server Users
### Available Operations
* [PostSignIn](#postsignin) - Get User SignIn Data
## PostSignIn
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.PostSignInAsync(
xPlexClientIdentifier: "Postman",
requestBody: new PostSignInRequestBody() {
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` | [PostSignInRequestBody](../../Models/Requests/PostSignInRequestBody.md) | :heavy_minus_sign: | Login credentials | |
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response
**[PostSignInResponse](../../Models/Requests/PostSignInResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| PlexAPI.Models.Errors.PostSignInResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |

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

@@ -24,7 +24,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
GetTimelineRequest req = new GetTimelineRequest() {
RatingKey = 23409D,
@@ -75,7 +76,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
StartUniversalTranscodeRequest req = new StartUniversalTranscodeRequest() {
HasMDE = 1D,

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

@@ -23,7 +23,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
GetWatchlistRequest req = new GetWatchlistRequest() {
Filter = PlexAPI.Models.Requests.PathParamFilter.Released,