LukeParke/plexcsharp
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexcsharp.git synced 2025-12-06 04:20:46 +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

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();