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

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 |