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

Browse Source
This commit is contained in:
speakeasybot
2024-04-13 00:26:21 +00:00
parent 0d73a769fb
commit 779aa2dc9e
23 changed files with 431 additions and 420 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -23,13 +23,13 @@ Returns a list of butler tasks
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "<value>",
});
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "<value>",
});
const result = await sdk.butler.getButlerTasks();
async function run() {
const result = await plexAPI.butler.getButlerTasks();
// Handle the result
console.log(result)
@@ -70,13 +70,13 @@ This endpoint will attempt to start all Butler tasks that are enabled in the set
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "<value>",
});
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "<value>",
});
const result = await sdk.butler.startAllTasks();
async function run() {
const result = await plexAPI.butler.startAllTasks();
// Handle the result
console.log(result)
@@ -113,13 +113,13 @@ This endpoint will stop all currently running tasks and remove any scheduled tas
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "<value>",
});
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "<value>",
});
const result = await sdk.butler.stopAllTasks();
async function run() {
const result = await plexAPI.butler.stopAllTasks();
// Handle the result
console.log(result)
@@ -161,15 +161,15 @@ This endpoint will attempt to start a single Butler task that is enabled in the
import { PlexAPI } from "@lukehagar/plexjs";
import { TaskName } from "@lukehagar/plexjs/models/operations";
async function run() {
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "<value>",
});
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "<value>",
});
async function run() {
const taskName = TaskName.CleanOldBundles;
const result = await sdk.butler.startTask(taskName);
const result = await plexAPI.butler.startTask(taskName);
// Handle the result
console.log(result)
@@ -208,15 +208,15 @@ This endpoint will stop a currently running task by name, or remove it from the
import { PlexAPI } from "@lukehagar/plexjs";
import { PathParamTaskName } from "@lukehagar/plexjs/models/operations";
async function run() {
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "<value>",
});
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "<value>",
});
async function run() {
const taskName = PathParamTaskName.BackupDatabase;
const result = await sdk.butler.stopTask(taskName);
const result = await plexAPI.butler.stopTask(taskName);
// Handle the result
console.log(result)