LukeParke/plexphp
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexphp.git synced 2025-12-06 04:20:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.397.2

Browse Source
This commit is contained in:
speakeasybot
2024-09-16 18:45:25 +00:00
parent 19c1b2538f
commit b16d07066d
1324 changed files with 32606 additions and 8388 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,6 +1,5 @@
# Butler
## Overview
Butler is the task manager of the Plex Media Server Ecosystem.
@@ -28,11 +27,12 @@ require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Components;
$security = new Components\Security();
$security->accessToken = '<YOUR_API_KEY_HERE>';
$security = new Components\Security(
accessToken: "<YOUR_API_KEY_HERE>",
);
$sdk = Plex_API\PlexAPI::builder()
->setXPlexClientIdentifier('Postman')
->setXPlexClientIdentifier('gcgzw5rz2xovp84b4vha3a40')
->setSecurity($security)->build();
try {
@@ -46,17 +46,19 @@ try {
}
```
### Response
**[?Operations\GetButlerTasksResponse](../../Models/Operations/GetButlerTasksResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| Errors\GetButlerTasksResponseBody | 401 | application/json |
| Errors\GetButlerTasksBadRequest | 400 | application/json |
| Errors\GetButlerTasksUnauthorized | 401 | application/json |
| LukeHagar\Plex_API\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:
@@ -76,11 +78,12 @@ require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Components;
$security = new Components\Security();
$security->accessToken = '<YOUR_API_KEY_HERE>';
$security = new Components\Security(
accessToken: "<YOUR_API_KEY_HERE>",
);
$sdk = Plex_API\PlexAPI::builder()
->setXPlexClientIdentifier('Postman')
->setXPlexClientIdentifier('gcgzw5rz2xovp84b4vha3a40')
->setSecurity($security)->build();
try {
@@ -94,17 +97,19 @@ try {
}
```
### Response
**[?Operations\StartAllTasksResponse](../../Models/Operations/StartAllTasksResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| Errors\StartAllTasksResponseBody | 401 | application/json |
| Errors\StartAllTasksBadRequest | 400 | application/json |
| Errors\StartAllTasksUnauthorized | 401 | application/json |
| LukeHagar\Plex_API\Models\Errors.SDKException | 4xx-5xx | */* |
## stopAllTasks
This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.
@@ -120,11 +125,12 @@ require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Components;
$security = new Components\Security();
$security->accessToken = '<YOUR_API_KEY_HERE>';
$security = new Components\Security(
accessToken: "<YOUR_API_KEY_HERE>",
);
$sdk = Plex_API\PlexAPI::builder()
->setXPlexClientIdentifier('Postman')
->setXPlexClientIdentifier('gcgzw5rz2xovp84b4vha3a40')
->setSecurity($security)->build();
try {
@@ -138,17 +144,19 @@ try {
}
```
### Response
**[?Operations\StopAllTasksResponse](../../Models/Operations/StopAllTasksResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| Errors\StopAllTasksResponseBody | 401 | application/json |
| Errors\StopAllTasksBadRequest | 400 | application/json |
| Errors\StopAllTasksUnauthorized | 401 | application/json |
| LukeHagar\Plex_API\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:
@@ -169,11 +177,12 @@ use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Components;
use LukeHagar\Plex_API\Models\Operations;
$security = new Components\Security();
$security->accessToken = '<YOUR_API_KEY_HERE>';
$security = new Components\Security(
accessToken: "<YOUR_API_KEY_HERE>",
);
$sdk = Plex_API\PlexAPI::builder()
->setXPlexClientIdentifier('Postman')
->setXPlexClientIdentifier('gcgzw5rz2xovp84b4vha3a40')
->setSecurity($security)->build();
try {
@@ -194,17 +203,19 @@ try {
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `taskName` | [Operations\TaskName](../../Models/Operations/TaskName.md) | :heavy_check_mark: | the name of the task to be started. |
### Response
**[?Operations\StartTaskResponse](../../Models/Operations/StartTaskResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| Errors\StartTaskResponseBody | 401 | application/json |
| Errors\StartTaskBadRequest | 400 | application/json |
| Errors\StartTaskUnauthorized | 401 | application/json |
| LukeHagar\Plex_API\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.
@@ -221,11 +232,12 @@ use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Components;
use LukeHagar\Plex_API\Models\Operations;
$security = new Components\Security();
$security->accessToken = '<YOUR_API_KEY_HERE>';
$security = new Components\Security(
accessToken: "<YOUR_API_KEY_HERE>",
);
$sdk = Plex_API\PlexAPI::builder()
->setXPlexClientIdentifier('Postman')
->setXPlexClientIdentifier('gcgzw5rz2xovp84b4vha3a40')
->setSecurity($security)->build();
try {
@@ -246,13 +258,14 @@ try {
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `taskName` | [Operations\PathParamTaskName](../../Models/Operations/PathParamTaskName.md) | :heavy_check_mark: | The name of the task to be started. |
### Response
**[?Operations\StopTaskResponse](../../Models/Operations/StopTaskResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| Errors\StopTaskResponseBody | 401 | application/json |
| Errors\StopTaskBadRequest | 400 | application/json |
| Errors\StopTaskUnauthorized | 401 | application/json |
| LukeHagar\Plex_API\Models\Errors.SDKException | 4xx-5xx | */* |