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 0.0.3, Speakeasy CLI 1.129.1

Browse Source
This commit is contained in:
speakeasybot
2024-01-01 15:06:15 +00:00
parent ea6e427d7b
commit b77c4d818f
23 changed files with 487 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/sdks/activities/README.md
View File

@@ -24,10 +24,10 @@ Get Server Activities
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -68,10 +68,10 @@ Cancel Server Activities
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

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

@@ -21,10 +21,10 @@ Returns a list of butler tasks
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -70,10 +70,10 @@ This endpoint will attempt to start all Butler tasks that are enabled in the set
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -115,10 +115,10 @@ This endpoint will stop all currently running tasks and remove any scheduled tas
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -164,11 +164,11 @@ This endpoint will attempt to start a single Butler task that is enabled in the
### Example Usage
```typescript
import { SDK } from "openapi";
import { TaskName } from "openapi/models/operations";
import { PlexAPI } from "plexjs";
import { TaskName } from "plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -213,11 +213,11 @@ This endpoint will stop a currently running task by name, or remove it from the
### Example Usage
```typescript
import { SDK } from "openapi";
import { PathParamTaskName } from "openapi/models/operations";
import { PlexAPI } from "plexjs";
import { PathParamTaskName } from "plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

12
docs/sdks/hubs/README.md
View File

@@ -18,11 +18,11 @@ Get Global Hubs filtered by the parameters provided.
### Example Usage
```typescript
import { SDK } from "openapi";
import { OnlyTransient } from "openapi/models/operations";
import { PlexAPI } from "plexjs";
import { OnlyTransient } from "plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -69,11 +69,11 @@ This endpoint will return a list of library specific hubs
### Example Usage
```typescript
import { SDK } from "openapi";
import { QueryParamOnlyTransient } from "openapi/models/operations";
import { PlexAPI } from "plexjs";
import { QueryParamOnlyTransient } from "plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

50
docs/sdks/library/README.md
View File

@@ -28,10 +28,10 @@ This resource returns hash values for local files
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -78,10 +78,10 @@ This endpoint will return the recently added content.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -128,10 +128,10 @@ This allows a client to provide a rich interface around the media (e.g. allow so
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -191,11 +191,11 @@ Returns details for the library. This can be thought of as an interstitial endpo
### Example Usage
```typescript
import { SDK } from "openapi";
import { IncludeDetails } from "openapi/models/operations";
import { PlexAPI } from "plexjs";
import { IncludeDetails } from "plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -241,10 +241,10 @@ Delate a library using a specific section
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -289,10 +289,10 @@ This endpoint will return a list of library items filtered by the filter and typ
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -341,10 +341,10 @@ This endpoint Refreshes the library.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -389,10 +389,10 @@ This endpoint will return a list of the latest library items filtered by the fil
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -441,10 +441,10 @@ Represents a "Common" item. It contains only the common attributes of the items
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -493,10 +493,10 @@ This endpoint will return the metadata of a library item specified with the rati
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -541,10 +541,10 @@ This endpoint will return the children of of a library item specified with the r
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -589,10 +589,10 @@ This endpoint will return the on deck content.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

14
docs/sdks/log/README.md
View File

@@ -20,11 +20,11 @@ This endpoint will write a single-line log message, including a level and source
### Example Usage
```typescript
import { SDK } from "openapi";
import { Level } from "openapi/models/operations";
import { PlexAPI } from "plexjs";
import { Level } from "plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -73,10 +73,10 @@ This endpoint will write multiple lines to the main Plex Media Server log in a s
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -118,10 +118,10 @@ This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

12
docs/sdks/media/README.md
View File

@@ -19,10 +19,10 @@ This will mark the provided media key as Played.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -66,10 +66,10 @@ This will mark the provided media key as Unplayed.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -114,10 +114,10 @@ This API command can be used to update the play progress of a media item.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

42
docs/sdks/playlists/README.md
View File

@@ -31,11 +31,11 @@ Create a new playlist. By default the playlist is blank. To create a playlist al
### Example Usage
```typescript
import { SDK } from "openapi";
import { Smart, TypeT } from "openapi/models/operations";
import { PlexAPI } from "plexjs";
import { Smart, TypeT } from "plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -81,11 +81,11 @@ Get All Playlists given the specified filters.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlaylistType, QueryParamSmart } from "openapi/models/operations";
import { PlexAPI } from "plexjs";
import { PlaylistType, QueryParamSmart } from "plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -133,10 +133,10 @@ Smart playlist details contain the `content` attribute. This is the content URI
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -181,10 +181,10 @@ This endpoint will delete a playlist
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -229,10 +229,10 @@ From PMS version 1.9.1 clients can also edit playlist metadata using this endpoi
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -280,10 +280,10 @@ Note that for dumb playlists, items have a `playlistItemID` attribute which is u
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -330,10 +330,10 @@ Clears a playlist, only works with dumb playlists. Returns the playlist.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -379,10 +379,10 @@ With a smart playlist, passing a new `uri` parameter replaces the rules for the
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -431,11 +431,11 @@ Imports m3u playlists by passing a path on the server to scan for m3u-formatted
### Example Usage
```typescript
import { SDK } from "openapi";
import { Force } from "openapi/models/operations";
import { PlexAPI } from "plexjs";
import { Force } from "plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

2
docs/sdks/sdk/README.md → docs/sdks/plexapi/README.md
View File

@@ -1,4 +1,4 @@
# SDK
# PlexAPI SDK
## Overview

12
docs/sdks/search/README.md
View File

@@ -31,10 +31,10 @@ This request is intended to be very fast, and called as the user types.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -86,10 +86,10 @@ Results, as well as their containing per-type hubs, contain a `distance` attribu
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -137,10 +137,10 @@ This will search the database for the string provided.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

10
docs/sdks/security/README.md
View File

@@ -19,11 +19,11 @@ This endpoint provides the caller with a temporary token with the same access le
### Example Usage
```typescript
import { SDK } from "openapi";
import { QueryParamType, Scope } from "openapi/models/operations";
import { PlexAPI } from "plexjs";
import { QueryParamType, Scope } from "plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -71,10 +71,10 @@ Note: requires Plex Media Server >= 1.15.4.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

34
docs/sdks/server/README.md
View File

@@ -24,10 +24,10 @@ Server Capabilities
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -68,10 +68,10 @@ Get Server Preferences
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -112,10 +112,10 @@ Get Available Clients
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -156,10 +156,10 @@ Get Devices
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -200,10 +200,10 @@ Get Server Identity
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -244,10 +244,10 @@ Returns MyPlex Account Information
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -289,11 +289,11 @@ Plex's Photo transcoder is used throughout the service to serve images at specif
### Example Usage
```typescript
import { SDK } from "openapi";
import { MinSize, Upscale } from "openapi/models/operations";
import { PlexAPI } from "plexjs";
import { MinSize, Upscale } from "plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -343,10 +343,10 @@ Get Server List
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

16
docs/sdks/sessions/README.md
View File

@@ -20,10 +20,10 @@ This will retrieve the "Now Playing" Information of the PMS.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -64,10 +64,10 @@ This will Retrieve a listing of all history views.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -108,10 +108,10 @@ Get Transcode Sessions
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -152,10 +152,10 @@ Stop a Transcode Session
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

16
docs/sdks/updater/README.md
View File

@@ -20,10 +20,10 @@ Querying status of updates
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -64,11 +64,11 @@ Checking for updates
### Example Usage
```typescript
import { SDK } from "openapi";
import { Download } from "openapi/models/operations";
import { PlexAPI } from "plexjs";
import { Download } from "plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -113,11 +113,11 @@ Note that these two parameters are effectively mutually exclusive. The `tonight`
### Example Usage
```typescript
import { SDK } from "openapi";
import { Skip, Tonight } from "openapi/models/operations";
import { PlexAPI } from "plexjs";
import { Skip, Tonight } from "plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

10
docs/sdks/video/README.md
View File

@@ -18,10 +18,10 @@ Begin a Universal Transcode Session
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -69,11 +69,11 @@ Get the timeline for a media item
### Example Usage
```typescript
import { SDK } from "openapi";
import { State } from "openapi/models/operations";
import { PlexAPI } from "plexjs";
import { State } from "plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});