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

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 |