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:12:41 +00:00
parent f200bc563f
commit 9b02d27d5e
20 changed files with 424 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -24,7 +24,7 @@ Get Server Activities
### Example Usage
```typescript
import { PlexAPI } from "plexjs";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new PlexAPI({
@@ -68,7 +68,7 @@ Cancel Server Activities
### Example Usage
```typescript
import { PlexAPI } from "plexjs";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new PlexAPI({

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -18,7 +18,7 @@ Begin a Universal Transcode Session
### Example Usage
```typescript
import { PlexAPI } from "plexjs";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new PlexAPI({
@@ -69,8 +69,8 @@ Get the timeline for a media item
### Example Usage
```typescript
import { PlexAPI } from "plexjs";
import { State } from "plexjs/models/operations";
import { PlexAPI } from "@lukehagar/plexjs";
import { State } from "@lukehagar/plexjs/models/operations";
async function run() {
const sdk = new PlexAPI({