mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 20:47:46 +00:00
Compare commits
88 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
454b20d045 | ||
|
|
8c39ddc475 | ||
|
|
dca338d40f | ||
|
|
06e59965bd | ||
|
|
0be9307f80 | ||
|
|
25dcf36b37 | ||
|
|
63f13fd266 | ||
|
|
f21eae30b1 | ||
|
|
eb75f8d060 | ||
|
|
5e8618aa6f | ||
|
|
335ccf134f | ||
|
|
9bcd82719e | ||
|
|
58005d93e9 | ||
|
|
a366d87e75 | ||
|
|
d1f30a9f2c | ||
|
|
087db87584 | ||
|
|
7406efba26 | ||
|
|
b48aa356a7 | ||
|
|
f918b86b8c | ||
|
|
d241fca800 | ||
|
|
dafab7ed9d | ||
|
|
18817ccbc0 | ||
|
|
241fc555f6 | ||
|
|
60385aec49 | ||
|
|
502660742d | ||
|
|
796edd7174 | ||
|
|
738f7c347d | ||
|
|
5a3c016a7f | ||
|
|
bb1b355abf | ||
|
|
78522ed5bf | ||
|
|
8a524cf9e6 | ||
|
|
7e8aef026b | ||
|
|
886f24cade | ||
|
|
9c33aaa04f | ||
|
|
fc2f619cff | ||
|
|
2344b8fb5e | ||
|
|
2d0e878983 | ||
|
|
a96e359e00 | ||
|
|
d616464526 | ||
|
|
933b3708db | ||
|
|
ddc4f916f2 | ||
|
|
e418c55013 | ||
|
|
b593c2c54b | ||
|
|
a449d25ac4 | ||
|
|
6af375d524 | ||
|
|
fc838e8ebf | ||
|
|
162b3b3d13 | ||
|
|
3dff2b9225 | ||
|
|
d6d9c46f51 | ||
|
|
f79b24ee0e | ||
|
|
78c540ebf4 | ||
|
|
3fc9856c81 | ||
|
|
bc1fa68557 | ||
|
|
182d88f7f1 | ||
|
|
300cbb21cd | ||
|
|
53f3bfd615 | ||
|
|
92b22220f1 | ||
|
|
a42f887042 | ||
|
|
8b9c5c6e41 | ||
|
|
eab41f5f41 | ||
|
|
e038f1fdcf | ||
|
|
835f4244ec | ||
|
|
287c5cb9ad | ||
|
|
521174faf5 | ||
|
|
6fe948fa1e | ||
|
|
4abb238f51 | ||
|
|
c10b6af7de | ||
|
|
6bec4430ff | ||
|
|
3fe4aee2ea | ||
|
|
5b4a51bee7 | ||
|
|
b0cc884d46 | ||
|
|
a1dc07ae78 | ||
|
|
d100297e1d | ||
|
|
14f7d530ec | ||
|
|
622219b018 | ||
|
|
c4dd496e24 | ||
|
|
cdda7f840f | ||
|
|
2c04752d88 | ||
|
|
242d7d78f2 | ||
|
|
779aa2dc9e | ||
|
|
0d73a769fb | ||
|
|
eeadc8c329 | ||
|
|
dbe2e37bba | ||
|
|
6c314bea48 | ||
|
|
9e28d57f15 | ||
|
|
9da9389549 | ||
|
|
fd886229c2 | ||
|
|
8a8615f241 |
23
.github/workflows/codesee-arch-diagram.yml
vendored
23
.github/workflows/codesee-arch-diagram.yml
vendored
@@ -1,23 +0,0 @@
|
|||||||
# This workflow was added by CodeSee. Learn more at https://codesee.io/
|
|
||||||
# This is v2.0 of this workflow file
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
pull_request_target:
|
|
||||||
types: [opened, synchronize, reopened]
|
|
||||||
|
|
||||||
name: CodeSee
|
|
||||||
|
|
||||||
permissions: read-all
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
codesee:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
continue-on-error: true
|
|
||||||
name: Analyze the repo with CodeSee
|
|
||||||
steps:
|
|
||||||
- uses: Codesee-io/codesee-action@v2
|
|
||||||
with:
|
|
||||||
codesee-token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}
|
|
||||||
codesee-url: https://app.codesee.io
|
|
||||||
33
.github/workflows/publish-jsr.yaml
vendored
Normal file
33
.github/workflows/publish-jsr.yaml
vendored
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
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/speakeasy_sdk_generation.yml
vendored
54
.github/workflows/speakeasy_sdk_generation.yml
vendored
@@ -1,31 +1,31 @@
|
|||||||
name: Generate
|
name: Generate
|
||||||
permissions:
|
permissions:
|
||||||
checks: write
|
checks: write
|
||||||
contents: write
|
contents: write
|
||||||
pull-requests: write
|
pull-requests: write
|
||||||
statuses: write
|
statuses: write
|
||||||
"on":
|
"on":
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
inputs:
|
inputs:
|
||||||
force:
|
force:
|
||||||
description: Force generation of SDKs
|
description: Force generation of SDKs
|
||||||
type: boolean
|
type: boolean
|
||||||
default: false
|
default: false
|
||||||
schedule:
|
push_code_samples_only:
|
||||||
- cron: 0 0 * * *
|
description: Force push only code samples from SDK generation
|
||||||
|
type: boolean
|
||||||
|
default: false
|
||||||
|
schedule:
|
||||||
|
- cron: 0 0 * * *
|
||||||
jobs:
|
jobs:
|
||||||
generate:
|
generate:
|
||||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/sdk-generation.yaml@v14
|
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
||||||
with:
|
with:
|
||||||
force: ${{ github.event.inputs.force }}
|
force: ${{ github.event.inputs.force }}
|
||||||
languages: |
|
mode: direct
|
||||||
- typescript
|
push_code_samples_only: ${{ fromJSON(github.event.inputs.push_code_samples_only) }}
|
||||||
mode: direct
|
speakeasy_version: latest
|
||||||
openapi_docs: |
|
secrets:
|
||||||
- https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml
|
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
publish_typescript: true
|
npm_token: ${{ secrets.NPM_TOKEN }}
|
||||||
speakeasy_version: latest
|
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||||
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
Normal file
20
.github/workflows/tagging.yaml
vendored
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
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 }}
|
||||||
6
.gitignore
vendored
6
.gitignore
vendored
@@ -1,3 +1,9 @@
|
|||||||
|
/funcs
|
||||||
|
/core.*
|
||||||
|
/esm
|
||||||
|
/dist
|
||||||
|
/.tshy
|
||||||
|
/.tshy-*
|
||||||
/hooks
|
/hooks
|
||||||
/models
|
/models
|
||||||
/models/errors
|
/models/errors
|
||||||
|
|||||||
@@ -1,8 +1,9 @@
|
|||||||
/*
|
**/*
|
||||||
/docs/**/*.md
|
|
||||||
!/**/*.ts
|
!/**/*.ts
|
||||||
!/**/*.js
|
!/**/*.js
|
||||||
!/**/*.map
|
!/**/*.map
|
||||||
|
|
||||||
/.eslintrc.js
|
/.eslintrc.js
|
||||||
/cjs
|
/cjs
|
||||||
|
/.tshy
|
||||||
|
/.tshy-*
|
||||||
|
|||||||
1235
.speakeasy/gen.lock
1235
.speakeasy/gen.lock
File diff suppressed because it is too large
Load Diff
@@ -6,31 +6,36 @@ generation:
|
|||||||
optionalPropertyRendering: withExample
|
optionalPropertyRendering: withExample
|
||||||
useClassNamesForArrayFields: true
|
useClassNamesForArrayFields: true
|
||||||
fixes:
|
fixes:
|
||||||
nameResolutionDec2023: false
|
nameResolutionDec2023: true
|
||||||
parameterOrderingFeb2024: false
|
parameterOrderingFeb2024: true
|
||||||
requestResponseComponentNamesFeb2024: false
|
requestResponseComponentNamesFeb2024: true
|
||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: false
|
oAuth2ClientCredentialsEnabled: true
|
||||||
typescript:
|
typescript:
|
||||||
version: 0.10.1
|
version: 0.19.0
|
||||||
additionalDependencies:
|
additionalDependencies:
|
||||||
dependencies: {}
|
dependencies: {}
|
||||||
devDependencies: {}
|
devDependencies: {}
|
||||||
peerDependencies: {}
|
peerDependencies: {}
|
||||||
|
additionalPackageJSON: {}
|
||||||
author: LukeHagar
|
author: LukeHagar
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
|
enumFormat: enum
|
||||||
flattenGlobalSecurity: true
|
flattenGlobalSecurity: true
|
||||||
imports:
|
imports:
|
||||||
option: openapi
|
option: openapi
|
||||||
paths:
|
paths:
|
||||||
callbacks: models/callbacks
|
callbacks: ""
|
||||||
errors: models/errors
|
errors: ""
|
||||||
operations: models/operations
|
operations: ""
|
||||||
shared: models/components
|
shared: ""
|
||||||
webhooks: models/webhooks
|
webhooks: ""
|
||||||
inputModelSuffix: input
|
inputModelSuffix: input
|
||||||
maxMethodParams: 4
|
maxMethodParams: 4
|
||||||
|
methodArguments: require-security-and-request
|
||||||
|
moduleFormat: commonjs
|
||||||
outputModelSuffix: output
|
outputModelSuffix: output
|
||||||
packageName: '@lukehagar/plexjs'
|
packageName: '@lukehagar/plexjs'
|
||||||
responseFormat: envelope
|
responseFormat: envelope
|
||||||
templateVersion: v2
|
templateVersion: v2
|
||||||
|
useIndexModules: true
|
||||||
38
.speakeasy/workflow.lock
Normal file
38
.speakeasy/workflow.lock
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
speakeasyVersion: 1.377.1
|
||||||
|
sources:
|
||||||
|
my-source:
|
||||||
|
sourceNamespace: my-source
|
||||||
|
sourceRevisionDigest: sha256:4e103669d4bcf7c698608fa37524f3d644510de45959c5437c21b60b2fb2dd9f
|
||||||
|
sourceBlobDigest: sha256:3cb937b6d66508640fa6080fa4c16ebef73a438fbb21a1f8833d6dd2e8fcd5ee
|
||||||
|
tags:
|
||||||
|
- latest
|
||||||
|
- main
|
||||||
|
targets:
|
||||||
|
plexjs:
|
||||||
|
source: my-source
|
||||||
|
sourceNamespace: my-source
|
||||||
|
sourceRevisionDigest: sha256:4e103669d4bcf7c698608fa37524f3d644510de45959c5437c21b60b2fb2dd9f
|
||||||
|
sourceBlobDigest: sha256:3cb937b6d66508640fa6080fa4c16ebef73a438fbb21a1f8833d6dd2e8fcd5ee
|
||||||
|
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||||
|
codeSamplesRevisionDigest: sha256:439dcb28ca6dc855201641d70fc56ac3a6685187d824eb3077145b6a5be15b8b
|
||||||
|
outLocation: /github/workspace/repo
|
||||||
|
workflow:
|
||||||
|
workflowVersion: 1.0.0
|
||||||
|
speakeasyVersion: latest
|
||||||
|
sources:
|
||||||
|
my-source:
|
||||||
|
inputs:
|
||||||
|
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml
|
||||||
|
registry:
|
||||||
|
location: registry.speakeasyapi.dev/lukehagar/lukehagar/my-source
|
||||||
|
targets:
|
||||||
|
plexjs:
|
||||||
|
target: typescript
|
||||||
|
source: my-source
|
||||||
|
publish:
|
||||||
|
npm:
|
||||||
|
token: $NPM_TOKEN
|
||||||
|
codeSamples:
|
||||||
|
output: codeSamples.yaml
|
||||||
|
registry:
|
||||||
|
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-typescript-plexjs
|
||||||
19
.speakeasy/workflow.yaml
Normal file
19
.speakeasy/workflow.yaml
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
workflowVersion: 1.0.0
|
||||||
|
speakeasyVersion: latest
|
||||||
|
sources:
|
||||||
|
my-source:
|
||||||
|
inputs:
|
||||||
|
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml
|
||||||
|
registry:
|
||||||
|
location: registry.speakeasyapi.dev/lukehagar/lukehagar/my-source
|
||||||
|
targets:
|
||||||
|
plexjs:
|
||||||
|
target: typescript
|
||||||
|
source: my-source
|
||||||
|
publish:
|
||||||
|
npm:
|
||||||
|
token: $NPM_TOKEN
|
||||||
|
codeSamples:
|
||||||
|
output: codeSamples.yaml
|
||||||
|
registry:
|
||||||
|
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-typescript-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
|
||||||
105
FUNCTIONS.md
Normal file
105
FUNCTIONS.md
Normal file
@@ -0,0 +1,105 @@
|
|||||||
|
# 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 { serverGetServerCapabilities } from "@lukehagar/plexjs/funcs/serverGetServerCapabilities.js";
|
||||||
|
import { SDKValidationError } from "@lukehagar/plexjs/models/sdkvalidationerror.js";
|
||||||
|
|
||||||
|
// Use `PlexAPICore` for best tree-shaking performance.
|
||||||
|
// You can create one instance of it to use across an application.
|
||||||
|
const plexAPI = new PlexAPICore({
|
||||||
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
xPlexClientIdentifier: "Postman",
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const res = await serverGetServerCapabilities(plexAPI);
|
||||||
|
|
||||||
|
switch (true) {
|
||||||
|
case res.ok:
|
||||||
|
// The success case will be handled outside of the switch block
|
||||||
|
break;
|
||||||
|
case res.error instanceof SDKValidationError:
|
||||||
|
// Pretty-print validation errors.
|
||||||
|
return console.log(res.error.pretty());
|
||||||
|
case res.error instanceof Error:
|
||||||
|
return console.log(res.error);
|
||||||
|
default:
|
||||||
|
// TypeScript's type checking will fail on the following line if the above
|
||||||
|
// cases were not exhaustive.
|
||||||
|
res.error satisfies never;
|
||||||
|
throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
const { value: result } = res;
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result)
|
||||||
|
}
|
||||||
|
|
||||||
|
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).
|
||||||
26
Makefile
26
Makefile
@@ -1,26 +0,0 @@
|
|||||||
.PHONY: *
|
|
||||||
|
|
||||||
all: speakeasy
|
|
||||||
|
|
||||||
|
|
||||||
speakeasy: check-speakeasy
|
|
||||||
speakeasy generate sdk --lang typescript -o . -s ./openapi.yaml
|
|
||||||
|
|
||||||
speakeasy-validate: check-speakeasy
|
|
||||||
speakeasy validate openapi -s ./openapi.yaml
|
|
||||||
|
|
||||||
openapi:
|
|
||||||
curl https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml > ./openapi.yaml
|
|
||||||
|
|
||||||
# This will replace the generation source in your workflow file with your local schema path
|
|
||||||
generate-from-local:
|
|
||||||
@if ! which sed >/dev/null; then \
|
|
||||||
echo "sed is not installed. Please install it using the following command:"; \
|
|
||||||
echo "For Ubuntu/Debian: apt-get install sed"; \
|
|
||||||
echo "For macOS: sed is pre-installed"; \
|
|
||||||
exit 1; \
|
|
||||||
fi
|
|
||||||
@sed -i '' '/openapi_docs: |/{n;s|-.*|- ./openapi.yaml|;}' ./.github/workflows/speakeasy_sdk_generation.yml
|
|
||||||
|
|
||||||
check-speakeasy:
|
|
||||||
@command -v speakeasy >/dev/null 2>&1 || { echo >&2 "speakeasy CLI is not installed. Please install before continuing."; exit 1; }
|
|
||||||
308
README.md
308
README.md
@@ -16,10 +16,25 @@
|
|||||||
npm add @lukehagar/plexjs
|
npm add @lukehagar/plexjs
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### PNPM
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm add @lukehagar/plexjs
|
||||||
|
```
|
||||||
|
|
||||||
|
### Bun
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bun add @lukehagar/plexjs
|
||||||
|
```
|
||||||
|
|
||||||
### Yarn
|
### Yarn
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn add @lukehagar/plexjs
|
yarn add @lukehagar/plexjs zod
|
||||||
|
|
||||||
|
# Note that Yarn does not install peer dependencies automatically. You will need
|
||||||
|
# to install zod as shown above.
|
||||||
```
|
```
|
||||||
<!-- End SDK Installation [installation] -->
|
<!-- End SDK Installation [installation] -->
|
||||||
|
|
||||||
@@ -31,12 +46,13 @@ yarn add @lukehagar/plexjs
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "Postman",
|
||||||
});
|
});
|
||||||
|
|
||||||
const result = await sdk.server.getServerCapabilities();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
@@ -52,7 +68,7 @@ run();
|
|||||||
|
|
||||||
### [server](docs/sdks/server/README.md)
|
### [server](docs/sdks/server/README.md)
|
||||||
|
|
||||||
* [getServerCapabilities](docs/sdks/server/README.md#getservercapabilities) - Server Capabilities
|
* [getServerCapabilities](docs/sdks/server/README.md#getservercapabilities) - Get Server Capabilities
|
||||||
* [getServerPreferences](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
|
* [getServerPreferences](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
|
||||||
* [getAvailableClients](docs/sdks/server/README.md#getavailableclients) - Get Available Clients
|
* [getAvailableClients](docs/sdks/server/README.md#getavailableclients) - Get Available Clients
|
||||||
* [getDevices](docs/sdks/server/README.md#getdevices) - Get Devices
|
* [getDevices](docs/sdks/server/README.md#getdevices) - Get Devices
|
||||||
@@ -85,6 +101,17 @@ run();
|
|||||||
* [startTask](docs/sdks/butler/README.md#starttask) - Start a single Butler task
|
* [startTask](docs/sdks/butler/README.md#starttask) - Start a single Butler task
|
||||||
* [stopTask](docs/sdks/butler/README.md#stoptask) - Stop a single Butler task
|
* [stopTask](docs/sdks/butler/README.md#stoptask) - Stop a single Butler task
|
||||||
|
|
||||||
|
### [plex](docs/sdks/plex/README.md)
|
||||||
|
|
||||||
|
* [getCompanionsData](docs/sdks/plex/README.md#getcompanionsdata) - Get Companions Data
|
||||||
|
* [getUserFriends](docs/sdks/plex/README.md#getuserfriends) - Get list of friends of the user logged in
|
||||||
|
* [getGeoData](docs/sdks/plex/README.md#getgeodata) - Get Geo Data
|
||||||
|
* [getHomeData](docs/sdks/plex/README.md#gethomedata) - Get Plex Home Data
|
||||||
|
* [getResources](docs/sdks/plex/README.md#getresources) - Get Resources
|
||||||
|
* [getPin](docs/sdks/plex/README.md#getpin) - Get a Pin
|
||||||
|
* [getTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid) - Get Access Token by PinId
|
||||||
|
* [getUserDetails](docs/sdks/plex/README.md#getuserdetails) - Get UserData By Token
|
||||||
|
|
||||||
### [hubs](docs/sdks/hubs/README.md)
|
### [hubs](docs/sdks/hubs/README.md)
|
||||||
|
|
||||||
* [getGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
|
* [getGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
|
||||||
@@ -108,6 +135,7 @@ run();
|
|||||||
* [searchLibrary](docs/sdks/library/README.md#searchlibrary) - Search Library
|
* [searchLibrary](docs/sdks/library/README.md#searchlibrary) - Search Library
|
||||||
* [getMetadata](docs/sdks/library/README.md#getmetadata) - Get Items Metadata
|
* [getMetadata](docs/sdks/library/README.md#getmetadata) - Get Items Metadata
|
||||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||||
|
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||||
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||||
|
|
||||||
### [log](docs/sdks/log/README.md)
|
### [log](docs/sdks/log/README.md)
|
||||||
@@ -116,11 +144,6 @@ run();
|
|||||||
* [logMultiLine](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
|
* [logMultiLine](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
|
||||||
* [enablePaperTrail](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
|
* [enablePaperTrail](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
|
||||||
|
|
||||||
### [plex](docs/sdks/plex/README.md)
|
|
||||||
|
|
||||||
* [getPin](docs/sdks/plex/README.md#getpin) - Get a Pin
|
|
||||||
* [getToken](docs/sdks/plex/README.md#gettoken) - Get Access Token
|
|
||||||
|
|
||||||
### [playlists](docs/sdks/playlists/README.md)
|
### [playlists](docs/sdks/playlists/README.md)
|
||||||
|
|
||||||
* [createPlaylist](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
|
* [createPlaylist](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
|
||||||
@@ -141,6 +164,8 @@ run();
|
|||||||
### [statistics](docs/sdks/statistics/README.md)
|
### [statistics](docs/sdks/statistics/README.md)
|
||||||
|
|
||||||
* [getStatistics](docs/sdks/statistics/README.md#getstatistics) - Get Media Statistics
|
* [getStatistics](docs/sdks/statistics/README.md#getstatistics) - Get Media Statistics
|
||||||
|
* [getResourcesStatistics](docs/sdks/statistics/README.md#getresourcesstatistics) - Get Resources Statistics
|
||||||
|
* [getBandwidthStatistics](docs/sdks/statistics/README.md#getbandwidthstatistics) - Get Bandwidth Statistics
|
||||||
|
|
||||||
### [sessions](docs/sdks/sessions/README.md)
|
### [sessions](docs/sdks/sessions/README.md)
|
||||||
|
|
||||||
@@ -154,6 +179,14 @@ run();
|
|||||||
* [getUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
|
* [getUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
|
||||||
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
||||||
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
||||||
|
|
||||||
|
### [user](docs/sdks/user/README.md)
|
||||||
|
|
||||||
|
* [postUsersSigninData](docs/sdks/user/README.md#postuserssignindata) - Get User SignIn Data
|
||||||
|
|
||||||
|
### [watchlist](docs/sdks/watchlist/README.md)
|
||||||
|
|
||||||
|
* [getWatchlist](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
|
||||||
<!-- End Available Resources and Operations [operations] -->
|
<!-- End Available Resources and Operations [operations] -->
|
||||||
|
|
||||||
<!-- Start Error Handling [errors] -->
|
<!-- Start Error Handling [errors] -->
|
||||||
@@ -161,36 +194,37 @@ run();
|
|||||||
|
|
||||||
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
|
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
|
||||||
|
|
||||||
| Error Object | Status Code | Content Type |
|
| Error Object | Status Code | Content Type |
|
||||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||||
| errors.GetServerCapabilitiesResponseBody | 401 | application/json |
|
| models.GetServerCapabilitiesServerResponseBody | 401 | application/json |
|
||||||
| errors.SDKError | 4xx-5xx | */* |
|
| models.SDKError | 4xx-5xx | */* |
|
||||||
|
|
||||||
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
|
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
|
||||||
|
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import * as errors from "@lukehagar/plexjs/models/errors";
|
import { SDKValidationError } from "@lukehagar/plexjs/models";
|
||||||
|
|
||||||
|
const plexAPI = new PlexAPI({
|
||||||
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
xPlexClientIdentifier: "Postman",
|
||||||
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
|
||||||
});
|
|
||||||
|
|
||||||
let result;
|
let result;
|
||||||
try {
|
try {
|
||||||
result = await sdk.server.getServerCapabilities();
|
result = await plexAPI.server.getServerCapabilities();
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
switch (true) {
|
switch (true) {
|
||||||
case err instanceof errors.SDKValidationError: {
|
case err instanceof SDKValidationError: {
|
||||||
// Validation errors can be pretty-printed
|
// Validation errors can be pretty-printed
|
||||||
console.error(err.pretty());
|
console.error(err.pretty());
|
||||||
// Raw value may also be inspected
|
// Raw value may also be inspected
|
||||||
console.error(err.rawValue);
|
console.error(err.rawValue);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
case err instanceof errors.GetServerCapabilitiesResponseBody: {
|
case err instanceof models.GetServerCapabilitiesServerResponseBody: {
|
||||||
console.error(err); // handle exception
|
console.error(err); // handle exception
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
@@ -223,13 +257,14 @@ You can override the default server globally by passing a server index to the `s
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
serverIdx: 0,
|
||||||
serverIdx: 0,
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "Postman",
|
||||||
});
|
});
|
||||||
|
|
||||||
const result = await sdk.server.getServerCapabilities();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
@@ -253,13 +288,14 @@ The default server can also be overridden globally by passing a URL to the `serv
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
serverURL: "{protocol}://{ip}:{port}",
|
||||||
serverURL: "{protocol}://{ip}:{port}",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "Postman",
|
||||||
});
|
});
|
||||||
|
|
||||||
const result = await sdk.server.getServerCapabilities();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
@@ -275,13 +311,13 @@ The server URL can also be overridden on a per-operation basis, provided a serve
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
const plexAPI = new PlexAPI({
|
||||||
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
xPlexClientIdentifier: "Postman",
|
||||||
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI();
|
const result = await plexAPI.plex.getCompanionsData({
|
||||||
|
|
||||||
const xPlexClientIdentifier = "<value>";
|
|
||||||
const strong = false;
|
|
||||||
|
|
||||||
const result = await sdk.plex.getPin(xPlexClientIdentifier, strong, {
|
|
||||||
serverURL: "https://plex.tv/api/v2",
|
serverURL: "https://plex.tv/api/v2",
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -324,7 +360,7 @@ const httpClient = new HTTPClient({
|
|||||||
|
|
||||||
httpClient.addHook("beforeRequest", (request) => {
|
httpClient.addHook("beforeRequest", (request) => {
|
||||||
const nextRequest = new Request(request, {
|
const nextRequest = new Request(request, {
|
||||||
signal: request.signal || AbortSignal.timeout(5000);
|
signal: request.signal || AbortSignal.timeout(5000)
|
||||||
});
|
});
|
||||||
|
|
||||||
nextRequest.headers.set("x-custom-header", "custom value");
|
nextRequest.headers.set("x-custom-header", "custom value");
|
||||||
@@ -358,12 +394,13 @@ To authenticate with the API the `accessToken` parameter must be set when initia
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "Postman",
|
||||||
});
|
});
|
||||||
|
|
||||||
const result = await sdk.server.getServerCapabilities();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
@@ -380,6 +417,181 @@ run();
|
|||||||
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
|
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
|
||||||
<!-- End Requirements [requirements] -->
|
<!-- End Requirements [requirements] -->
|
||||||
|
|
||||||
|
<!-- Start Standalone functions [standalone-funcs] -->
|
||||||
|
## Standalone functions
|
||||||
|
|
||||||
|
All the methods listed above are available as standalone functions. These
|
||||||
|
functions are ideal for use in applications running in the browser, serverless
|
||||||
|
runtimes or other environments where application bundle size is a primary
|
||||||
|
concern. When using a bundler to build your application, all unused
|
||||||
|
functionality will be either excluded from the final bundle or tree-shaken away.
|
||||||
|
|
||||||
|
To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||||
|
|
||||||
|
<details>
|
||||||
|
|
||||||
|
<summary>Available standalone functions</summary>
|
||||||
|
|
||||||
|
- [activitiesCancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities)
|
||||||
|
- [activitiesGetServerActivities](docs/sdks/activities/README.md#getserveractivities)
|
||||||
|
- [authenticationGetSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation)
|
||||||
|
- [authenticationGetTransientToken](docs/sdks/authentication/README.md#gettransienttoken)
|
||||||
|
- [butlerGetButlerTasks](docs/sdks/butler/README.md#getbutlertasks)
|
||||||
|
- [butlerStartAllTasks](docs/sdks/butler/README.md#startalltasks)
|
||||||
|
- [butlerStartTask](docs/sdks/butler/README.md#starttask)
|
||||||
|
- [butlerStopAllTasks](docs/sdks/butler/README.md#stopalltasks)
|
||||||
|
- [butlerStopTask](docs/sdks/butler/README.md#stoptask)
|
||||||
|
- [hubsGetGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs)
|
||||||
|
- [hubsGetLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs)
|
||||||
|
- [libraryDeleteLibrary](docs/sdks/library/README.md#deletelibrary)
|
||||||
|
- [libraryGetFileHash](docs/sdks/library/README.md#getfilehash)
|
||||||
|
- [libraryGetLibraries](docs/sdks/library/README.md#getlibraries)
|
||||||
|
- [libraryGetLibraryItems](docs/sdks/library/README.md#getlibraryitems)
|
||||||
|
- [libraryGetLibrary](docs/sdks/library/README.md#getlibrary)
|
||||||
|
- [libraryGetMetadataChildren](docs/sdks/library/README.md#getmetadatachildren)
|
||||||
|
- [libraryGetMetadata](docs/sdks/library/README.md#getmetadata)
|
||||||
|
- [libraryGetOnDeck](docs/sdks/library/README.md#getondeck)
|
||||||
|
- [libraryGetRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded)
|
||||||
|
- [libraryGetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent)
|
||||||
|
- [libraryRefreshLibrary](docs/sdks/library/README.md#refreshlibrary)
|
||||||
|
- [librarySearchLibrary](docs/sdks/library/README.md#searchlibrary)
|
||||||
|
- [logEnablePaperTrail](docs/sdks/log/README.md#enablepapertrail)
|
||||||
|
- [logLogLine](docs/sdks/log/README.md#logline)
|
||||||
|
- [logLogMultiLine](docs/sdks/log/README.md#logmultiline)
|
||||||
|
- [mediaMarkPlayed](docs/sdks/media/README.md#markplayed)
|
||||||
|
- [mediaMarkUnplayed](docs/sdks/media/README.md#markunplayed)
|
||||||
|
- [mediaUpdatePlayProgress](docs/sdks/media/README.md#updateplayprogress)
|
||||||
|
- [playlistsAddPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents)
|
||||||
|
- [playlistsClearPlaylistContents](docs/sdks/playlists/README.md#clearplaylistcontents)
|
||||||
|
- [playlistsCreatePlaylist](docs/sdks/playlists/README.md#createplaylist)
|
||||||
|
- [playlistsDeletePlaylist](docs/sdks/playlists/README.md#deleteplaylist)
|
||||||
|
- [playlistsGetPlaylistContents](docs/sdks/playlists/README.md#getplaylistcontents)
|
||||||
|
- [playlistsGetPlaylist](docs/sdks/playlists/README.md#getplaylist)
|
||||||
|
- [playlistsGetPlaylists](docs/sdks/playlists/README.md#getplaylists)
|
||||||
|
- [playlistsUpdatePlaylist](docs/sdks/playlists/README.md#updateplaylist)
|
||||||
|
- [playlistsUploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist)
|
||||||
|
- [plexGetCompanionsData](docs/sdks/plex/README.md#getcompanionsdata)
|
||||||
|
- [plexGetGeoData](docs/sdks/plex/README.md#getgeodata)
|
||||||
|
- [plexGetHomeData](docs/sdks/plex/README.md#gethomedata)
|
||||||
|
- [plexGetPin](docs/sdks/plex/README.md#getpin)
|
||||||
|
- [plexGetResources](docs/sdks/plex/README.md#getresources)
|
||||||
|
- [plexGetTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid)
|
||||||
|
- [plexGetUserDetails](docs/sdks/plex/README.md#getuserdetails)
|
||||||
|
- [plexGetUserFriends](docs/sdks/plex/README.md#getuserfriends)
|
||||||
|
- [searchGetSearchResults](docs/sdks/search/README.md#getsearchresults)
|
||||||
|
- [searchPerformSearch](docs/sdks/search/README.md#performsearch)
|
||||||
|
- [searchPerformVoiceSearch](docs/sdks/search/README.md#performvoicesearch)
|
||||||
|
- [serverGetAvailableClients](docs/sdks/server/README.md#getavailableclients)
|
||||||
|
- [serverGetDevices](docs/sdks/server/README.md#getdevices)
|
||||||
|
- [serverGetMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount)
|
||||||
|
- [serverGetResizedPhoto](docs/sdks/server/README.md#getresizedphoto)
|
||||||
|
- [serverGetServerCapabilities](docs/sdks/server/README.md#getservercapabilities)
|
||||||
|
- [serverGetServerIdentity](docs/sdks/server/README.md#getserveridentity)
|
||||||
|
- [serverGetServerList](docs/sdks/server/README.md#getserverlist)
|
||||||
|
- [serverGetServerPreferences](docs/sdks/server/README.md#getserverpreferences)
|
||||||
|
- [sessionsGetSessionHistory](docs/sdks/sessions/README.md#getsessionhistory)
|
||||||
|
- [sessionsGetSessions](docs/sdks/sessions/README.md#getsessions)
|
||||||
|
- [sessionsGetTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions)
|
||||||
|
- [sessionsStopTranscodeSession](docs/sdks/sessions/README.md#stoptranscodesession)
|
||||||
|
- [statisticsGetBandwidthStatistics](docs/sdks/statistics/README.md#getbandwidthstatistics)
|
||||||
|
- [statisticsGetResourcesStatistics](docs/sdks/statistics/README.md#getresourcesstatistics)
|
||||||
|
- [statisticsGetStatistics](docs/sdks/statistics/README.md#getstatistics)
|
||||||
|
- [updaterApplyUpdates](docs/sdks/updater/README.md#applyupdates)
|
||||||
|
- [updaterCheckForUpdates](docs/sdks/updater/README.md#checkforupdates)
|
||||||
|
- [updaterGetUpdateStatus](docs/sdks/updater/README.md#getupdatestatus)
|
||||||
|
- [userPostUsersSigninData](docs/sdks/user/README.md#postuserssignindata)
|
||||||
|
- [videoGetTimeline](docs/sdks/video/README.md#gettimeline)
|
||||||
|
- [videoStartUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode)
|
||||||
|
- [watchlistGetWatchlist](docs/sdks/watchlist/README.md#getwatchlist)
|
||||||
|
|
||||||
|
|
||||||
|
</details>
|
||||||
|
<!-- End Standalone functions [standalone-funcs] -->
|
||||||
|
|
||||||
|
<!-- Start Retries [retries] -->
|
||||||
|
## Retries
|
||||||
|
|
||||||
|
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
|
||||||
|
|
||||||
|
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
|
||||||
|
```typescript
|
||||||
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
const plexAPI = new PlexAPI({
|
||||||
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
xPlexClientIdentifier: "Postman",
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities({
|
||||||
|
retries: {
|
||||||
|
strategy: "backoff",
|
||||||
|
backoff: {
|
||||||
|
initialInterval: 1,
|
||||||
|
maxInterval: 50,
|
||||||
|
exponent: 1.1,
|
||||||
|
maxElapsedTime: 100,
|
||||||
|
},
|
||||||
|
retryConnectionErrors: false,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
|
||||||
|
```typescript
|
||||||
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
const plexAPI = new PlexAPI({
|
||||||
|
retryConfig: {
|
||||||
|
strategy: "backoff",
|
||||||
|
backoff: {
|
||||||
|
initialInterval: 1,
|
||||||
|
maxInterval: 50,
|
||||||
|
exponent: 1.1,
|
||||||
|
maxElapsedTime: 100,
|
||||||
|
},
|
||||||
|
retryConnectionErrors: false,
|
||||||
|
},
|
||||||
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
xPlexClientIdentifier: "Postman",
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End Retries [retries] -->
|
||||||
|
|
||||||
|
<!-- Start Debugging [debug] -->
|
||||||
|
## Debugging
|
||||||
|
|
||||||
|
You can setup your SDK to emit debug logs for SDK requests and responses.
|
||||||
|
|
||||||
|
You can pass a logger that matches `console`'s interface as an SDK option.
|
||||||
|
|
||||||
|
> [!WARNING]
|
||||||
|
> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
const sdk = new PlexAPI({ debugLogger: console });
|
||||||
|
```
|
||||||
|
<!-- End Debugging [debug] -->
|
||||||
|
|
||||||
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
||||||
|
|
||||||
# Development
|
# Development
|
||||||
|
|||||||
700
RELEASES.md
700
RELEASES.md
@@ -239,3 +239,703 @@ Based on:
|
|||||||
- [typescript v0.10.1] .
|
- [typescript v0.10.1] .
|
||||||
### Releases
|
### Releases
|
||||||
- [NPM v0.10.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.10.1 - .
|
- [NPM v0.10.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.10.1 - .
|
||||||
|
|
||||||
|
## 2024-03-14 00:25:24
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.209.2 (2.281.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.10.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.10.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.10.2 - .
|
||||||
|
|
||||||
|
## 2024-03-15 15:02:11
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.209.3 (2.281.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.10.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.10.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.10.3 - .
|
||||||
|
|
||||||
|
## 2024-03-20 00:25:49
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.213.0 (2.283.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.10.4] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.10.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.10.4 - .
|
||||||
|
|
||||||
|
## 2024-03-27 00:25:29
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.227.0 (2.291.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.11.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.11.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.11.0 - .
|
||||||
|
|
||||||
|
## 2024-03-29 16:36:42
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.228.1 (2.292.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.12.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.12.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.12.0 - .
|
||||||
|
|
||||||
|
## 2024-04-02 00:26:20
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.231.1 (2.295.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.12.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.12.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.12.1 - .
|
||||||
|
|
||||||
|
## 2024-04-13 00:23:00
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.252.0 (2.306.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.12.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.12.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.12.2 - .
|
||||||
|
|
||||||
|
## 2024-04-18 00:26:16
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.257.1 (2.308.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.12.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.12.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.12.3 - .
|
||||||
|
|
||||||
|
## 2024-04-19 00:26:47
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.260.6 (2.311.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.13.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.13.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.0 - .
|
||||||
|
|
||||||
|
## 2024-04-20 00:26:02
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.267.0 (2.312.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.13.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.13.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.0 - .
|
||||||
|
|
||||||
|
## 2024-04-22 16:14:48
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.267.2 (2.312.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.13.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.13.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.1 - .
|
||||||
|
|
||||||
|
## 2024-04-22 16:25:57
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.267.2 (2.312.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.13.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.13.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.2 - .
|
||||||
|
|
||||||
|
## 2024-04-23 00:26:56
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.269.1 (2.312.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.13.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.13.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.2 - .
|
||||||
|
|
||||||
|
## 2024-04-25 00:28:39
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.274.1 (2.314.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.0 - .
|
||||||
|
|
||||||
|
## 2024-04-26 00:27:03
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.274.1 (2.314.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.0 - .
|
||||||
|
|
||||||
|
## 2024-04-27 00:26:14
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.276.0 (2.314.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.0 - .
|
||||||
|
|
||||||
|
## 2024-04-28 00:29:48
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.276.0 (2.314.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.0 - .
|
||||||
|
|
||||||
|
## 2024-04-29 00:27:42
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.276.0 (2.314.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.0 - .
|
||||||
|
|
||||||
|
## 2024-04-30 00:26:07
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.277.0 (2.317.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.1 - .
|
||||||
|
|
||||||
|
## 2024-05-01 00:29:15
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.277.4 (2.318.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.1 - .
|
||||||
|
|
||||||
|
## 2024-05-02 00:26:42
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.277.4 (2.318.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.1 - .
|
||||||
|
|
||||||
|
## 2024-05-03 00:27:14
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.277.8 (2.319.10) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.2 - .
|
||||||
|
|
||||||
|
## 2024-05-04 00:26:20
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.279.0 (2.322.5) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.2 - .
|
||||||
|
|
||||||
|
## 2024-05-05 00:29:26
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.279.0 (2.322.5) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.2 - .
|
||||||
|
|
||||||
|
## 2024-05-06 00:28:07
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.279.0 (2.322.5) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.2 - .
|
||||||
|
|
||||||
|
## 2024-05-07 00:27:12
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.280.1 (2.322.5) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.2 - .
|
||||||
|
|
||||||
|
## 2024-05-08 00:22:14
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.283.1 (2.324.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.2 - .
|
||||||
|
|
||||||
|
## 2024-05-08 18:14:57
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.285.0 (2.326.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.15.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.15.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.15.0 - .
|
||||||
|
|
||||||
|
## 2024-05-09 00:26:57
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.285.1 (2.326.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.15.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.15.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.15.0 - .
|
||||||
|
|
||||||
|
## 2024-05-09 03:30:33
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.285.1 (2.326.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.15.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.15.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.15.1 - .
|
||||||
|
|
||||||
|
## 2024-05-09 03:45:22
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.285.1 (2.326.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.15.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.15.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.15.2 - .
|
||||||
|
|
||||||
|
## 2024-05-09 04:14:12
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.285.1 (2.326.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.15.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.15.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.15.3 - .
|
||||||
|
|
||||||
|
## 2024-05-09 04:22:48
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.285.1 (2.326.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.15.4] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.15.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.15.4 - .
|
||||||
|
|
||||||
|
## 2024-05-23 15:56:57
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.295.1 (2.335.5) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.0 - .
|
||||||
|
|
||||||
|
## 2024-05-24 00:28:19
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.295.2 (2.335.5) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.0 - .
|
||||||
|
|
||||||
|
## 2024-05-25 00:26:58
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.296.1 (2.338.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.1 - .
|
||||||
|
|
||||||
|
## 2024-05-26 00:31:02
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.296.1 (2.338.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.1 - .
|
||||||
|
|
||||||
|
## 2024-05-27 00:28:56
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.296.1 (2.338.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.1 - .
|
||||||
|
|
||||||
|
## 2024-05-28 00:28:13
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.296.1 (2.338.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.1 - .
|
||||||
|
|
||||||
|
## 2024-05-29 00:29:15
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.296.1 (2.338.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.1 - .
|
||||||
|
|
||||||
|
## 2024-05-30 00:28:36
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.299.1 (2.338.5) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.2 - .
|
||||||
|
|
||||||
|
## 2024-05-31 00:27:50
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.299.3 (2.338.7) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.2 - .
|
||||||
|
|
||||||
|
## 2024-06-01 00:30:42
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.299.4 (2.338.7) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.2 - .
|
||||||
|
|
||||||
|
## 2024-06-02 00:31:00
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.299.4 (2.338.7) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.2 - .
|
||||||
|
|
||||||
|
## 2024-06-03 00:29:24
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.299.4 (2.338.7) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.2 - .
|
||||||
|
|
||||||
|
## 2024-06-04 00:28:27
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.299.6 (2.338.12) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.3 - .
|
||||||
|
|
||||||
|
## 2024-06-05 00:28:12
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.299.7 (2.338.12) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.3 - .
|
||||||
|
|
||||||
|
## 2024-06-06 00:28:24
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.300.0 (2.338.14) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.4] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.4 - .
|
||||||
|
|
||||||
|
## 2024-06-07 00:29:43
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.300.1 (2.339.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.4] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.4 - .
|
||||||
|
|
||||||
|
## 2024-06-08 00:29:06
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.300.1 (2.339.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.4] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.4 - .
|
||||||
|
|
||||||
|
## 2024-06-09 00:32:36
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.300.1 (2.339.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.4] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.4 - .
|
||||||
|
|
||||||
|
## 2024-06-10 00:30:14
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.300.1 (2.339.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.4] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.4 - .
|
||||||
|
|
||||||
|
## 2024-06-12 00:28:55
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.305.0 (2.340.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.5] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.5 - .
|
||||||
|
|
||||||
|
## 2024-06-13 00:01:20
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.306.0 (2.340.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.5] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.5 - .
|
||||||
|
|
||||||
|
## 2024-06-14 00:01:12
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.307.2 (2.342.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.6] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.6] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.6 - .
|
||||||
|
|
||||||
|
## 2024-06-14 16:22:55
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.308.1 (2.342.6) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.17.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.17.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.17.0 - .
|
||||||
|
|
||||||
|
## 2024-06-15 00:01:01
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.308.1 (2.342.6) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.17.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.17.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.17.0 - .
|
||||||
|
|
||||||
|
## 2024-06-22 00:01:06
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.314.2 (2.349.6) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.18.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.18.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.18.0 - .
|
||||||
|
|
||||||
|
## 2024-06-23 00:01:17
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.314.2 (2.349.6) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.18.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.18.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.18.0 - .
|
||||||
|
|
||||||
|
## 2024-06-24 00:01:13
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.314.2 (2.349.6) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.18.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.18.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.18.0 - .
|
||||||
|
|
||||||
|
## 2024-06-25 00:01:07
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.315.2 (2.352.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.18.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.18.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.18.0 - .
|
||||||
|
|
||||||
|
## 2024-06-26 00:03:38
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.318.0 (2.352.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.18.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.18.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.18.0 - .
|
||||||
|
|
||||||
|
## 2024-06-27 00:01:14
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.321.0 (2.354.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.18.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.18.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.18.0 - .
|
||||||
|
|
||||||
|
## 2024-06-28 00:01:08
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.322.1 (2.354.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.18.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.18.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.18.0 - .
|
||||||
|
|
||||||
|
## 2024-06-29 00:01:06
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.322.3 (2.354.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.18.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.18.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.18.0 - .
|
||||||
|
|
||||||
|
## 2024-06-30 00:01:08
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.322.3 (2.354.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.18.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.18.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.18.0 - .
|
||||||
|
|
||||||
|
## 2024-07-01 00:01:17
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.322.3 (2.354.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.18.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.18.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.18.0 - .
|
||||||
|
|
||||||
|
## 2024-07-01 15:43:13
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.323.0 (2.356.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.18.1] .
|
||||||
|
### Releases
|
||||||
|
- [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 - .
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
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 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
|
||||||
|
|||||||
11
USAGE.md
11
USAGE.md
@@ -2,12 +2,13 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "Postman",
|
||||||
});
|
});
|
||||||
|
|
||||||
const result = await sdk.server.getServerCapabilities();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
|
|||||||
1540
codeSamples.yaml
Normal file
1540
codeSamples.yaml
Normal file
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,5 +1,21 @@
|
|||||||
# Account
|
# Account
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Account } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: Account = {
|
||||||
|
id: 238960586,
|
||||||
|
key: "/accounts/238960586",
|
||||||
|
name: "Diane",
|
||||||
|
defaultAudioLanguage: "en",
|
||||||
|
autoSelectAudio: true,
|
||||||
|
defaultSubtitleLanguage: "en",
|
||||||
|
subtitleMode: 1,
|
||||||
|
thumb: "https://plex.tv/users/50d83634246da1de/avatar?c=1707110967",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
22
docs/models/activity.md
Normal file
22
docs/models/activity.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
# Activity
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Activity } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: 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,5 +1,16 @@
|
|||||||
# AddPlaylistContentsErrors
|
# AddPlaylistContentsErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AddPlaylistContentsErrors } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: AddPlaylistContentsErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
39
docs/models/addplaylistcontentsmediacontainer.md
Normal file
39
docs/models/addplaylistcontentsmediacontainer.md
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
# AddPlaylistContentsMediaContainer
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AddPlaylistContentsMediaContainer } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: AddPlaylistContentsMediaContainer = {
|
||||||
|
size: 1,
|
||||||
|
leafCountAdded: 1,
|
||||||
|
leafCountRequested: 1,
|
||||||
|
metadata: [
|
||||||
|
{
|
||||||
|
ratingKey: "94",
|
||||||
|
key: "/playlists/94/items",
|
||||||
|
guid: "com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2",
|
||||||
|
type: "playlist",
|
||||||
|
title: "A great playlist",
|
||||||
|
summary: "One of my great playlists",
|
||||||
|
smart: false,
|
||||||
|
playlistType: "video",
|
||||||
|
composite: "/playlists/94/composite/1705800070",
|
||||||
|
duration: 423000,
|
||||||
|
leafCount: 3,
|
||||||
|
addedAt: 1705716458,
|
||||||
|
updatedAt: 1705800070,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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,5 +1,26 @@
|
|||||||
# AddPlaylistContentsMetadata
|
# AddPlaylistContentsMetadata
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AddPlaylistContentsMetadata } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: AddPlaylistContentsMetadata = {
|
||||||
|
ratingKey: "94",
|
||||||
|
key: "/playlists/94/items",
|
||||||
|
guid: "com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2",
|
||||||
|
type: "playlist",
|
||||||
|
title: "A great playlist",
|
||||||
|
summary: "One of my great playlists",
|
||||||
|
smart: false,
|
||||||
|
playlistType: "video",
|
||||||
|
composite: "/playlists/94/composite/1705800070",
|
||||||
|
duration: 423000,
|
||||||
|
leafCount: 3,
|
||||||
|
addedAt: 1705716458,
|
||||||
|
updatedAt: 1705800070,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,11 +1,18 @@
|
|||||||
# GetLibraryHubsResponseBody
|
# AddPlaylistContentsPlaylistsResponseBody
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AddPlaylistContentsPlaylistsResponseBody } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||||
| `errors` | [errors.GetLibraryHubsErrors](../../models/errors/getlibraryhubserrors.md)[] | :heavy_minus_sign: | N/A |
|
| `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 |
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,5 +1,16 @@
|
|||||||
# AddPlaylistContentsRequest
|
# AddPlaylistContentsRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: AddPlaylistContentsRequest = {
|
||||||
|
playlistID: 6350.59,
|
||||||
|
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
||||||
|
playQueueID: 123,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
48
docs/models/addplaylistcontentsresponse.md
Normal file
48
docs/models/addplaylistcontentsresponse.md
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
# AddPlaylistContentsResponse
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AddPlaylistContentsResponse } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: AddPlaylistContentsResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 161309,
|
||||||
|
rawResponse: new Response('{"message": "hello world"}', {
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
}),
|
||||||
|
object: {
|
||||||
|
mediaContainer: {
|
||||||
|
size: 1,
|
||||||
|
leafCountAdded: 1,
|
||||||
|
leafCountRequested: 1,
|
||||||
|
metadata: [
|
||||||
|
{
|
||||||
|
ratingKey: "94",
|
||||||
|
key: "/playlists/94/items",
|
||||||
|
guid: "com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2",
|
||||||
|
type: "playlist",
|
||||||
|
title: "A great playlist",
|
||||||
|
summary: "One of my great playlists",
|
||||||
|
smart: false,
|
||||||
|
playlistType: "video",
|
||||||
|
composite: "/playlists/94/composite/1705800070",
|
||||||
|
duration: 423000,
|
||||||
|
leafCount: 3,
|
||||||
|
addedAt: 1705716458,
|
||||||
|
updatedAt: 1705800070,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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 |
|
||||||
40
docs/models/addplaylistcontentsresponsebody.md
Normal file
40
docs/models/addplaylistcontentsresponsebody.md
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
# AddPlaylistContentsResponseBody
|
||||||
|
|
||||||
|
Playlist Updated
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AddPlaylistContentsResponseBody } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: AddPlaylistContentsResponseBody = {
|
||||||
|
mediaContainer: {
|
||||||
|
size: 1,
|
||||||
|
leafCountAdded: 1,
|
||||||
|
leafCountRequested: 1,
|
||||||
|
metadata: [
|
||||||
|
{
|
||||||
|
ratingKey: "94",
|
||||||
|
key: "/playlists/94/items",
|
||||||
|
guid: "com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2",
|
||||||
|
type: "playlist",
|
||||||
|
title: "A great playlist",
|
||||||
|
summary: "One of my great playlists",
|
||||||
|
smart: false,
|
||||||
|
playlistType: "video",
|
||||||
|
composite: "/playlists/94/composite/1705800070",
|
||||||
|
duration: 423000,
|
||||||
|
leafCount: 3,
|
||||||
|
addedAt: 1705716458,
|
||||||
|
updatedAt: 1705800070,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||||
|
| `mediaContainer` | [models.AddPlaylistContentsMediaContainer](../models/addplaylistcontentsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -1,5 +1,16 @@
|
|||||||
# ApplyUpdatesErrors
|
# ApplyUpdatesErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ApplyUpdatesErrors } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: ApplyUpdatesErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,9 +1,19 @@
|
|||||||
# ApplyUpdatesRequest
|
# ApplyUpdatesRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ApplyUpdatesRequest, Skip, Tonight } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: ApplyUpdatesRequest = {
|
||||||
|
tonight: Tonight.One,
|
||||||
|
skip: Skip.One,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `tonight` | [operations.Tonight](../../models/operations/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 |
|
| `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` | [operations.Skip](../../models/operations/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`. |
|
| `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,5 +1,18 @@
|
|||||||
# ApplyUpdatesResponse
|
# ApplyUpdatesResponse
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ApplyUpdatesResponse } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: ApplyUpdatesResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 138183,
|
||||||
|
rawResponse: new Response('{"message": "hello world"}', {
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
18
docs/models/applyupdatesresponsebody.md
Normal file
18
docs/models/applyupdatesresponsebody.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# ApplyUpdatesResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ApplyUpdatesResponseBody } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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 |
|
||||||
19
docs/models/billing.md
Normal file
19
docs/models/billing.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# Billing
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Billing } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: Billing = {
|
||||||
|
internalPaymentMethod: {},
|
||||||
|
paymentMethodId: 368725,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||||
|
| `internalPaymentMethod` | [models.InternalPaymentMethod](../models/internalpaymentmethod.md) | :heavy_check_mark: | N/A |
|
||||||
|
| `paymentMethodId` | *number* | :heavy_check_mark: | N/A |
|
||||||
@@ -1,5 +1,17 @@
|
|||||||
# ButlerTask
|
# ButlerTask
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ButlerTask } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: ButlerTask = {
|
||||||
|
name: "BackupDatabase",
|
||||||
|
interval: 3,
|
||||||
|
title: "Backup Database",
|
||||||
|
description: "Create a backup copy of the server's database in the configured backup directory",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
25
docs/models/butlertasks.md
Normal file
25
docs/models/butlertasks.md
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
# ButlerTasks
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ButlerTasks } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: ButlerTasks = {
|
||||||
|
butlerTask: [
|
||||||
|
{
|
||||||
|
name: "BackupDatabase",
|
||||||
|
interval: 3,
|
||||||
|
title: "Backup Database",
|
||||||
|
description:
|
||||||
|
"Create a backup copy of the server's database in the configured backup directory",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||||
|
| `butlerTask` | [models.ButlerTask](../models/butlertask.md)[] | :heavy_minus_sign: | N/A |
|
||||||
@@ -1,5 +1,16 @@
|
|||||||
# CancelServerActivitiesErrors
|
# CancelServerActivitiesErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CancelServerActivitiesErrors } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: CancelServerActivitiesErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
17
docs/models/cancelserveractivitiesrequest.md
Normal file
17
docs/models/cancelserveractivitiesrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# CancelServerActivitiesRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CancelServerActivitiesRequest } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: CancelServerActivitiesRequest = {
|
||||||
|
activityUUID: "25b71ed5-0f9d-461c-baa7-d404e9e10d3e",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||||
|
| `activityUUID` | *string* | :heavy_check_mark: | The UUID of the activity to cancel. | 25b71ed5-0f9d-461c-baa7-d404e9e10d3e |
|
||||||
@@ -1,5 +1,18 @@
|
|||||||
# CancelServerActivitiesResponse
|
# CancelServerActivitiesResponse
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CancelServerActivitiesResponse } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: CancelServerActivitiesResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 477665,
|
||||||
|
rawResponse: new Response('{"message": "hello world"}', {
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,11 +1,18 @@
|
|||||||
# GetServerIdentityResponseBody
|
# CancelServerActivitiesResponseBody
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CancelServerActivitiesResponseBody } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||||
| `errors` | [errors.GetServerIdentityErrors](../../models/errors/getserveridentityerrors.md)[] | :heavy_minus_sign: | N/A |
|
| `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 |
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,5 +1,16 @@
|
|||||||
# CheckForUpdatesErrors
|
# CheckForUpdatesErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CheckForUpdatesErrors } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: CheckForUpdatesErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
17
docs/models/checkforupdatesrequest.md
Normal file
17
docs/models/checkforupdatesrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# CheckForUpdatesRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CheckForUpdatesRequest, Download } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: CheckForUpdatesRequest = {
|
||||||
|
download: Download.One,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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,5 +1,18 @@
|
|||||||
# CheckForUpdatesResponse
|
# CheckForUpdatesResponse
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CheckForUpdatesResponse } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: CheckForUpdatesResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 317202,
|
||||||
|
rawResponse: new Response('{"message": "hello world"}', {
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,11 +1,18 @@
|
|||||||
# GetDevicesResponseBody
|
# CheckForUpdatesResponseBody
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CheckForUpdatesResponseBody } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||||
| `errors` | [errors.GetDevicesErrors](../../models/errors/getdeviceserrors.md)[] | :heavy_minus_sign: | N/A |
|
| `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 |
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,5 +1,16 @@
|
|||||||
# ClearPlaylistContentsErrors
|
# ClearPlaylistContentsErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ClearPlaylistContentsErrors } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: ClearPlaylistContentsErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,5 +1,14 @@
|
|||||||
# ClearPlaylistContentsRequest
|
# ClearPlaylistContentsRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: ClearPlaylistContentsRequest = {
|
||||||
|
playlistID: 6527.9,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,5 +1,18 @@
|
|||||||
# ClearPlaylistContentsResponse
|
# ClearPlaylistContentsResponse
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ClearPlaylistContentsResponse } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: ClearPlaylistContentsResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 208876,
|
||||||
|
rawResponse: new Response('{"message": "hello world"}', {
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,11 +1,18 @@
|
|||||||
# GetMyPlexAccountResponseBody
|
# ClearPlaylistContentsResponseBody
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ClearPlaylistContentsResponseBody } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||||
| `errors` | [errors.GetMyPlexAccountErrors](../../models/errors/getmyplexaccounterrors.md)[] | :heavy_minus_sign: | N/A |
|
| `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 |
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
21
docs/models/connections.md
Normal file
21
docs/models/connections.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# Connections
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Connections } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: Connections = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `protocol` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `address` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `port` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `uri` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `local` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `relay` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `iPv6` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
@@ -1,5 +1,12 @@
|
|||||||
# Context
|
# Context
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Context } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: Context = {};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,5 +1,14 @@
|
|||||||
# Country
|
# Country
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Country } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: Country = {
|
||||||
|
tag: "United States of America",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,5 +1,16 @@
|
|||||||
# CreatePlaylistErrors
|
# CreatePlaylistErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CreatePlaylistErrors } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: CreatePlaylistErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
38
docs/models/createplaylistmediacontainer.md
Normal file
38
docs/models/createplaylistmediacontainer.md
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
# CreatePlaylistMediaContainer
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CreatePlaylistMediaContainer } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: CreatePlaylistMediaContainer = {
|
||||||
|
size: 7,
|
||||||
|
metadata: [
|
||||||
|
{
|
||||||
|
ratingKey: "96",
|
||||||
|
key: "/playlists/96/items",
|
||||||
|
guid: "com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55",
|
||||||
|
type: "playlist",
|
||||||
|
title: "A Great Playlist",
|
||||||
|
summary: "What a great playlist",
|
||||||
|
smart: false,
|
||||||
|
playlistType: "video",
|
||||||
|
icon: "playlist://image.smart",
|
||||||
|
viewCount: 1,
|
||||||
|
lastViewedAt: 1705719589,
|
||||||
|
leafCount: 1,
|
||||||
|
addedAt: 1705719589,
|
||||||
|
updatedAt: 1705724593,
|
||||||
|
composite: "/playlists/96/composite/1705724593",
|
||||||
|
duration: 141000,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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,5 +1,29 @@
|
|||||||
# CreatePlaylistMetadata
|
# CreatePlaylistMetadata
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CreatePlaylistMetadata } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: CreatePlaylistMetadata = {
|
||||||
|
ratingKey: "96",
|
||||||
|
key: "/playlists/96/items",
|
||||||
|
guid: "com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55",
|
||||||
|
type: "playlist",
|
||||||
|
title: "A Great Playlist",
|
||||||
|
summary: "What a great playlist",
|
||||||
|
smart: false,
|
||||||
|
playlistType: "video",
|
||||||
|
icon: "playlist://image.smart",
|
||||||
|
viewCount: 1,
|
||||||
|
lastViewedAt: 1705719589,
|
||||||
|
leafCount: 1,
|
||||||
|
addedAt: 1705719589,
|
||||||
|
updatedAt: 1705724593,
|
||||||
|
composite: "/playlists/96/composite/1705724593",
|
||||||
|
duration: 141000,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
18
docs/models/createplaylistplaylistsresponsebody.md
Normal file
18
docs/models/createplaylistplaylistsresponsebody.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# CreatePlaylistPlaylistsResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CreatePlaylistPlaylistsResponseBody } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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 |
|
||||||
24
docs/models/createplaylistrequest.md
Normal file
24
docs/models/createplaylistrequest.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# CreatePlaylistRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CreatePlaylistRequest, QueryParamType, Smart } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: CreatePlaylistRequest = {
|
||||||
|
title: "<value>",
|
||||||
|
type: QueryParamType.Photo,
|
||||||
|
smart: Smart.One,
|
||||||
|
uri: "https://deadly-corsage.info",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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 |
|
||||||
49
docs/models/createplaylistresponse.md
Normal file
49
docs/models/createplaylistresponse.md
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
# CreatePlaylistResponse
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CreatePlaylistResponse } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: CreatePlaylistResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 128926,
|
||||||
|
rawResponse: new Response('{"message": "hello world"}', {
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
}),
|
||||||
|
object: {
|
||||||
|
mediaContainer: {
|
||||||
|
size: 7,
|
||||||
|
metadata: [
|
||||||
|
{
|
||||||
|
ratingKey: "96",
|
||||||
|
key: "/playlists/96/items",
|
||||||
|
guid: "com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55",
|
||||||
|
type: "playlist",
|
||||||
|
title: "A Great Playlist",
|
||||||
|
summary: "What a great playlist",
|
||||||
|
smart: false,
|
||||||
|
playlistType: "video",
|
||||||
|
icon: "playlist://image.smart",
|
||||||
|
viewCount: 1,
|
||||||
|
lastViewedAt: 1705719589,
|
||||||
|
leafCount: 1,
|
||||||
|
addedAt: 1705719589,
|
||||||
|
updatedAt: 1705724593,
|
||||||
|
composite: "/playlists/96/composite/1705724593",
|
||||||
|
duration: 141000,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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 |
|
||||||
41
docs/models/createplaylistresponsebody.md
Normal file
41
docs/models/createplaylistresponsebody.md
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
# CreatePlaylistResponseBody
|
||||||
|
|
||||||
|
returns all playlists
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CreatePlaylistResponseBody } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: CreatePlaylistResponseBody = {
|
||||||
|
mediaContainer: {
|
||||||
|
size: 7,
|
||||||
|
metadata: [
|
||||||
|
{
|
||||||
|
ratingKey: "96",
|
||||||
|
key: "/playlists/96/items",
|
||||||
|
guid: "com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55",
|
||||||
|
type: "playlist",
|
||||||
|
title: "A Great Playlist",
|
||||||
|
summary: "What a great playlist",
|
||||||
|
smart: false,
|
||||||
|
playlistType: "video",
|
||||||
|
icon: "playlist://image.smart",
|
||||||
|
viewCount: 1,
|
||||||
|
lastViewedAt: 1705719589,
|
||||||
|
leafCount: 1,
|
||||||
|
addedAt: 1705719589,
|
||||||
|
updatedAt: 1705724593,
|
||||||
|
composite: "/playlists/96/composite/1705724593",
|
||||||
|
duration: 141000,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||||
|
| `mediaContainer` | [models.CreatePlaylistMediaContainer](../models/createplaylistmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -1,5 +1,16 @@
|
|||||||
# DeleteLibraryErrors
|
# DeleteLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeleteLibraryErrors } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: DeleteLibraryErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,5 +1,14 @@
|
|||||||
# DeleteLibraryRequest
|
# DeleteLibraryRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeleteLibraryRequest } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: DeleteLibraryRequest = {
|
||||||
|
sectionId: 1000,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,5 +1,18 @@
|
|||||||
# DeleteLibraryResponse
|
# DeleteLibraryResponse
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeleteLibraryResponse } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: DeleteLibraryResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 736918,
|
||||||
|
rawResponse: new Response('{"message": "hello world"}', {
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
18
docs/models/deletelibraryresponsebody.md
Normal file
18
docs/models/deletelibraryresponsebody.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# DeleteLibraryResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeleteLibraryResponseBody } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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,5 +1,16 @@
|
|||||||
# DeletePlaylistErrors
|
# DeletePlaylistErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeletePlaylistErrors } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: DeletePlaylistErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,5 +1,14 @@
|
|||||||
# DeletePlaylistRequest
|
# DeletePlaylistRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeletePlaylistRequest } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: DeletePlaylistRequest = {
|
||||||
|
playlistID: 5701.97,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,5 +1,18 @@
|
|||||||
# DeletePlaylistResponse
|
# DeletePlaylistResponse
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeletePlaylistResponse } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: DeletePlaylistResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 38425,
|
||||||
|
rawResponse: new Response('{"message": "hello world"}', {
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,11 +1,18 @@
|
|||||||
# GetOnDeckResponseBody
|
# DeletePlaylistResponseBody
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeletePlaylistResponseBody } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||||
| `errors` | [errors.GetOnDeckErrors](../../models/errors/getondeckerrors.md)[] | :heavy_minus_sign: | N/A |
|
| `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 |
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,5 +1,17 @@
|
|||||||
# Device
|
# Device
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Device } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: Device = {
|
||||||
|
id: 1,
|
||||||
|
name: "iPhone",
|
||||||
|
platform: "iOS",
|
||||||
|
createdAt: 1654131230,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,5 +1,14 @@
|
|||||||
# Director
|
# Director
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Director } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: Director = {
|
||||||
|
tag: "Peyton Reed",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,5 +1,12 @@
|
|||||||
# Directory
|
# Directory
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Directory } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: Directory = {};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -2,6 +2,13 @@
|
|||||||
|
|
||||||
Indicate that you want to start download any updates found.
|
Indicate that you want to start download any updates found.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Download } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: Download = Download.One;
|
||||||
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
@@ -1,5 +1,16 @@
|
|||||||
# EnablePaperTrailErrors
|
# EnablePaperTrailErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { EnablePaperTrailErrors } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: EnablePaperTrailErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,5 +1,18 @@
|
|||||||
# EnablePaperTrailResponse
|
# EnablePaperTrailResponse
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { EnablePaperTrailResponse } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: EnablePaperTrailResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 99280,
|
||||||
|
rawResponse: new Response('{"message": "hello world"}', {
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,11 +1,18 @@
|
|||||||
# GetMetadataResponseBody
|
# EnablePaperTrailResponseBody
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { EnablePaperTrailResponseBody } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||||
| `errors` | [errors.GetMetadataErrors](../../models/errors/getmetadataerrors.md)[] | :heavy_minus_sign: | N/A |
|
| `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 |
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,5 +1,16 @@
|
|||||||
# Errors
|
# Errors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Errors } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
let value: Errors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# AddPlaylistContentsResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.AddPlaylistContentsErrors](../../models/errors/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,11 +0,0 @@
|
|||||||
# CancelServerActivitiesResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.CancelServerActivitiesErrors](../../models/errors/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,11 +0,0 @@
|
|||||||
# ClearPlaylistContentsResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
|
||||||
| `errors` | [errors.ClearPlaylistContentsErrors](../../models/errors/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,11 +0,0 @@
|
|||||||
# EnablePaperTrailResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.EnablePaperTrailErrors](../../models/errors/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,11 +0,0 @@
|
|||||||
# GetMetadataChildrenResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetMetadataChildrenErrors](../../models/errors/getmetadatachildrenerrors.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 @@
|
|||||||
# GetPlaylistContentsResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetPlaylistContentsErrors](../../models/errors/getplaylistcontentserrors.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 @@
|
|||||||
# GetRecentlyAddedResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetRecentlyAddedErrors](../../models/errors/getrecentlyaddederrors.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 @@
|
|||||||
# GetSearchResultsResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetSearchResultsErrors](../../models/errors/getsearchresultserrors.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 @@
|
|||||||
# GetServerActivitiesResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetServerActivitiesErrors](../../models/errors/getserveractivitieserrors.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 @@
|
|||||||
# GetServerListResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetServerListErrors](../../models/errors/getserverlisterrors.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 @@
|
|||||||
# GetServerPreferencesResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetServerPreferencesErrors](../../models/errors/getserverpreferenceserrors.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 @@
|
|||||||
# GetSourceConnectionInformationResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
|
||||||
| `errors` | [errors.GetSourceConnectionInformationErrors](../../models/errors/getsourceconnectioninformationerrors.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 @@
|
|||||||
# GetStatisticsResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetStatisticsErrors](../../models/errors/getstatisticserrors.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 @@
|
|||||||
# GetTimelineResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetTimelineErrors](../../models/errors/gettimelineerrors.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 @@
|
|||||||
# GetTokenErrors
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetTokenResponseBody
|
|
||||||
|
|
||||||
X-Plex-Client-Identifier is missing
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetTokenErrors](../../models/errors/gettokenerrors.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 @@
|
|||||||
# GetTranscodeSessionsResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetTranscodeSessionsErrors](../../models/errors/gettranscodesessionserrors.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 @@
|
|||||||
# MarkUnplayedResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
|
||||||
| `errors` | [errors.MarkUnplayedErrors](../../models/errors/markunplayederrors.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 @@
|
|||||||
# PerformSearchResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.PerformSearchErrors](../../models/errors/performsearcherrors.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 @@
|
|||||||
# RefreshLibraryResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.RefreshLibraryErrors](../../models/errors/refreshlibraryerrors.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 @@
|
|||||||
# StartAllTasksResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.StartAllTasksErrors](../../models/errors/startalltaskserrors.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 @@
|
|||||||
# StartUniversalTranscodeResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.StartUniversalTranscodeErrors](../../models/errors/startuniversaltranscodeerrors.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 @@
|
|||||||
# StopAllTasksResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
|
||||||
| `errors` | [errors.StopAllTasksErrors](../../models/errors/stopalltaskserrors.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 @@
|
|||||||
# StopTranscodeSessionResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.StopTranscodeSessionErrors](../../models/errors/stoptranscodesessionerrors.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 @@
|
|||||||
# UpdatePlaylistResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.UpdatePlaylistErrors](../../models/errors/updateplaylisterrors.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 @@
|
|||||||
# UpdatePlayProgressResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
|
||||||
| `errors` | [errors.UpdatePlayProgressErrors](../../models/errors/updateplayprogresserrors.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 |
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user