mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
Compare commits
65 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
03910be91f | ||
|
|
25ed9aa97d | ||
|
|
cf2cf981be | ||
|
|
de0bc5c344 | ||
|
|
c31a963aa6 | ||
|
|
faffbfd137 | ||
|
|
2853ce6b54 | ||
|
|
ed63eb13b9 | ||
|
|
442b11c11a | ||
|
|
c56a0f5d3c | ||
|
|
fe48f93ccb | ||
|
|
a7ec77cd04 | ||
|
|
2b38478255 | ||
|
|
6bd12d8759 | ||
|
|
891a7d39a1 | ||
|
|
763aa8e800 | ||
|
|
7a950ea773 | ||
|
|
379a408d74 | ||
|
|
2712820397 | ||
|
|
c895213ae8 | ||
|
|
c473c9d326 | ||
|
|
3c13bba9de | ||
|
|
650c5043ef | ||
|
|
0234804578 | ||
|
|
60d913c8f9 | ||
|
|
8d9f4bbaf1 | ||
|
|
5d57cd7c34 | ||
|
|
1a8e227874 | ||
|
|
8360d057ab | ||
|
|
18b64727c3 | ||
|
|
3152372037 | ||
|
|
13cd8a7fe5 | ||
|
|
cdcdc0ca8e | ||
|
|
b03cc6a609 | ||
|
|
4e989e0de3 | ||
|
|
c10e011a68 | ||
|
|
7e3dca8466 | ||
|
|
8a2d3e04ab | ||
|
|
6c8a73ae84 | ||
|
|
c839d9f6c7 | ||
|
|
77b0ef9507 | ||
|
|
1cfbd17f28 | ||
|
|
2492807c65 | ||
|
|
ead0a8773c | ||
|
|
e254f82e06 | ||
|
|
a4369c999a | ||
|
|
c50b85f29a | ||
|
|
496ebda695 | ||
|
|
d436fc3452 | ||
|
|
99cdf6effe | ||
|
|
fa2ba82f62 | ||
|
|
fd8095a8df | ||
|
|
9911164ab0 | ||
|
|
ffedf47cad | ||
|
|
39d3a40524 | ||
|
|
8dc802ca50 | ||
|
|
5465f1e74c | ||
|
|
2d100b8e75 | ||
|
|
0533836427 | ||
|
|
f0b08b9bd9 | ||
|
|
244adab882 | ||
|
|
4d8ee6c199 | ||
|
|
4fe1356250 | ||
|
|
454b20d045 | ||
|
|
8c39ddc475 |
@@ -1,28 +0,0 @@
|
|||||||
/* eslint-env node */
|
|
||||||
module.exports = {
|
|
||||||
root: true,
|
|
||||||
extends: [
|
|
||||||
"eslint:recommended",
|
|
||||||
"plugin:@typescript-eslint/recommended",
|
|
||||||
"plugin:import/recommended",
|
|
||||||
"plugin:import/typescript",
|
|
||||||
],
|
|
||||||
parser: "@typescript-eslint/parser",
|
|
||||||
plugins: ["@typescript-eslint"],
|
|
||||||
settings: {
|
|
||||||
"import/resolver": {
|
|
||||||
typescript: true,
|
|
||||||
node: true,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
rules: {
|
|
||||||
// Handled by typescript compiler
|
|
||||||
"@typescript-eslint/no-unused-vars": "off",
|
|
||||||
"@typescript-eslint/ban-types": "off",
|
|
||||||
"@typescript-eslint/no-namespace": "off",
|
|
||||||
"@typescript-eslint/no-explicit-any": "off",
|
|
||||||
"import/no-named-as-default-member": "off",
|
|
||||||
|
|
||||||
"import/no-default-export": "error",
|
|
||||||
},
|
|
||||||
};
|
|
||||||
33
.github/workflows/publish-jsr.yaml
vendored
33
.github/workflows/publish-jsr.yaml
vendored
@@ -1,33 +0,0 @@
|
|||||||
name: Publish to JSR
|
|
||||||
permissions:
|
|
||||||
checks: write
|
|
||||||
contents: write
|
|
||||||
pull-requests: write
|
|
||||||
statuses: write
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
publish:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
id-token: write
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Set up Node.js
|
|
||||||
uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version: 18
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: npm install
|
|
||||||
|
|
||||||
- name: Publish package
|
|
||||||
run: npx jsr publish
|
|
||||||
54
.github/workflows/sdk_generation.yaml
vendored
Normal file
54
.github/workflows/sdk_generation.yaml
vendored
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
name: Generate and Publish to NPM and JSR
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
checks: write
|
||||||
|
contents: write
|
||||||
|
pull-requests: write
|
||||||
|
statuses: write
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
force:
|
||||||
|
description: Force generation of SDKs
|
||||||
|
type: boolean
|
||||||
|
default: false
|
||||||
|
set_version:
|
||||||
|
description: optionally set a specific SDK version
|
||||||
|
type: string
|
||||||
|
schedule:
|
||||||
|
- cron: 0 0 * * *
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
generate:
|
||||||
|
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
||||||
|
with:
|
||||||
|
force: ${{ github.event.inputs.force }}
|
||||||
|
mode: direct
|
||||||
|
set_version: ${{ github.event.inputs.set_version }}
|
||||||
|
speakeasy_version: latest
|
||||||
|
secrets:
|
||||||
|
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
npm_token: ${{ secrets.NPM_TOKEN }}
|
||||||
|
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||||
|
|
||||||
|
publish:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
needs: generate
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
id-token: write
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Set up Node.js
|
||||||
|
uses: actions/setup-node@v5
|
||||||
|
with:
|
||||||
|
node-version: 20
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm install
|
||||||
|
|
||||||
|
- name: Publish package
|
||||||
|
run: npx jsr publish
|
||||||
31
.github/workflows/speakeasy_sdk_generation.yml
vendored
31
.github/workflows/speakeasy_sdk_generation.yml
vendored
@@ -1,31 +0,0 @@
|
|||||||
name: Generate
|
|
||||||
permissions:
|
|
||||||
checks: write
|
|
||||||
contents: write
|
|
||||||
pull-requests: write
|
|
||||||
statuses: write
|
|
||||||
"on":
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
force:
|
|
||||||
description: Force generation of SDKs
|
|
||||||
type: boolean
|
|
||||||
default: false
|
|
||||||
push_code_samples_only:
|
|
||||||
description: Force push only code samples from SDK generation
|
|
||||||
type: boolean
|
|
||||||
default: false
|
|
||||||
schedule:
|
|
||||||
- cron: 0 0 * * *
|
|
||||||
jobs:
|
|
||||||
generate:
|
|
||||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
|
||||||
with:
|
|
||||||
force: ${{ github.event.inputs.force }}
|
|
||||||
mode: direct
|
|
||||||
push_code_samples_only: ${{ fromJSON(github.event.inputs.push_code_samples_only) }}
|
|
||||||
speakeasy_version: latest
|
|
||||||
secrets:
|
|
||||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
npm_token: ${{ secrets.NPM_TOKEN }}
|
|
||||||
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
|
||||||
20
.github/workflows/tagging.yaml
vendored
20
.github/workflows/tagging.yaml
vendored
@@ -1,20 +0,0 @@
|
|||||||
name: Speakeasy Tagging
|
|
||||||
permissions:
|
|
||||||
checks: write
|
|
||||||
contents: write
|
|
||||||
pull-requests: write
|
|
||||||
statuses: write
|
|
||||||
"on":
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
paths: []
|
|
||||||
workflow_dispatch: {}
|
|
||||||
jobs:
|
|
||||||
tag:
|
|
||||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/tag.yaml@v15
|
|
||||||
with:
|
|
||||||
registry_tags: main
|
|
||||||
secrets:
|
|
||||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
|
||||||
22
.gitignore
vendored
22
.gitignore
vendored
@@ -1,3 +1,25 @@
|
|||||||
|
/examples/node_modules
|
||||||
|
.env
|
||||||
|
.env.local
|
||||||
|
.env.*.local
|
||||||
|
.DS_Store
|
||||||
|
**/.speakeasy/temp/
|
||||||
|
**/.speakeasy/logs/
|
||||||
|
.DS_Store
|
||||||
|
/mcp-server
|
||||||
|
/bin
|
||||||
|
/.eslintcache
|
||||||
|
/.speakeasy/reports
|
||||||
|
/react-query
|
||||||
|
/sdk/models/errors
|
||||||
|
/sdk/types
|
||||||
|
/__tests__
|
||||||
|
/funcs
|
||||||
|
/core.*
|
||||||
|
/esm
|
||||||
|
/dist
|
||||||
|
/.tshy
|
||||||
|
/.tshy-*
|
||||||
/hooks
|
/hooks
|
||||||
/models
|
/models
|
||||||
/models/errors
|
/models/errors
|
||||||
|
|||||||
10
.npmignore
10
.npmignore
@@ -1,7 +1,15 @@
|
|||||||
**/*
|
**/*
|
||||||
|
!/FUNCTIONS.md
|
||||||
|
!/RUNTIMES.md
|
||||||
|
!/REACT_QUERY.md
|
||||||
!/**/*.ts
|
!/**/*.ts
|
||||||
!/**/*.js
|
!/**/*.js
|
||||||
|
!/**/*.mjs
|
||||||
|
!/**/*.json
|
||||||
!/**/*.map
|
!/**/*.map
|
||||||
|
|
||||||
/.eslintrc.js
|
/eslint.config.mjs
|
||||||
/cjs
|
/cjs
|
||||||
|
/.tshy
|
||||||
|
/.tshy-*
|
||||||
|
/__tests__
|
||||||
|
|||||||
8091
.speakeasy/gen.lock
8091
.speakeasy/gen.lock
File diff suppressed because one or more lines are too long
@@ -4,37 +4,61 @@ generation:
|
|||||||
maintainOpenAPIOrder: true
|
maintainOpenAPIOrder: true
|
||||||
usageSnippets:
|
usageSnippets:
|
||||||
optionalPropertyRendering: withExample
|
optionalPropertyRendering: withExample
|
||||||
|
sdkInitStyle: constructor
|
||||||
useClassNamesForArrayFields: true
|
useClassNamesForArrayFields: true
|
||||||
fixes:
|
fixes:
|
||||||
nameResolutionDec2023: true
|
nameResolutionDec2023: true
|
||||||
|
nameResolutionFeb2025: true
|
||||||
parameterOrderingFeb2024: true
|
parameterOrderingFeb2024: true
|
||||||
requestResponseComponentNamesFeb2024: true
|
requestResponseComponentNamesFeb2024: true
|
||||||
|
securityFeb2025: true
|
||||||
|
sharedErrorComponentsApr2025: true
|
||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
|
oAuth2PasswordEnabled: false
|
||||||
|
hoistGlobalSecurity: true
|
||||||
|
tests:
|
||||||
|
generateTests: true
|
||||||
|
generateNewTests: true
|
||||||
|
skipResponseBodyAssertions: false
|
||||||
typescript:
|
typescript:
|
||||||
version: 0.18.1
|
version: 0.42.1
|
||||||
|
acceptHeaderEnum: true
|
||||||
additionalDependencies:
|
additionalDependencies:
|
||||||
dependencies: {}
|
dependencies: {}
|
||||||
devDependencies: {}
|
devDependencies: {}
|
||||||
peerDependencies: {}
|
peerDependencies: {}
|
||||||
additionalPackageJSON: {}
|
additionalPackageJSON: {}
|
||||||
author: LukeHagar
|
author: LukeHagar
|
||||||
|
baseErrorName: PlexAPIError
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
|
constFieldsAlwaysOptional: true
|
||||||
|
defaultErrorName: SDKError
|
||||||
|
enableCustomCodeRegions: false
|
||||||
|
enableMCPServer: true
|
||||||
|
enableReactQuery: false
|
||||||
enumFormat: enum
|
enumFormat: enum
|
||||||
flattenGlobalSecurity: true
|
flattenGlobalSecurity: true
|
||||||
|
flatteningOrder: body-first
|
||||||
|
generateExamples: true
|
||||||
imports:
|
imports:
|
||||||
option: openapi
|
option: openapi
|
||||||
paths:
|
paths:
|
||||||
callbacks: ""
|
callbacks: sdk/models/callbacks
|
||||||
errors: ""
|
errors: sdk/models/errors
|
||||||
operations: ""
|
operations: sdk/models/operations
|
||||||
shared: ""
|
shared: sdk/models/shared
|
||||||
webhooks: ""
|
webhooks: sdk/models/webhooks
|
||||||
inputModelSuffix: input
|
inputModelSuffix: input
|
||||||
|
jsonpath: legacy
|
||||||
maxMethodParams: 4
|
maxMethodParams: 4
|
||||||
methodArguments: require-security-and-request
|
methodArguments: require-security-and-request
|
||||||
|
modelPropertyCasing: camel
|
||||||
|
moduleFormat: commonjs
|
||||||
outputModelSuffix: output
|
outputModelSuffix: output
|
||||||
packageName: '@lukehagar/plexjs'
|
packageName: '@lukehagar/plexjs'
|
||||||
responseFormat: envelope
|
responseFormat: envelope
|
||||||
|
sseFlatResponse: false
|
||||||
templateVersion: v2
|
templateVersion: v2
|
||||||
|
usageSDKInitImports: []
|
||||||
useIndexModules: true
|
useIndexModules: true
|
||||||
|
|||||||
17629
.speakeasy/tests.arazzo.yaml
Normal file
17629
.speakeasy/tests.arazzo.yaml
Normal file
File diff suppressed because it is too large
Load Diff
@@ -1,38 +1,47 @@
|
|||||||
speakeasyVersion: 1.323.0
|
speakeasyVersion: 1.636.3
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
sourceRevisionDigest: sha256:0e26af4bb9b5be12ffae3b400ee850d3b01e316f5b63346bc24f5173f8f17609
|
sourceRevisionDigest: sha256:1b8840d540c66b58d1009ec2581fb18464158ec9aa00464eac05ba737f31207e
|
||||||
sourceBlobDigest: sha256:879ee990da6c37e0b2972ef14220e0ce5db709dc39390ef8c2c24d3f4bba8b13
|
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- main
|
- main
|
||||||
|
plexapi:
|
||||||
|
sourceNamespace: plexapi
|
||||||
|
sourceRevisionDigest: sha256:0e9f7ca03e6a970d7b77654ab41d0a1605f0105871db2630a7afc85d4362b624
|
||||||
|
sourceBlobDigest: sha256:c0a6079f21e9d8cf8b3a205d2da333b78b2cb7e0db9dd895a41c68c2580e2d64
|
||||||
|
tags:
|
||||||
|
- latest
|
||||||
|
- speakeasy-sdk-regen-1760253962
|
||||||
|
- 1.1.1
|
||||||
targets:
|
targets:
|
||||||
plexjs:
|
plexjs:
|
||||||
source: my-source
|
source: plexapi
|
||||||
sourceNamespace: my-source
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:0e26af4bb9b5be12ffae3b400ee850d3b01e316f5b63346bc24f5173f8f17609
|
sourceRevisionDigest: sha256:0e9f7ca03e6a970d7b77654ab41d0a1605f0105871db2630a7afc85d4362b624
|
||||||
sourceBlobDigest: sha256:879ee990da6c37e0b2972ef14220e0ce5db709dc39390ef8c2c24d3f4bba8b13
|
sourceBlobDigest: sha256:c0a6079f21e9d8cf8b3a205d2da333b78b2cb7e0db9dd895a41c68c2580e2d64
|
||||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||||
codeSamplesRevisionDigest: sha256:a9631d3ae79a06641a20d5334a699ffa86a70ae2e64f326d280e285e21258893
|
codeSamplesRevisionDigest: sha256:535bcf840dfe9a3ffe1ad738ce6cccb59da883cd2465bf03ee2abbf0bc163e68
|
||||||
outLocation: /github/workspace/repo
|
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
plexapi:
|
||||||
inputs:
|
inputs:
|
||||||
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml
|
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/plex-api-spec.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/my-source
|
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
|
||||||
targets:
|
targets:
|
||||||
plexjs:
|
plexjs:
|
||||||
target: typescript
|
target: typescript
|
||||||
source: my-source
|
source: plexapi
|
||||||
publish:
|
publish:
|
||||||
npm:
|
npm:
|
||||||
token: $NPM_TOKEN
|
token: $npm_token
|
||||||
codeSamples:
|
codeSamples:
|
||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-typescript-plexjs
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||||
|
labelOverride:
|
||||||
|
fixedValue: PlexJS
|
||||||
|
|||||||
@@ -1,19 +1,21 @@
|
|||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
plexapi:
|
||||||
inputs:
|
inputs:
|
||||||
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml
|
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/plex-api-spec.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/my-source
|
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
|
||||||
targets:
|
targets:
|
||||||
plexjs:
|
plexjs:
|
||||||
target: typescript
|
target: typescript
|
||||||
source: my-source
|
source: plexapi
|
||||||
publish:
|
publish:
|
||||||
npm:
|
npm:
|
||||||
token: $NPM_TOKEN
|
token: $npm_token
|
||||||
codeSamples:
|
codeSamples:
|
||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-typescript-plexjs
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||||
|
labelOverride:
|
||||||
|
fixedValue: PlexJS
|
||||||
|
|||||||
26
CONTRIBUTING.md
Normal file
26
CONTRIBUTING.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# Contributing to This Repository
|
||||||
|
|
||||||
|
Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
|
||||||
|
|
||||||
|
## How to Report Issues
|
||||||
|
|
||||||
|
If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
|
||||||
|
|
||||||
|
- A clear and descriptive title
|
||||||
|
- Steps to reproduce the issue
|
||||||
|
- Expected and actual behavior
|
||||||
|
- Any relevant logs, screenshots, or error messages
|
||||||
|
- Information about your environment (e.g., operating system, software versions)
|
||||||
|
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
|
||||||
|
|
||||||
|
## Issue Triage and Upstream Fixes
|
||||||
|
|
||||||
|
We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
|
||||||
|
|
||||||
|
## Contact
|
||||||
|
|
||||||
|
If you have any questions or need further assistance, please feel free to reach out by opening an issue.
|
||||||
|
|
||||||
|
Thank you for your understanding and cooperation!
|
||||||
|
|
||||||
|
The Maintainers
|
||||||
129
FUNCTIONS.md
Normal file
129
FUNCTIONS.md
Normal file
@@ -0,0 +1,129 @@
|
|||||||
|
# Standalone Functions
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> This section is useful if you are using a bundler and targetting browsers and
|
||||||
|
> runtimes where the size of an application affects performance and load times.
|
||||||
|
|
||||||
|
Every method in this SDK is also available as a standalone function. This
|
||||||
|
alternative API is suitable when targetting the browser or serverless runtimes
|
||||||
|
and using a bundler to build your application since all unused functionality
|
||||||
|
will be tree-shaken away. This includes code for unused methods, Zod schemas,
|
||||||
|
encoding helpers and response handlers. The result is dramatically smaller
|
||||||
|
impact on the application's final bundle size which grows very slowly as you use
|
||||||
|
more and more functionality from this SDK.
|
||||||
|
|
||||||
|
Calling methods through the main SDK class remains a valid and generally more
|
||||||
|
more ergonomic option. Standalone functions represent an optimisation for a
|
||||||
|
specific category of applications.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
|
||||||
|
import { transcoderStartTranscodeSession } from "@lukehagar/plexjs/funcs/transcoderStartTranscodeSession.js";
|
||||||
|
import { Extension, StartTranscodeSessionLocation, StartTranscodeSessionProtocol } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
import { Accepts, AdvancedSubtitles, BoolInt, TranscodeType } from "@lukehagar/plexjs/sdk/models/shared";
|
||||||
|
|
||||||
|
// Use `PlexAPICore` for best tree-shaking performance.
|
||||||
|
// You can create one instance of it to use across an application.
|
||||||
|
const plexAPI = new PlexAPICore({
|
||||||
|
accepts: Accepts.ApplicationXml,
|
||||||
|
clientIdentifier: "abc123",
|
||||||
|
product: "Plex for Roku",
|
||||||
|
version: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
platformVersion: "4.3 build 1057",
|
||||||
|
device: "Roku 3",
|
||||||
|
model: "4200X",
|
||||||
|
deviceVendor: "Roku",
|
||||||
|
deviceName: "Living Room TV",
|
||||||
|
marketplace: "googlePlay",
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const res = await transcoderStartTranscodeSession(plexAPI, {
|
||||||
|
transcodeType: TranscodeType.Music,
|
||||||
|
extension: Extension.Mpd,
|
||||||
|
advancedSubtitles: AdvancedSubtitles.Burn,
|
||||||
|
audioBoost: 50,
|
||||||
|
audioChannelCount: 5,
|
||||||
|
autoAdjustQuality: BoolInt.One,
|
||||||
|
autoAdjustSubtitle: BoolInt.One,
|
||||||
|
directPlay: BoolInt.One,
|
||||||
|
directStream: BoolInt.One,
|
||||||
|
directStreamAudio: BoolInt.One,
|
||||||
|
disableResolutionRotation: BoolInt.One,
|
||||||
|
hasMDE: BoolInt.One,
|
||||||
|
location: StartTranscodeSessionLocation.Wan,
|
||||||
|
mediaBufferSize: 102400,
|
||||||
|
mediaIndex: 0,
|
||||||
|
musicBitrate: 5000,
|
||||||
|
offset: 90.5,
|
||||||
|
partIndex: 0,
|
||||||
|
path: "/library/metadata/151671",
|
||||||
|
peakBitrate: 12000,
|
||||||
|
photoResolution: "1080x1080",
|
||||||
|
protocol: StartTranscodeSessionProtocol.Dash,
|
||||||
|
secondsPerSegment: 5,
|
||||||
|
subtitleSize: 50,
|
||||||
|
videoBitrate: 12000,
|
||||||
|
videoQuality: 50,
|
||||||
|
videoResolution: "1080x1080",
|
||||||
|
xPlexClientProfileExtra: "add-limitation(scope=videoCodec&scopeName=*&type=upperBound&name=video.frameRate&value=60&replace=true)+append-transcode-target-codec(type=videoProfile&context=streaming&videoCodec=h264%2Chevc&audioCodec=aac&protocol=dash)",
|
||||||
|
xPlexClientProfileName: "generic",
|
||||||
|
});
|
||||||
|
if (res.ok) {
|
||||||
|
const { value: result } = res;
|
||||||
|
console.log(result);
|
||||||
|
} else {
|
||||||
|
console.log("transcoderStartTranscodeSession failed:", res.error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
```
|
||||||
|
|
||||||
|
## Result types
|
||||||
|
|
||||||
|
Standalone functions differ from SDK methods in that they return a
|
||||||
|
`Result<Value, Error>` type to capture _known errors_ and document them using
|
||||||
|
the type system. By avoiding throwing errors, application code maintains clear
|
||||||
|
control flow and error-handling become part of the regular flow of application
|
||||||
|
code.
|
||||||
|
|
||||||
|
> We use the term "known errors" because standalone functions, and JavaScript
|
||||||
|
> code in general, can still throw unexpected errors such as `TypeError`s,
|
||||||
|
> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
|
||||||
|
> something this SDK addresses in the future. Nevertheless, there is still a lot
|
||||||
|
> of benefit from capturing most errors and turning them into values.
|
||||||
|
|
||||||
|
The second reason for this style of programming is because these functions will
|
||||||
|
typically be used in front-end applications where exception throwing is
|
||||||
|
sometimes discouraged or considered unidiomatic. React and similar ecosystems
|
||||||
|
and libraries tend to promote this style of programming so that components
|
||||||
|
render useful content under all states (loading, success, error and so on).
|
||||||
|
|
||||||
|
The general pattern when calling standalone functions looks like this:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Core } from "<sdk-package-name>";
|
||||||
|
import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
|
||||||
|
|
||||||
|
const client = new Core();
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await fetchSomething(client, { id: "123" });
|
||||||
|
if (!result.ok) {
|
||||||
|
// You can throw the error or handle it. It's your choice now.
|
||||||
|
throw result.error;
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(result.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
```
|
||||||
|
|
||||||
|
Notably, `result.error` above will have an explicit type compared to a try-catch
|
||||||
|
variation where the error in the catch block can only be of type `unknown` (or
|
||||||
|
`any` depending on your TypeScript settings).
|
||||||
510
RELEASES.md
510
RELEASES.md
@@ -919,3 +919,513 @@ Based on:
|
|||||||
- [typescript v0.18.1] .
|
- [typescript v0.18.1] .
|
||||||
### Releases
|
### Releases
|
||||||
- [NPM v0.18.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.18.1 - .
|
- [NPM v0.18.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.18.1 - .
|
||||||
|
|
||||||
|
## 2024-07-01 16:23:41
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.323.0 (2.356.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.18.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.18.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.18.2 - .
|
||||||
|
|
||||||
|
## 2024-08-22 05:15:43
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.377.1 (2.404.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.19.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.19.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.19.0 - .
|
||||||
|
|
||||||
|
## 2024-09-06 00:01:07
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.390.7 (2.409.8) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.20.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.20.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.20.0 - .
|
||||||
|
|
||||||
|
## 2024-09-08 03:21:12
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.392.1 (2.411.9) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.20.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.20.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.20.2 - .
|
||||||
|
|
||||||
|
## 2024-09-08 17:37:50
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.392.1 (2.411.9) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.21.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.21.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.21.0 - .
|
||||||
|
|
||||||
|
## 2024-09-09 00:09:42
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.392.1 (2.411.9) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.21.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.21.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.21.1 - .
|
||||||
|
|
||||||
|
## 2024-09-10 00:09:01
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.394.0 (2.413.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.22.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.22.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.22.0 - .
|
||||||
|
|
||||||
|
## 2024-09-11 00:09:01
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.395.1 (2.415.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.22.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.22.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.22.1 - .
|
||||||
|
|
||||||
|
## 2024-09-12 00:09:10
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.396.2 (2.415.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.22.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.22.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.22.2 - .
|
||||||
|
|
||||||
|
## 2024-09-13 00:09:09
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.396.6 (2.415.6) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.23.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.23.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.0 - .
|
||||||
|
|
||||||
|
## 2024-09-14 00:08:56
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.396.9 (2.415.7) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.23.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.23.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.1 - .
|
||||||
|
|
||||||
|
## 2024-09-15 00:10:25
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.396.9 (2.415.7) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.23.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.23.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.2 - .
|
||||||
|
|
||||||
|
## 2024-09-16 00:09:42
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.396.9 (2.415.7) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.23.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.23.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.3 - .
|
||||||
|
|
||||||
|
## 2024-09-16 17:59:12
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.397.2 (2.415.8) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.23.4] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.23.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.4 - .
|
||||||
|
|
||||||
|
## 2024-09-17 00:08:25
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.398.0 (2.415.8) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.23.5] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.23.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.5 - .
|
||||||
|
|
||||||
|
## 2024-10-01 00:10:47
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.24.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.24.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.0 - .
|
||||||
|
|
||||||
|
## 2024-10-01 15:35:33
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.24.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.24.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.1 - .
|
||||||
|
|
||||||
|
## 2024-10-02 02:28:25
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.24.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.24.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.2 - .
|
||||||
|
|
||||||
|
## 2024-10-03 00:09:30
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.25.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.25.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.25.1 - .
|
||||||
|
|
||||||
|
## 2024-10-03 12:26:50
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.26.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.26.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.26.1 - .
|
||||||
|
|
||||||
|
## 2024-11-11 20:28:21
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.28.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.28.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.28.0 - .
|
||||||
|
|
||||||
|
## 2024-11-14 00:09:39
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.30.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.30.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.30.0 - .
|
||||||
|
|
||||||
|
## 2024-12-16 22:17:52
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.31.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.31.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.31.1 - .
|
||||||
|
|
||||||
|
## 2024-12-20 16:01:16
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.456.1 (2.481.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.32.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.32.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.0 - .
|
||||||
|
|
||||||
|
## 2024-12-22 00:10:48
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.459.2 (2.483.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.32.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.32.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.1 - .
|
||||||
|
|
||||||
|
## 2025-01-24 00:09:35
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.474.0 (2.495.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.32.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.32.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.2 - .
|
||||||
|
|
||||||
|
## 2025-01-27 00:09:48
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.476.1 (2.495.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.32.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.32.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.3 - .
|
||||||
|
|
||||||
|
## 2025-02-05 00:09:58
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.32.4] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.32.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.4 - .
|
||||||
|
|
||||||
|
## 2025-02-06 00:09:46
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.32.5] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.32.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.5 - .
|
||||||
|
|
||||||
|
## 2025-02-07 00:09:41
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.487.0 (2.506.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.33.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.33.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.33.0 - .
|
||||||
|
|
||||||
|
## 2025-02-10 00:10:04
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.487.1 (2.506.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.34.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.34.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.34.0 - .
|
||||||
|
|
||||||
|
## 2025-03-07 00:09:55
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.513.2 (2.545.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.35.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.35.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.0 - .
|
||||||
|
|
||||||
|
## 2025-03-09 00:09:12
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.513.4 (2.545.4) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.35.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.35.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.1 - .
|
||||||
|
|
||||||
|
## 2025-03-31 16:31:46
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.35.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.35.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.2 - .
|
||||||
|
|
||||||
|
## 2025-03-31 19:33:46
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.35.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.35.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.3 - .
|
||||||
|
|
||||||
|
## 2025-03-31 19:42:25
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.35.4] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.35.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.4 - .
|
||||||
|
|
||||||
|
## 2025-04-03 00:10:29
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.528.1 (2.565.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.36.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.36.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.36.0 - .
|
||||||
|
|
||||||
|
## 2025-04-06 00:11:19
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.529.1 (2.566.5) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.36.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.36.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.36.1 - .
|
||||||
|
|
||||||
|
## 2025-04-14 00:11:23
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.531.4 (2.570.4) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.36.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.36.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.36.2 - .
|
||||||
|
|
||||||
|
## 2025-04-19 00:10:19
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.535.1 (2.585.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.37.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.37.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.37.0 - .
|
||||||
|
|
||||||
|
## 2025-05-01 00:12:16
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.541.2 (2.595.4) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.37.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.37.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.37.1 - .
|
||||||
|
|
||||||
|
## 2025-05-05 00:11:37
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.542.1 (2.597.9) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.37.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.37.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.37.2 - .
|
||||||
|
|
||||||
|
## 2025-06-04 00:11:21
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.555.2 (2.620.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.38.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.38.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.38.0 - .
|
||||||
|
|
||||||
|
## 2025-06-09 00:12:06
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.557.0 (2.623.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.39.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.39.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.39.0 - .
|
||||||
|
|
||||||
|
## 2025-07-10 00:11:39
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.580.1 (2.656.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.40.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.40.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.40.0 - .
|
||||||
|
|
||||||
|
## 2025-08-06 00:12:14
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.598.0 (2.674.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.40.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.40.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.40.1 - .
|
||||||
|
|
||||||
|
## 2025-08-07 00:12:28
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.598.3 (2.674.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.40.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.40.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.40.2 - .
|
||||||
|
|
||||||
|
## 2025-09-15 00:11:38
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.615.2 (2.698.4) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.40.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.40.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.40.3 - .
|
||||||
|
|
||||||
|
## 2025-10-12 05:24:41
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.636.3 (2.723.11) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.41.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.41.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.41.0 - .
|
||||||
|
|
||||||
|
## 2025-10-12 05:51:28
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.636.3 (2.723.11) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.42.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.42.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.42.0 - .
|
||||||
|
|
||||||
|
## 2025-10-12 07:25:38
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.636.3 (2.723.11) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.42.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.42.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.42.1 - .
|
||||||
34
RUNTIMES.md
34
RUNTIMES.md
@@ -1,10 +1,10 @@
|
|||||||
# Supported JavaScript runtimes
|
# Supported JavaScript runtimes
|
||||||
|
|
||||||
This SDK is intended to be used in JavaScript runtimes that support the following features:
|
This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
|
||||||
|
|
||||||
* [Web Fetch API][web-fetch]
|
- [Web Fetch API][web-fetch]
|
||||||
* [Web Streams API](web-streams) and in particular `ReadableStream`
|
- [Web Streams API][web-streams] and in particular `ReadableStream`
|
||||||
* [Async iterables][async-iter] using `Symbol.asyncIterator`
|
- [Async iterables][async-iter] using `Symbol.asyncIterator`
|
||||||
|
|
||||||
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
|
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
|
||||||
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
|
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
|
||||||
@@ -20,3 +20,29 @@ Runtime environments that are explicitly supported are:
|
|||||||
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
|
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
|
||||||
|
|
||||||
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
|
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
|
||||||
|
|
||||||
|
## Recommended TypeScript compiler options
|
||||||
|
|
||||||
|
The following `tsconfig.json` options are recommended for projects using this
|
||||||
|
SDK in order to get static type support for features like async iterables,
|
||||||
|
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
|
||||||
|
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
|
||||||
|
so on):
|
||||||
|
|
||||||
|
[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
|
||||||
|
[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
|
||||||
|
[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
|
||||||
|
[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"target": "es2020", // or higher
|
||||||
|
"lib": ["es2020", "dom", "dom.iterable"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
While `target` can be set to older ECMAScript versions, it may result in extra,
|
||||||
|
unnecessary compatibility code being generated if you are not targeting old
|
||||||
|
runtimes.
|
||||||
|
|||||||
58
USAGE.md
58
USAGE.md
@@ -1,16 +1,66 @@
|
|||||||
<!-- Start SDK Example Usage [usage] -->
|
<!-- Start SDK Example Usage [usage] -->
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
import {
|
||||||
|
Extension,
|
||||||
|
StartTranscodeSessionLocation,
|
||||||
|
StartTranscodeSessionProtocol,
|
||||||
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
import {
|
||||||
|
Accepts,
|
||||||
|
AdvancedSubtitles,
|
||||||
|
BoolInt,
|
||||||
|
TranscodeType,
|
||||||
|
} from "@lukehagar/plexjs/sdk/models/shared";
|
||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accepts: Accepts.ApplicationXml,
|
||||||
xPlexClientIdentifier: "Postman",
|
clientIdentifier: "abc123",
|
||||||
|
product: "Plex for Roku",
|
||||||
|
version: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
platformVersion: "4.3 build 1057",
|
||||||
|
device: "Roku 3",
|
||||||
|
model: "4200X",
|
||||||
|
deviceVendor: "Roku",
|
||||||
|
deviceName: "Living Room TV",
|
||||||
|
marketplace: "googlePlay",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.server.getServerCapabilities();
|
const result = await plexAPI.transcoder.startTranscodeSession({
|
||||||
|
transcodeType: TranscodeType.Music,
|
||||||
|
extension: Extension.Mpd,
|
||||||
|
advancedSubtitles: AdvancedSubtitles.Burn,
|
||||||
|
audioBoost: 50,
|
||||||
|
audioChannelCount: 5,
|
||||||
|
autoAdjustQuality: BoolInt.One,
|
||||||
|
autoAdjustSubtitle: BoolInt.One,
|
||||||
|
directPlay: BoolInt.One,
|
||||||
|
directStream: BoolInt.One,
|
||||||
|
directStreamAudio: BoolInt.One,
|
||||||
|
disableResolutionRotation: BoolInt.One,
|
||||||
|
hasMDE: BoolInt.One,
|
||||||
|
location: StartTranscodeSessionLocation.Wan,
|
||||||
|
mediaBufferSize: 102400,
|
||||||
|
mediaIndex: 0,
|
||||||
|
musicBitrate: 5000,
|
||||||
|
offset: 90.5,
|
||||||
|
partIndex: 0,
|
||||||
|
path: "/library/metadata/151671",
|
||||||
|
peakBitrate: 12000,
|
||||||
|
photoResolution: "1080x1080",
|
||||||
|
protocol: StartTranscodeSessionProtocol.Dash,
|
||||||
|
secondsPerSegment: 5,
|
||||||
|
subtitleSize: 50,
|
||||||
|
videoBitrate: 12000,
|
||||||
|
videoQuality: 50,
|
||||||
|
videoResolution: "1080x1080",
|
||||||
|
xPlexClientProfileExtra:
|
||||||
|
"add-limitation(scope=videoCodec&scopeName=*&type=upperBound&name=video.frameRate&value=60&replace=true)+append-transcode-target-codec(type=videoProfile&context=streaming&videoCodec=h264%2Chevc&audioCodec=aac&protocol=dash)",
|
||||||
|
xPlexClientProfileName: "generic",
|
||||||
|
});
|
||||||
|
|
||||||
// Handle the result
|
|
||||||
console.log(result);
|
console.log(result);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
8659
codeSamples.yaml
8659
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
24
docs/lib/utils/retryconfig.md
Normal file
24
docs/lib/utils/retryconfig.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# RetryConfig
|
||||||
|
|
||||||
|
Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies.
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Name | Type | Description | Example |
|
||||||
|
| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
|
||||||
|
| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` |
|
||||||
|
| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | |
|
||||||
|
| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` |
|
||||||
|
|
||||||
|
## BackoffStrategy
|
||||||
|
|
||||||
|
The backoff strategy allows retrying a request with an exponential backoff between each retry.
|
||||||
|
|
||||||
|
### Fields
|
||||||
|
|
||||||
|
| Name | Type | Description | Example |
|
||||||
|
| ------------------ | ------------ | ----------------------------------------- | -------- |
|
||||||
|
| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` |
|
||||||
|
| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` |
|
||||||
|
| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` |
|
||||||
|
| `maxElapsedTime` | `*number*` | The maximum elapsed time in milliseconds. | `300000` |
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# Account
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
|
||||||
| `id` | *number* | :heavy_minus_sign: | N/A | 238960586 |
|
|
||||||
| `key` | *string* | :heavy_minus_sign: | N/A | /accounts/238960586 |
|
|
||||||
| `name` | *string* | :heavy_minus_sign: | N/A | Diane |
|
|
||||||
| `defaultAudioLanguage` | *string* | :heavy_minus_sign: | N/A | en |
|
|
||||||
| `autoSelectAudio` | *boolean* | :heavy_minus_sign: | N/A | true |
|
|
||||||
| `defaultSubtitleLanguage` | *string* | :heavy_minus_sign: | N/A | en |
|
|
||||||
| `subtitleMode` | *number* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | https://plex.tv/users/50d83634246da1de/avatar?c=1707110967 |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# Activity
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
||||||
| `uuid` | *string* | :heavy_minus_sign: | N/A |
|
|
||||||
| `type` | *string* | :heavy_minus_sign: | N/A |
|
|
||||||
| `cancellable` | *boolean* | :heavy_minus_sign: | N/A |
|
|
||||||
| `userID` | *number* | :heavy_minus_sign: | N/A |
|
|
||||||
| `title` | *string* | :heavy_minus_sign: | N/A |
|
|
||||||
| `subtitle` | *string* | :heavy_minus_sign: | N/A |
|
|
||||||
| `progress` | *number* | :heavy_minus_sign: | N/A |
|
|
||||||
| `context` | [models.Context](../models/context.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# AddPlaylistContentsErrors
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# AddPlaylistContentsMediaContainer
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
|
||||||
| `size` | *number* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `leafCountAdded` | *number* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `leafCountRequested` | *number* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `metadata` | [models.AddPlaylistContentsMetadata](../models/addplaylistcontentsmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
# AddPlaylistContentsMetadata
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
|
||||||
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 94 |
|
|
||||||
| `key` | *string* | :heavy_minus_sign: | N/A | /playlists/94/items |
|
|
||||||
| `guid` | *string* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2 |
|
|
||||||
| `type` | *string* | :heavy_minus_sign: | N/A | playlist |
|
|
||||||
| `title` | *string* | :heavy_minus_sign: | N/A | A great playlist |
|
|
||||||
| `summary` | *string* | :heavy_minus_sign: | N/A | One of my great playlists |
|
|
||||||
| `smart` | *boolean* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `playlistType` | *string* | :heavy_minus_sign: | N/A | video |
|
|
||||||
| `composite` | *string* | :heavy_minus_sign: | N/A | /playlists/94/composite/1705800070 |
|
|
||||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 423000 |
|
|
||||||
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 3 |
|
|
||||||
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1705716458 |
|
|
||||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705800070 |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# AddPlaylistContentsPlaylistsResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [models.AddPlaylistContentsErrors](../models/addplaylistcontentserrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# AddPlaylistContentsRequest
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
|
||||||
| `playlistID` | *number* | :heavy_check_mark: | the ID of the playlist | |
|
|
||||||
| `uri` | *string* | :heavy_check_mark: | the content URI for the playlist | server://12345/com.plexapp.plugins.library/library/metadata/1 |
|
|
||||||
| `playQueueID` | *number* | :heavy_minus_sign: | the play queue to add to a playlist | 123 |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# AddPlaylistContentsResponse
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
||||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
|
||||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
| `object` | [models.AddPlaylistContentsResponseBody](../models/addplaylistcontentsresponsebody.md) | :heavy_minus_sign: | Playlist Updated |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# AddPlaylistContentsResponseBody
|
|
||||||
|
|
||||||
Playlist Updated
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
|
||||||
| `mediaContainer` | [models.AddPlaylistContentsMediaContainer](../models/addplaylistcontentsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# ApplyUpdatesErrors
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ApplyUpdatesRequest
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `tonight` | [models.Tonight](../models/tonight.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install | 1 |
|
|
||||||
| `skip` | [models.Skip](../models/skip.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The <Release> entry for this version will have the `state` set to `skipped`. | 1 |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# ApplyUpdatesResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
||||||
| `errors` | [models.ApplyUpdatesErrors](../models/applyupdateserrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
# ButlerTask
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
|
||||||
| `name` | *string* | :heavy_minus_sign: | N/A | BackupDatabase |
|
|
||||||
| `interval` | *number* | :heavy_minus_sign: | N/A | 3 |
|
|
||||||
| `scheduleRandomized` | *boolean* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `enabled` | *boolean* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `title` | *string* | :heavy_minus_sign: | N/A | Backup Database |
|
|
||||||
| `description` | *string* | :heavy_minus_sign: | N/A | Create a backup copy of the server's database in the configured backup directory |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# ButlerTasks
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
|
||||||
| `butlerTask` | [models.ButlerTask](../models/butlertask.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# CancelServerActivitiesErrors
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# CancelServerActivitiesRequest
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
|
||||||
| `activityUUID` | *string* | :heavy_check_mark: | The UUID of the activity to cancel. | 25b71ed5-0f9d-461c-baa7-d404e9e10d3e |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# CancelServerActivitiesResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [models.CancelServerActivitiesErrors](../models/cancelserveractivitieserrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# CheckForUpdatesErrors
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# CheckForUpdatesRequest
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
|
||||||
| `download` | [models.Download](../models/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# CheckForUpdatesResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
||||||
| `errors` | [models.CheckForUpdatesErrors](../models/checkforupdateserrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# ClearPlaylistContentsErrors
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# ClearPlaylistContentsRequest
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
|
||||||
| `playlistID` | *number* | :heavy_check_mark: | the ID of the playlist |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# ClearPlaylistContentsResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [models.ClearPlaylistContentsErrors](../models/clearplaylistcontentserrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# Context
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `librarySectionID` | *string* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# Country
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
|
||||||
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# CreatePlaylistErrors
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# CreatePlaylistMediaContainer
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
||||||
| `size` | *number* | :heavy_minus_sign: | N/A | 7 |
|
|
||||||
| `metadata` | [models.CreatePlaylistMetadata](../models/createplaylistmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
# CreatePlaylistMetadata
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
|
||||||
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 96 |
|
|
||||||
| `key` | *string* | :heavy_minus_sign: | N/A | /playlists/96/items |
|
|
||||||
| `guid` | *string* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55 |
|
|
||||||
| `type` | *string* | :heavy_minus_sign: | N/A | playlist |
|
|
||||||
| `title` | *string* | :heavy_minus_sign: | N/A | A Great Playlist |
|
|
||||||
| `summary` | *string* | :heavy_minus_sign: | N/A | What a great playlist |
|
|
||||||
| `smart` | *boolean* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `playlistType` | *string* | :heavy_minus_sign: | N/A | video |
|
|
||||||
| `icon` | *string* | :heavy_minus_sign: | N/A | playlist://image.smart |
|
|
||||||
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1705719589 |
|
|
||||||
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1705719589 |
|
|
||||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705724593 |
|
|
||||||
| `composite` | *string* | :heavy_minus_sign: | N/A | /playlists/96/composite/1705724593 |
|
|
||||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 141000 |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# CreatePlaylistPlaylistsResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
||||||
| `errors` | [models.CreatePlaylistErrors](../models/createplaylisterrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# CreatePlaylistRequest
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
|
||||||
| `title` | *string* | :heavy_check_mark: | name of the playlist |
|
|
||||||
| `type` | [models.QueryParamType](../models/queryparamtype.md) | :heavy_check_mark: | type of playlist to create |
|
|
||||||
| `smart` | [models.Smart](../models/smart.md) | :heavy_check_mark: | whether the playlist is smart or not |
|
|
||||||
| `uri` | *string* | :heavy_check_mark: | the content URI for the playlist |
|
|
||||||
| `playQueueID` | *number* | :heavy_minus_sign: | the play queue to copy to a playlist |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# CreatePlaylistResponse
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
|
||||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
|
||||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
| `object` | [models.CreatePlaylistResponseBody](../models/createplaylistresponsebody.md) | :heavy_minus_sign: | returns all playlists |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# CreatePlaylistResponseBody
|
|
||||||
|
|
||||||
returns all playlists
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
|
||||||
| `mediaContainer` | [models.CreatePlaylistMediaContainer](../models/createplaylistmediacontainer.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# DeleteLibraryErrors
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# DeleteLibraryRequest
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
|
||||||
| `sectionId` | *number* | :heavy_check_mark: | the Id of the library to query | 1000 |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# DeleteLibraryResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
||||||
| `errors` | [models.DeleteLibraryErrors](../models/deletelibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# DeletePlaylistErrors
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# DeletePlaylistRequest
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
|
||||||
| `playlistID` | *number* | :heavy_check_mark: | the ID of the playlist |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# DeletePlaylistResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
||||||
| `errors` | [models.DeletePlaylistErrors](../models/deleteplaylisterrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# Device
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `id` | *number* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `name` | *string* | :heavy_minus_sign: | N/A | iPhone |
|
|
||||||
| `platform` | *string* | :heavy_minus_sign: | N/A | iOS |
|
|
||||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `createdAt` | *number* | :heavy_minus_sign: | N/A | 1654131230 |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# Director
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Peyton Reed |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# Download
|
|
||||||
|
|
||||||
Indicate that you want to start download any updates found.
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------ | ------ |
|
|
||||||
| `Zero` | 0 |
|
|
||||||
| `One` | 1 |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# EnablePaperTrailErrors
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# EnablePaperTrailResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
||||||
| `errors` | [models.EnablePaperTrailErrors](../models/enablepapertrailerrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# Errors
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# Field
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `key` | *string* | :heavy_minus_sign: | N/A | label |
|
|
||||||
| `title` | *string* | :heavy_minus_sign: | N/A | Label |
|
|
||||||
| `type` | *string* | :heavy_minus_sign: | N/A | tag |
|
|
||||||
| `subType` | *string* | :heavy_minus_sign: | N/A | bitrate |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# FieldType
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
|
|
||||||
| `type` | *string* | :heavy_minus_sign: | N/A | resolution |
|
|
||||||
| `operator` | [models.Operator](../models/operator.md)[] | :heavy_minus_sign: | N/A | |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# Filter
|
|
||||||
|
|
||||||
Filters content by field and direction/equality
|
|
||||||
(Unknown if viewedAt is the only supported column)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------- | ----------- | ----------- | ----------- |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# Force
|
|
||||||
|
|
||||||
Force overwriting of duplicate playlists.
|
|
||||||
By default, a playlist file uploaded with the same path will overwrite the existing playlist.
|
|
||||||
The `force` argument is used to disable overwriting.
|
|
||||||
If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------ | ------ |
|
|
||||||
| `Zero` | 0 |
|
|
||||||
| `One` | 1 |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# Genre
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Comedy |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetAvailableClientsErrors
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# GetAvailableClientsMediaContainer
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
|
||||||
| `size` | *number* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `server` | [models.GetAvailableClientsServer](../models/getavailableclientsserver.md)[] | :heavy_minus_sign: | N/A | |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetAvailableClientsResponse
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
||||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
|
||||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
| `object` | [models.GetAvailableClientsResponseBody](../models/getavailableclientsresponsebody.md) | :heavy_minus_sign: | Available Clients |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetAvailableClientsResponseBody
|
|
||||||
|
|
||||||
Available Clients
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
|
||||||
| `mediaContainer` | [models.GetAvailableClientsMediaContainer](../models/getavailableclientsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# GetAvailableClientsServer
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
|
||||||
| `name` | *string* | :heavy_minus_sign: | N/A | iPad |
|
|
||||||
| `host` | *string* | :heavy_minus_sign: | N/A | 10.10.10.102 |
|
|
||||||
| `address` | *string* | :heavy_minus_sign: | N/A | 10.10.10.102 |
|
|
||||||
| `port` | *number* | :heavy_minus_sign: | N/A | 32500 |
|
|
||||||
| `machineIdentifier` | *string* | :heavy_minus_sign: | N/A | A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05 |
|
|
||||||
| `version` | *string* | :heavy_minus_sign: | N/A | 8.17 |
|
|
||||||
| `protocol` | *string* | :heavy_minus_sign: | N/A | plex |
|
|
||||||
| `product` | *string* | :heavy_minus_sign: | N/A | Plex for iOS |
|
|
||||||
| `deviceClass` | *string* | :heavy_minus_sign: | N/A | tablet |
|
|
||||||
| `protocolVersion` | *number* | :heavy_minus_sign: | N/A | 2 |
|
|
||||||
| `protocolCapabilities` | *string* | :heavy_minus_sign: | N/A | playback,playqueues,timeline,provider-playback |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetAvailableClientsServerResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [models.GetAvailableClientsErrors](../models/getavailableclientserrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# GetBandwidthStatisticsAccount
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
|
||||||
| `id` | *number* | :heavy_minus_sign: | N/A | 238960586 |
|
|
||||||
| `key` | *string* | :heavy_minus_sign: | N/A | /accounts/238960586 |
|
|
||||||
| `name` | *string* | :heavy_minus_sign: | N/A | Diane |
|
|
||||||
| `defaultAudioLanguage` | *string* | :heavy_minus_sign: | N/A | en |
|
|
||||||
| `autoSelectAudio` | *boolean* | :heavy_minus_sign: | N/A | true |
|
|
||||||
| `defaultSubtitleLanguage` | *string* | :heavy_minus_sign: | N/A | en |
|
|
||||||
| `subtitleMode` | *number* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | https://plex.tv/users/50d83634246da1de/avatar?c=1707110967 |
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# GetBandwidthStatisticsDevice
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
|
||||||
| `id` | *number* | :heavy_minus_sign: | N/A | 208 |
|
|
||||||
| `name` | *string* | :heavy_minus_sign: | N/A | Roku Express |
|
|
||||||
| `platform` | *string* | :heavy_minus_sign: | N/A | Roku |
|
|
||||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | N/A | 793095d235660625108ef785cc7646e9 |
|
|
||||||
| `createdAt` | *number* | :heavy_minus_sign: | N/A | 1706470556 |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetBandwidthStatisticsErrors
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetBandwidthStatisticsMediaContainer
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
|
||||||
| `size` | *number* | :heavy_minus_sign: | N/A | 5497 |
|
|
||||||
| `device` | [models.GetBandwidthStatisticsDevice](../models/getbandwidthstatisticsdevice.md)[] | :heavy_minus_sign: | N/A | |
|
|
||||||
| `account` | [models.GetBandwidthStatisticsAccount](../models/getbandwidthstatisticsaccount.md)[] | :heavy_minus_sign: | N/A | |
|
|
||||||
| `statisticsBandwidth` | [models.StatisticsBandwidth](../models/statisticsbandwidth.md)[] | :heavy_minus_sign: | N/A | |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# GetBandwidthStatisticsRequest
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
|
||||||
| `timespan` | *number* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetBandwidthStatisticsResponse
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
|
||||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
|
||||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
| `object` | [models.GetBandwidthStatisticsResponseBody](../models/getbandwidthstatisticsresponsebody.md) | :heavy_minus_sign: | Bandwidth Statistics |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetBandwidthStatisticsResponseBody
|
|
||||||
|
|
||||||
Bandwidth Statistics
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
|
||||||
| `mediaContainer` | [models.GetBandwidthStatisticsMediaContainer](../models/getbandwidthstatisticsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetBandwidthStatisticsStatisticsResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [models.GetBandwidthStatisticsErrors](../models/getbandwidthstatisticserrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetButlerTasksButlerResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
||||||
| `errors` | [models.GetButlerTasksErrors](../models/getbutlertaskserrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetButlerTasksErrors
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetButlerTasksResponse
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
|
||||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
|
||||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
| `object` | [models.GetButlerTasksResponseBody](../models/getbutlertasksresponsebody.md) | :heavy_minus_sign: | All butler tasks |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetButlerTasksResponseBody
|
|
||||||
|
|
||||||
All butler tasks
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
|
||||||
| `butlerTasks` | [models.ButlerTasks](../models/butlertasks.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetDevicesErrors
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetDevicesMediaContainer
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
||||||
| `size` | *number* | :heavy_minus_sign: | N/A | 151 |
|
|
||||||
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.system.devices |
|
|
||||||
| `device` | [models.Device](../models/device.md)[] | :heavy_minus_sign: | N/A | |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetDevicesResponseBody
|
|
||||||
|
|
||||||
Devices
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
|
||||||
| `mediaContainer` | [models.GetDevicesMediaContainer](../models/getdevicesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetDevicesServerResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
||||||
| `errors` | [models.GetDevicesErrors](../models/getdeviceserrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetFileHashErrors
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# GetFileHashRequest
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
|
||||||
| `url` | *string* | :heavy_check_mark: | This is the path to the local file, must be prefixed by `file://` | file://C:\Image.png&type=13 |
|
|
||||||
| `type` | *number* | :heavy_minus_sign: | Item type | |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetFileHashResponse
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
||||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
|
||||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetFileHashResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
||||||
| `errors` | [models.GetFileHashErrors](../models/getfilehasherrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetGlobalHubsErrors
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetGlobalHubsHubsResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
||||||
| `errors` | [models.GetGlobalHubsErrors](../models/getglobalhubserrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetGlobalHubsMediaContainer
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
|
||||||
| `size` | *number* | :heavy_minus_sign: | N/A | 8 |
|
|
||||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
|
|
||||||
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
|
||||||
| `hub` | [models.Hub](../models/hub.md)[] | :heavy_minus_sign: | N/A | |
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
# GetGlobalHubsMetadata
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
|
||||||
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 57070 |
|
|
||||||
| `key` | *string* | :heavy_minus_sign: | N/A | /playlists/57070/items |
|
|
||||||
| `guid` | *string* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c |
|
|
||||||
| `type` | *string* | :heavy_minus_sign: | N/A | playlist |
|
|
||||||
| `title` | *string* | :heavy_minus_sign: | N/A | November Movie Day |
|
|
||||||
| `titleSort` | *string* | :heavy_minus_sign: | N/A | Tracks |
|
|
||||||
| `summary` | *string* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `smart` | *boolean* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `playlistType` | *string* | :heavy_minus_sign: | N/A | video |
|
|
||||||
| `composite` | *string* | :heavy_minus_sign: | N/A | /playlists/57070/composite/1668787730 |
|
|
||||||
| `icon` | *string* | :heavy_minus_sign: | N/A | playlist://image.smart |
|
|
||||||
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 2 |
|
|
||||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1668787732 |
|
|
||||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 16873000 |
|
|
||||||
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 3 |
|
|
||||||
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1668779618 |
|
|
||||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1668787730 |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetGlobalHubsResponse
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
|
||||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
|
||||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
| `object` | [models.GetGlobalHubsResponseBody](../models/getglobalhubsresponsebody.md) | :heavy_minus_sign: | returns global hubs |
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user