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/butler/README.md
View File

@@ -33,10 +33,10 @@ var res = await sdk.Butler.GetButlerTasksAsync();
// handle response
```
### Response
**[GetButlerTasksResponse](../../Models/Requests/GetButlerTasksResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -44,6 +44,7 @@ var res = await sdk.Butler.GetButlerTasksAsync();
| PlexAPI.Models.Errors.GetButlerTasksResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## StartAllTasks
This endpoint will attempt to start all Butler tasks that are enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
@@ -68,10 +69,10 @@ var res = await sdk.Butler.StartAllTasksAsync();
// handle response
```
### Response
**[StartAllTasksResponse](../../Models/Requests/StartAllTasksResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -79,6 +80,7 @@ var res = await sdk.Butler.StartAllTasksAsync();
| PlexAPI.Models.Errors.StartAllTasksResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## StopAllTasks
This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.
@@ -99,10 +101,10 @@ var res = await sdk.Butler.StopAllTasksAsync();
// handle response
```
### Response
**[StopAllTasksResponse](../../Models/Requests/StopAllTasksResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -110,6 +112,7 @@ var res = await sdk.Butler.StopAllTasksAsync();
| PlexAPI.Models.Errors.StopAllTasksResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## StartTask
This endpoint will attempt to start a single Butler task that is enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
@@ -123,8 +126,8 @@ This endpoint will attempt to start a single Butler task that is enabled in the
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -141,10 +144,10 @@ var res = await sdk.Butler.StartTaskAsync(taskName: PlexAPI.Models.Requests.Task
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| `TaskName` | [TaskName](../../Models/Requests/TaskName.md) | :heavy_check_mark: | the name of the task to be started. |
### Response
**[StartTaskResponse](../../Models/Requests/StartTaskResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -152,6 +155,7 @@ var res = await sdk.Butler.StartTaskAsync(taskName: PlexAPI.Models.Requests.Task
| PlexAPI.Models.Errors.StartTaskResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## StopTask
This endpoint will stop a currently running task by name, or remove it from the list of scheduled tasks if it exists. See the section above for a list of task names for this endpoint.
@@ -161,8 +165,8 @@ This endpoint will stop a currently running task by name, or remove it from the
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -179,10 +183,10 @@ var res = await sdk.Butler.StopTaskAsync(taskName: PlexAPI.Models.Requests.PathP
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
| `TaskName` | [PathParamTaskName](../../Models/Requests/PathParamTaskName.md) | :heavy_check_mark: | The name of the task to be started. |
### Response
**[StopTaskResponse](../../Models/Requests/StopTaskResponse.md)**
### Errors
| Error Object | Status Code | Content Type |