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

Browse Source
This commit is contained in:
speakeasybot
2025-06-04 00:26:20 +00:00
parent 55b5c2b3dd
commit bc02ecef34
204 changed files with 2222 additions and 1924 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -125,7 +125,7 @@ using LukeHagar.PlexAPI.SDK.Models.Requests;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Butler.StartTaskAsync(taskName: TaskName.CleanOldBundles);
var res = await sdk.Butler.StartTaskAsync(taskName: TaskName.RefreshPeriodicMetadata);
// handle response
```
@@ -162,7 +162,7 @@ using LukeHagar.PlexAPI.SDK.Models.Requests;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Butler.StopTaskAsync(taskName: PathParamTaskName.BackupDatabase);
var res = await sdk.Butler.StopTaskAsync(taskName: PathParamTaskName.CleanOldCacheFiles);
// handle response
```

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

@@ -21,14 +21,10 @@ Get Global Hubs filtered by the parameters provided.
```csharp
using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Hubs.GetGlobalHubsAsync(
count: 1262.49D,
onlyTransient: OnlyTransient.One
);
var res = await sdk.Hubs.GetGlobalHubsAsync();
// handle response
```
@@ -67,9 +63,10 @@ using LukeHagar.PlexAPI.SDK.Models.Requests;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
GetRecentlyAddedRequest req = new GetRecentlyAddedRequest() {
ContentDirectoryID = 470161,
ContentDirectoryID = 39486,
SectionID = 2,
Type = LukeHagar.PlexAPI.SDK.Models.Requests.Type.TvShow,
IncludeMeta = IncludeMeta.Enable,
};
var res = await sdk.Hubs.GetRecentlyAddedAsync(req);
@@ -103,15 +100,10 @@ This endpoint will return a list of library specific hubs
```csharp
using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Hubs.GetLibraryHubsAsync(
sectionId: 6728.76D,
count: 639.24D,
onlyTransient: QueryParamOnlyTransient.One
);
var res = await sdk.Hubs.GetLibraryHubsAsync(sectionId: 492.74D);
// handle response
```

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

@@ -14,7 +14,7 @@ API Calls interacting with Plex Media Server Libraries
* [GetLibraryDetails](#getlibrarydetails) - Get Library Details
* [DeleteLibrary](#deletelibrary) - Delete Library Section
* [GetLibraryItems](#getlibraryitems) - Get Library Items
* [GetAllMediaLibrary](#getallmedialibrary) - Get all media of library
* [GetLibrarySectionsAll](#getlibrarysectionsall) - Get Library section media by tag ALL
* [GetRefreshLibraryMetadata](#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
* [GetSearchLibrary](#getsearchlibrary) - Search Library
* [GetGenresLibrary](#getgenreslibrary) - Get Genres of library media
@@ -41,10 +41,7 @@ using LukeHagar.PlexAPI.SDK.Models.Components;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Library.GetFileHashAsync(
url: "file://C:\Image.png&type=13",
type: 4462.17D
);
var res = await sdk.Library.GetFileHashAsync(url: "file://C:\Image.png&type=13");
// handle response
```
@@ -101,6 +98,7 @@ GetRecentlyAddedLibraryRequest req = new GetRecentlyAddedLibraryRequest() {
},
SectionID = 2,
Type = QueryParamType.TvShow,
IncludeMeta = QueryParamIncludeMeta.Enable,
};
var res = await sdk.Library.GetRecentlyAddedLibraryAsync(req);
@@ -310,9 +308,11 @@ using LukeHagar.PlexAPI.SDK.Models.Requests;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
GetLibraryItemsRequest req = new GetLibraryItemsRequest() {
Tag = Tag.Edition,
Tag = Tag.Newest,
IncludeGuids = IncludeGuids.Enable,
Type = GetLibraryItemsQueryParamType.TvShow,
SectionKey = 9518,
IncludeMeta = GetLibraryItemsQueryParamIncludeMeta.Enable,
};
var res = await sdk.Library.GetLibraryItemsAsync(req);
@@ -338,7 +338,7 @@ var res = await sdk.Library.GetLibraryItemsAsync(req);
| LukeHagar.PlexAPI.SDK.Models.Errors.GetLibraryItemsUnauthorized | 401 | application/json |
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
## GetAllMediaLibrary
## GetLibrarySectionsAll
Retrieves a list of all general media data for this library.
@@ -352,33 +352,38 @@ using LukeHagar.PlexAPI.SDK.Models.Requests;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
GetAllMediaLibraryRequest req = new GetAllMediaLibraryRequest() {
GetLibrarySectionsAllRequest req = new GetLibrarySectionsAllRequest() {
SectionKey = 9518,
Type = GetAllMediaLibraryQueryParamType.TvShow,
Type = GetLibrarySectionsAllQueryParamType.TvShow,
IncludeMeta = GetLibrarySectionsAllQueryParamIncludeMeta.Enable,
IncludeGuids = QueryParamIncludeGuids.Enable,
IncludeAdvanced = IncludeAdvanced.Enable,
IncludeCollections = QueryParamIncludeCollections.Enable,
IncludeExternalMedia = QueryParamIncludeExternalMedia.Enable,
};
var res = await sdk.Library.GetAllMediaLibraryAsync(req);
var res = await sdk.Library.GetLibrarySectionsAllAsync(req);
// handle response
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `request` | [GetAllMediaLibraryRequest](../../Models/Requests/GetAllMediaLibraryRequest.md) | :heavy_check_mark: | The request object to use for the request. |
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `request` | [GetLibrarySectionsAllRequest](../../Models/Requests/GetLibrarySectionsAllRequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[GetAllMediaLibraryResponse](../../Models/Requests/GetAllMediaLibraryResponse.md)**
**[GetLibrarySectionsAllResponse](../../Models/Requests/GetLibrarySectionsAllResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| LukeHagar.PlexAPI.SDK.Models.Errors.GetAllMediaLibraryBadRequest | 400 | application/json |
| LukeHagar.PlexAPI.SDK.Models.Errors.GetAllMediaLibraryUnauthorized | 401 | application/json |
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
| Error Type | Status Code | Content Type |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| LukeHagar.PlexAPI.SDK.Models.Errors.GetLibrarySectionsAllBadRequest | 400 | application/json |
| LukeHagar.PlexAPI.SDK.Models.Errors.GetLibrarySectionsAllUnauthorized | 401 | application/json |
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
## GetRefreshLibraryMetadata
@@ -396,7 +401,7 @@ var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Library.GetRefreshLibraryMetadataAsync(
sectionKey: 9518,
force: Force.One
force: Force.Zero
);
// handle response
@@ -623,6 +628,8 @@ GetSearchAllLibrariesRequest req = new GetSearchAllLibrariesRequest() {
SearchTypes = new List<SearchTypes>() {
SearchTypes.People,
},
IncludeCollections = GetSearchAllLibrariesQueryParamIncludeCollections.Enable,
IncludeExternalMedia = GetSearchAllLibrariesQueryParamIncludeExternalMedia.Enable,
};
var res = await sdk.Library.GetSearchAllLibrariesAsync(req);
@@ -650,7 +657,8 @@ var res = await sdk.Library.GetSearchAllLibrariesAsync(req);
## GetMediaMetaData
This endpoint will return all the (meta)data of a library item specified with by the ratingKey.
This endpoint will return all the (meta)data of one or more library items specified by the ratingKey.
Multiple rating keys can be provided as a comma-separated list (e.g., "21119,21617").
### Example Usage
@@ -663,7 +671,7 @@ using LukeHagar.PlexAPI.SDK.Models.Requests;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
GetMediaMetaDataRequest req = new GetMediaMetaDataRequest() {
RatingKey = 9518,
RatingKey = "21119,21617",
IncludeConcerts = true,
IncludeExtras = true,
IncludeOnDeck = true,
@@ -744,14 +752,12 @@ Uploads an image to use as the background artwork for a library item, either fro
```csharp
using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using System;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Library.PostMediaArtsAsync(
ratingKey: 2268,
url: "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b",
requestBody: System.Text.Encoding.UTF8.GetBytes("0xee51EFC6De")
url: "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b"
);
// handle response
@@ -817,14 +823,12 @@ Uploads a poster to a library item, either from a local file or a remote URL
```csharp
using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using System;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Library.PostMediaPosterAsync(
ratingKey: 2268,
url: "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b",
requestBody: System.Text.Encoding.UTF8.GetBytes("0x7C3d45ad4B")
url: "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b"
);
// handle response
@@ -862,8 +866,8 @@ using LukeHagar.PlexAPI.SDK.Models.Components;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Library.GetMetadataChildrenAsync(
ratingKey: 1539.14D,
includeElements: "<value>"
ratingKey: 2403.67D,
includeElements: "Stream"
);
// handle response
@@ -904,7 +908,7 @@ var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Library.GetTopWatchedContentAsync(
type: GetTopWatchedContentQueryParamType.TvShow,
includeGuids: 1
includeGuids: GetTopWatchedContentQueryParamIncludeGuids.Enable
);
// handle response
@@ -915,7 +919,7 @@ var res = await sdk.Library.GetTopWatchedContentAsync(
| Parameter | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Type` | [GetTopWatchedContentQueryParamType](../../Models/Requests/GetTopWatchedContentQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `IncludeGuids` | *long* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `IncludeGuids` | [GetTopWatchedContentQueryParamIncludeGuids](../../Models/Requests/GetTopWatchedContentQueryParamIncludeGuids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
### Response

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

@@ -39,9 +39,9 @@ var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
CreatePlaylistRequest req = new CreatePlaylistRequest() {
Title = "<value>",
Type = CreatePlaylistQueryParamType.Photo,
Type = CreatePlaylistQueryParamType.Audio,
Smart = Smart.One,
Uri = "https://hoarse-testing.info/",
Uri = "https://short-term-disconnection.name/",
};
var res = await sdk.Playlists.CreatePlaylistAsync(req);
@@ -76,14 +76,10 @@ Get All Playlists given the specified filters.
```csharp
using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Playlists.GetPlaylistsAsync(
playlistType: PlaylistType.Audio,
smart: QueryParamSmart.Zero
);
var res = await sdk.Playlists.GetPlaylistsAsync();
// handle response
```
@@ -121,7 +117,7 @@ using LukeHagar.PlexAPI.SDK.Models.Components;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Playlists.GetPlaylistAsync(playlistID: 4109.48D);
var res = await sdk.Playlists.GetPlaylistAsync(playlistID: 8419.53D);
// handle response
```
@@ -157,7 +153,7 @@ using LukeHagar.PlexAPI.SDK.Models.Components;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Playlists.DeletePlaylistAsync(playlistID: 216.22D);
var res = await sdk.Playlists.DeletePlaylistAsync(playlistID: 3432.93D);
// handle response
```
@@ -193,11 +189,7 @@ using LukeHagar.PlexAPI.SDK.Models.Components;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Playlists.UpdatePlaylistAsync(
playlistID: 3915D,
title: "<value>",
summary: "<value>"
);
var res = await sdk.Playlists.UpdatePlaylistAsync(playlistID: 1579.66D);
// handle response
```
@@ -240,7 +232,7 @@ using LukeHagar.PlexAPI.SDK.Models.Requests;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Playlists.GetPlaylistContentsAsync(
playlistID: 5004.46D,
playlistID: 5535.42D,
type: GetPlaylistContentsQueryParamType.TvShow
);
@@ -279,7 +271,7 @@ using LukeHagar.PlexAPI.SDK.Models.Components;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Playlists.ClearPlaylistContentsAsync(playlistID: 1893.18D);
var res = await sdk.Playlists.ClearPlaylistContentsAsync(playlistID: 4137.37D);
// handle response
```
@@ -317,7 +309,7 @@ using LukeHagar.PlexAPI.SDK.Models.Components;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Playlists.AddPlaylistContentsAsync(
playlistID: 8502.01D,
playlistID: 7013.44D,
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
playQueueID: 123D
);
@@ -361,7 +353,7 @@ var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Playlists.UploadPlaylistAsync(
path: "/home/barkley/playlist.m3u",
force: QueryParamForce.Zero,
force: QueryParamForce.One,
sectionID: 1
);

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

@@ -250,7 +250,7 @@ using LukeHagar.PlexAPI.SDK.Models.Requests;
var sdk = new PlexAPI();
GetTokenByPinIdRequest req = new GetTokenByPinIdRequest() {
PinID = 408895,
PinID = 232248,
ClientID = "3381b62b-9ab7-4e37-827b-203e9809eb58",
ClientName = "Plex for Roku",
DeviceNickname = "Roku 3",

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

@@ -37,8 +37,7 @@ using LukeHagar.PlexAPI.SDK.Models.Components;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Search.PerformSearchAsync(
query: "dylan",
sectionId: 9372.7D,
query: "arnold",
limit: 5D
);
@@ -83,7 +82,6 @@ var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Search.PerformVoiceSearchAsync(
query: "dead+poop",
sectionId: 4094.8D,
limit: 5D
);

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

@@ -207,10 +207,9 @@ var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
GetResizedPhotoRequest req = new GetResizedPhotoRequest() {
Width = 110D,
Height = 165D,
Opacity = 100,
Blur = 20D,
Blur = 0D,
MinSize = MinSize.Zero,
Upscale = Upscale.One,
Upscale = Upscale.Zero,
Url = "/library/metadata/49564/thumb/1654258204",
};

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

@@ -56,7 +56,7 @@ using LukeHagar.PlexAPI.SDK.Models.Requests;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Sessions.GetSessionHistoryAsync(
sort: "<value>",
sort: "viewedAt:desc",
accountId: 1,
filter: new QueryParamFilter() {},
librarySectionID: 12

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

@@ -24,7 +24,7 @@ using LukeHagar.PlexAPI.SDK.Models.Requests;
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
GetWatchListRequest req = new GetWatchListRequest() {
Filter = Filter.Available,
Filter = Filter.Released,
XPlexToken = "CV5xoxjTpFKUzBTShsaf",
};