LukeParke/plexjs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexjs.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.405.6

Browse Source
This commit is contained in:
speakeasybot
2024-10-01 00:12:18 +00:00
parent e254f82e06
commit ead0a8773c
395 changed files with 18599 additions and 5928 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -25,14 +25,18 @@ import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
clientID: "gcgzw5rz2xovp84b4vha3a40",
clientName: "Plex Web",
clientVersion: "4.133.0",
clientPlatform: "Chrome",
deviceName: "Linux",
});
async function run() {
const result = await plexAPI.butler.getButlerTasks();
// Handle the result
console.log(result)
console.log(result);
}
run();
@@ -50,7 +54,11 @@ import { butlerGetButlerTasks } from "@lukehagar/plexjs/funcs/butlerGetButlerTas
// You can create one instance of it to use across an application.
const plexAPI = new PlexAPICore({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
clientID: "gcgzw5rz2xovp84b4vha3a40",
clientName: "Plex Web",
clientVersion: "4.133.0",
clientPlatform: "Chrome",
deviceName: "Linux",
});
async function run() {
@@ -63,7 +71,7 @@ async function run() {
const { value: result } = res;
// Handle the result
console.log(result)
console.log(result);
}
run();
@@ -83,12 +91,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| errors.GetButlerTasksBadRequest | 400 | application/json |
| errors.GetButlerTasksUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| errors.SDKError | 4XX, 5XX | \*/\* |
## startAllTasks
@@ -106,14 +113,18 @@ import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
clientID: "gcgzw5rz2xovp84b4vha3a40",
clientName: "Plex Web",
clientVersion: "4.133.0",
clientPlatform: "Chrome",
deviceName: "Linux",
});
async function run() {
const result = await plexAPI.butler.startAllTasks();
// Handle the result
console.log(result)
console.log(result);
}
run();
@@ -131,7 +142,11 @@ import { butlerStartAllTasks } from "@lukehagar/plexjs/funcs/butlerStartAllTasks
// You can create one instance of it to use across an application.
const plexAPI = new PlexAPICore({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
clientID: "gcgzw5rz2xovp84b4vha3a40",
clientName: "Plex Web",
clientVersion: "4.133.0",
clientPlatform: "Chrome",
deviceName: "Linux",
});
async function run() {
@@ -144,7 +159,7 @@ async function run() {
const { value: result } = res;
// Handle the result
console.log(result)
console.log(result);
}
run();
@@ -164,12 +179,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------------- | -------------------------------- | -------------------------------- |
| errors.StartAllTasksBadRequest | 400 | application/json |
| errors.StartAllTasksUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| errors.SDKError | 4XX, 5XX | \*/\* |
## stopAllTasks
@@ -183,14 +197,18 @@ import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
clientID: "gcgzw5rz2xovp84b4vha3a40",
clientName: "Plex Web",
clientVersion: "4.133.0",
clientPlatform: "Chrome",
deviceName: "Linux",
});
async function run() {
const result = await plexAPI.butler.stopAllTasks();
// Handle the result
console.log(result)
console.log(result);
}
run();
@@ -208,7 +226,11 @@ import { butlerStopAllTasks } from "@lukehagar/plexjs/funcs/butlerStopAllTasks.j
// You can create one instance of it to use across an application.
const plexAPI = new PlexAPICore({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
clientID: "gcgzw5rz2xovp84b4vha3a40",
clientName: "Plex Web",
clientVersion: "4.133.0",
clientPlatform: "Chrome",
deviceName: "Linux",
});
async function run() {
@@ -221,7 +243,7 @@ async function run() {
const { value: result } = res;
// Handle the result
console.log(result)
console.log(result);
}
run();
@@ -241,12 +263,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------- | ------------------------------- | ------------------------------- |
| errors.StopAllTasksBadRequest | 400 | application/json |
| errors.StopAllTasksUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| errors.SDKError | 4XX, 5XX | \*/\* |
## startTask
@@ -265,14 +286,18 @@ import { TaskName } from "@lukehagar/plexjs/sdk/models/operations";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
clientID: "gcgzw5rz2xovp84b4vha3a40",
clientName: "Plex Web",
clientVersion: "4.133.0",
clientPlatform: "Chrome",
deviceName: "Linux",
});
async function run() {
const result = await plexAPI.butler.startTask(TaskName.CleanOldBundles);
// Handle the result
console.log(result)
console.log(result);
}
run();
@@ -291,7 +316,11 @@ import { TaskName } from "@lukehagar/plexjs/sdk/models/operations";
// You can create one instance of it to use across an application.
const plexAPI = new PlexAPICore({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
clientID: "gcgzw5rz2xovp84b4vha3a40",
clientName: "Plex Web",
clientVersion: "4.133.0",
clientPlatform: "Chrome",
deviceName: "Linux",
});
async function run() {
@@ -304,7 +333,7 @@ async function run() {
const { value: result } = res;
// Handle the result
console.log(result)
console.log(result);
}
run();
@@ -325,12 +354,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ---------------------------- | ---------------------------- | ---------------------------- |
| errors.StartTaskBadRequest | 400 | application/json |
| errors.StartTaskUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| errors.SDKError | 4XX, 5XX | \*/\* |
## stopTask
@@ -345,14 +373,18 @@ import { PathParamTaskName } from "@lukehagar/plexjs/sdk/models/operations";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
clientID: "gcgzw5rz2xovp84b4vha3a40",
clientName: "Plex Web",
clientVersion: "4.133.0",
clientPlatform: "Chrome",
deviceName: "Linux",
});
async function run() {
const result = await plexAPI.butler.stopTask(PathParamTaskName.BackupDatabase);
// Handle the result
console.log(result)
console.log(result);
}
run();
@@ -371,7 +403,11 @@ import { PathParamTaskName } from "@lukehagar/plexjs/sdk/models/operations";
// You can create one instance of it to use across an application.
const plexAPI = new PlexAPICore({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
clientID: "gcgzw5rz2xovp84b4vha3a40",
clientName: "Plex Web",
clientVersion: "4.133.0",
clientPlatform: "Chrome",
deviceName: "Linux",
});
async function run() {
@@ -384,7 +420,7 @@ async function run() {
const { value: result } = res;
// Handle the result
console.log(result)
console.log(result);
}
run();
@@ -405,8 +441,8 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------- | --------------------------- | --------------------------- |
| errors.StopTaskBadRequest | 400 | application/json |
| errors.StopTaskUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| errors.SDKError | 4XX, 5XX | \*/\* |