mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
Compare commits
13 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
03910be91f | ||
|
|
25ed9aa97d | ||
|
|
cf2cf981be | ||
|
|
de0bc5c344 | ||
|
|
c31a963aa6 | ||
|
|
faffbfd137 | ||
|
|
2853ce6b54 | ||
|
|
ed63eb13b9 | ||
|
|
442b11c11a | ||
|
|
c56a0f5d3c | ||
|
|
fe48f93ccb | ||
|
|
a7ec77cd04 | ||
|
|
2b38478255 |
32
.github/workflows/publish-jsr.yaml
vendored
32
.github/workflows/publish-jsr.yaml
vendored
@@ -1,32 +0,0 @@
|
|||||||
name: Publish to JSR
|
|
||||||
permissions:
|
|
||||||
checks: write
|
|
||||||
contents: write
|
|
||||||
pull-requests: write
|
|
||||||
statuses: write
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
registry_package:
|
|
||||||
types: [published]
|
|
||||||
|
|
||||||
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
|
|
||||||
28
.github/workflows/sdk_generation.yaml
vendored
28
.github/workflows/sdk_generation.yaml
vendored
@@ -1,10 +1,12 @@
|
|||||||
name: Generate
|
name: Generate and Publish to NPM and JSR
|
||||||
|
|
||||||
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:
|
||||||
@@ -16,6 +18,7 @@ permissions:
|
|||||||
type: string
|
type: string
|
||||||
schedule:
|
schedule:
|
||||||
- cron: 0 0 * * *
|
- cron: 0 0 * * *
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
generate:
|
generate:
|
||||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
||||||
@@ -28,3 +31,24 @@ jobs:
|
|||||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
npm_token: ${{ secrets.NPM_TOKEN }}
|
npm_token: ${{ secrets.NPM_TOKEN }}
|
||||||
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||||
|
|
||||||
|
publish:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
needs: generate
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
id-token: write
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Set up Node.js
|
||||||
|
uses: actions/setup-node@v5
|
||||||
|
with:
|
||||||
|
node-version: 20
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm install
|
||||||
|
|
||||||
|
- name: Publish package
|
||||||
|
run: npx jsr publish
|
||||||
|
|||||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -1,3 +1,7 @@
|
|||||||
|
/examples/node_modules
|
||||||
|
.env
|
||||||
|
.env.local
|
||||||
|
.env.*.local
|
||||||
.DS_Store
|
.DS_Store
|
||||||
**/.speakeasy/temp/
|
**/.speakeasy/temp/
|
||||||
**/.speakeasy/logs/
|
**/.speakeasy/logs/
|
||||||
|
|||||||
7825
.speakeasy/gen.lock
7825
.speakeasy/gen.lock
File diff suppressed because one or more lines are too long
@@ -4,26 +4,35 @@ generation:
|
|||||||
maintainOpenAPIOrder: true
|
maintainOpenAPIOrder: true
|
||||||
usageSnippets:
|
usageSnippets:
|
||||||
optionalPropertyRendering: withExample
|
optionalPropertyRendering: withExample
|
||||||
|
sdkInitStyle: constructor
|
||||||
useClassNamesForArrayFields: true
|
useClassNamesForArrayFields: true
|
||||||
fixes:
|
fixes:
|
||||||
nameResolutionDec2023: true
|
nameResolutionDec2023: true
|
||||||
nameResolutionFeb2025: false
|
nameResolutionFeb2025: true
|
||||||
parameterOrderingFeb2024: true
|
parameterOrderingFeb2024: true
|
||||||
requestResponseComponentNamesFeb2024: true
|
requestResponseComponentNamesFeb2024: true
|
||||||
securityFeb2025: false
|
securityFeb2025: true
|
||||||
sharedErrorComponentsApr2025: false
|
sharedErrorComponentsApr2025: true
|
||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
oAuth2PasswordEnabled: false
|
oAuth2PasswordEnabled: false
|
||||||
|
hoistGlobalSecurity: true
|
||||||
|
tests:
|
||||||
|
generateTests: true
|
||||||
|
generateNewTests: true
|
||||||
|
skipResponseBodyAssertions: false
|
||||||
typescript:
|
typescript:
|
||||||
version: 0.37.2
|
version: 0.42.1
|
||||||
|
acceptHeaderEnum: true
|
||||||
additionalDependencies:
|
additionalDependencies:
|
||||||
dependencies: {}
|
dependencies: {}
|
||||||
devDependencies: {}
|
devDependencies: {}
|
||||||
peerDependencies: {}
|
peerDependencies: {}
|
||||||
additionalPackageJSON: {}
|
additionalPackageJSON: {}
|
||||||
author: LukeHagar
|
author: LukeHagar
|
||||||
|
baseErrorName: PlexAPIError
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
|
constFieldsAlwaysOptional: true
|
||||||
defaultErrorName: SDKError
|
defaultErrorName: SDKError
|
||||||
enableCustomCodeRegions: false
|
enableCustomCodeRegions: false
|
||||||
enableMCPServer: true
|
enableMCPServer: true
|
||||||
@@ -31,6 +40,7 @@ typescript:
|
|||||||
enumFormat: enum
|
enumFormat: enum
|
||||||
flattenGlobalSecurity: true
|
flattenGlobalSecurity: true
|
||||||
flatteningOrder: body-first
|
flatteningOrder: body-first
|
||||||
|
generateExamples: true
|
||||||
imports:
|
imports:
|
||||||
option: openapi
|
option: openapi
|
||||||
paths:
|
paths:
|
||||||
@@ -43,9 +53,12 @@ typescript:
|
|||||||
jsonpath: legacy
|
jsonpath: legacy
|
||||||
maxMethodParams: 4
|
maxMethodParams: 4
|
||||||
methodArguments: require-security-and-request
|
methodArguments: require-security-and-request
|
||||||
|
modelPropertyCasing: camel
|
||||||
moduleFormat: commonjs
|
moduleFormat: commonjs
|
||||||
outputModelSuffix: output
|
outputModelSuffix: output
|
||||||
packageName: '@lukehagar/plexjs'
|
packageName: '@lukehagar/plexjs'
|
||||||
responseFormat: envelope
|
responseFormat: envelope
|
||||||
|
sseFlatResponse: false
|
||||||
templateVersion: v2
|
templateVersion: v2
|
||||||
|
usageSDKInitImports: []
|
||||||
useIndexModules: true
|
useIndexModules: true
|
||||||
|
|||||||
17629
.speakeasy/tests.arazzo.yaml
Normal file
17629
.speakeasy/tests.arazzo.yaml
Normal file
File diff suppressed because it is too large
Load Diff
@@ -1,4 +1,4 @@
|
|||||||
speakeasyVersion: 1.542.1
|
speakeasyVersion: 1.636.3
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
@@ -9,27 +9,27 @@ sources:
|
|||||||
- main
|
- main
|
||||||
plexapi:
|
plexapi:
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:37adc934a79841fb00cfe6ed569f5b1c88534b20202ecbde64b4e84828cee22a
|
sourceRevisionDigest: sha256:0e9f7ca03e6a970d7b77654ab41d0a1605f0105871db2630a7afc85d4362b624
|
||||||
sourceBlobDigest: sha256:ffb5b8d288111a763e4d035c8c9e37f5c89690d146b7297493b43a71d8298e6c
|
sourceBlobDigest: sha256:c0a6079f21e9d8cf8b3a205d2da333b78b2cb7e0db9dd895a41c68c2580e2d64
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- speakeasy-sdk-regen-1746403916
|
- speakeasy-sdk-regen-1760253962
|
||||||
- 0.0.3
|
- 1.1.1
|
||||||
targets:
|
targets:
|
||||||
plexjs:
|
plexjs:
|
||||||
source: plexapi
|
source: plexapi
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:37adc934a79841fb00cfe6ed569f5b1c88534b20202ecbde64b4e84828cee22a
|
sourceRevisionDigest: sha256:0e9f7ca03e6a970d7b77654ab41d0a1605f0105871db2630a7afc85d4362b624
|
||||||
sourceBlobDigest: sha256:ffb5b8d288111a763e4d035c8c9e37f5c89690d146b7297493b43a71d8298e6c
|
sourceBlobDigest: sha256:c0a6079f21e9d8cf8b3a205d2da333b78b2cb7e0db9dd895a41c68c2580e2d64
|
||||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||||
codeSamplesRevisionDigest: sha256:945657568eb11e06b45691a4a4a058c37170f5919329abbb42e23a5016781ba8
|
codeSamplesRevisionDigest: sha256:535bcf840dfe9a3ffe1ad738ce6cccb59da883cd2465bf03ee2abbf0bc163e68
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
sources:
|
sources:
|
||||||
plexapi:
|
plexapi:
|
||||||
inputs:
|
inputs:
|
||||||
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/output/plex-media-server-spec-dereferenced.yaml
|
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/plex-api-spec.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
|
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
|
||||||
targets:
|
targets:
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ speakeasyVersion: latest
|
|||||||
sources:
|
sources:
|
||||||
plexapi:
|
plexapi:
|
||||||
inputs:
|
inputs:
|
||||||
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/output/plex-media-server-spec-dereferenced.yaml
|
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/plex-api-spec.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
|
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
|
||||||
targets:
|
targets:
|
||||||
|
|||||||
75
FUNCTIONS.md
75
FUNCTIONS.md
@@ -20,39 +20,64 @@ specific category of applications.
|
|||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
|
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
|
||||||
import { serverGetServerCapabilities } from "@lukehagar/plexjs/funcs/serverGetServerCapabilities.js";
|
import { transcoderStartTranscodeSession } from "@lukehagar/plexjs/funcs/transcoderStartTranscodeSession.js";
|
||||||
import { SDKValidationError } from "@lukehagar/plexjs/sdk/models/errors/sdkvalidationerror.js";
|
import { Extension, StartTranscodeSessionLocation, StartTranscodeSessionProtocol } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
import { Accepts, AdvancedSubtitles, BoolInt, TranscodeType } from "@lukehagar/plexjs/sdk/models/shared";
|
||||||
|
|
||||||
// Use `PlexAPICore` for best tree-shaking performance.
|
// Use `PlexAPICore` for best tree-shaking performance.
|
||||||
// You can create one instance of it to use across an application.
|
// You can create one instance of it to use across an application.
|
||||||
const plexAPI = new PlexAPICore({
|
const plexAPI = new PlexAPICore({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accepts: Accepts.ApplicationXml,
|
||||||
|
clientIdentifier: "abc123",
|
||||||
|
product: "Plex for Roku",
|
||||||
|
version: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
platformVersion: "4.3 build 1057",
|
||||||
|
device: "Roku 3",
|
||||||
|
model: "4200X",
|
||||||
|
deviceVendor: "Roku",
|
||||||
|
deviceName: "Living Room TV",
|
||||||
|
marketplace: "googlePlay",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const res = await serverGetServerCapabilities(plexAPI);
|
const res = await transcoderStartTranscodeSession(plexAPI, {
|
||||||
|
transcodeType: TranscodeType.Music,
|
||||||
switch (true) {
|
extension: Extension.Mpd,
|
||||||
case res.ok:
|
advancedSubtitles: AdvancedSubtitles.Burn,
|
||||||
// The success case will be handled outside of the switch block
|
audioBoost: 50,
|
||||||
break;
|
audioChannelCount: 5,
|
||||||
case res.error instanceof SDKValidationError:
|
autoAdjustQuality: BoolInt.One,
|
||||||
// Pretty-print validation errors.
|
autoAdjustSubtitle: BoolInt.One,
|
||||||
return console.log(res.error.pretty());
|
directPlay: BoolInt.One,
|
||||||
case res.error instanceof Error:
|
directStream: BoolInt.One,
|
||||||
return console.log(res.error);
|
directStreamAudio: BoolInt.One,
|
||||||
default:
|
disableResolutionRotation: BoolInt.One,
|
||||||
// TypeScript's type checking will fail on the following line if the above
|
hasMDE: BoolInt.One,
|
||||||
// cases were not exhaustive.
|
location: StartTranscodeSessionLocation.Wan,
|
||||||
res.error satisfies never;
|
mediaBufferSize: 102400,
|
||||||
throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
|
mediaIndex: 0,
|
||||||
|
musicBitrate: 5000,
|
||||||
|
offset: 90.5,
|
||||||
|
partIndex: 0,
|
||||||
|
path: "/library/metadata/151671",
|
||||||
|
peakBitrate: 12000,
|
||||||
|
photoResolution: "1080x1080",
|
||||||
|
protocol: StartTranscodeSessionProtocol.Dash,
|
||||||
|
secondsPerSegment: 5,
|
||||||
|
subtitleSize: 50,
|
||||||
|
videoBitrate: 12000,
|
||||||
|
videoQuality: 50,
|
||||||
|
videoResolution: "1080x1080",
|
||||||
|
xPlexClientProfileExtra: "add-limitation(scope=videoCodec&scopeName=*&type=upperBound&name=video.frameRate&value=60&replace=true)+append-transcode-target-codec(type=videoProfile&context=streaming&videoCodec=h264%2Chevc&audioCodec=aac&protocol=dash)",
|
||||||
|
xPlexClientProfileName: "generic",
|
||||||
|
});
|
||||||
|
if (res.ok) {
|
||||||
|
const { value: result } = res;
|
||||||
|
console.log(result);
|
||||||
|
} else {
|
||||||
|
console.log("transcoderStartTranscodeSession failed:", res.error);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
const { value: result } = res;
|
|
||||||
|
|
||||||
// Handle the result
|
|
||||||
console.log(result);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
run();
|
run();
|
||||||
|
|||||||
92
RELEASES.md
92
RELEASES.md
@@ -1338,4 +1338,94 @@ Based on:
|
|||||||
### Generated
|
### Generated
|
||||||
- [typescript v0.37.2] .
|
- [typescript v0.37.2] .
|
||||||
### Releases
|
### Releases
|
||||||
- [NPM v0.37.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.37.2 - .
|
- [NPM v0.37.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.37.2 - .
|
||||||
|
|
||||||
|
## 2025-06-04 00:11:21
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.555.2 (2.620.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.38.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.38.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.38.0 - .
|
||||||
|
|
||||||
|
## 2025-06-09 00:12:06
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.557.0 (2.623.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.39.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.39.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.39.0 - .
|
||||||
|
|
||||||
|
## 2025-07-10 00:11:39
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.580.1 (2.656.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.40.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.40.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.40.0 - .
|
||||||
|
|
||||||
|
## 2025-08-06 00:12:14
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.598.0 (2.674.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.40.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.40.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.40.1 - .
|
||||||
|
|
||||||
|
## 2025-08-07 00:12:28
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.598.3 (2.674.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.40.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.40.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.40.2 - .
|
||||||
|
|
||||||
|
## 2025-09-15 00:11:38
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.615.2 (2.698.4) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.40.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.40.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.40.3 - .
|
||||||
|
|
||||||
|
## 2025-10-12 05:24:41
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.636.3 (2.723.11) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.41.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.41.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.41.0 - .
|
||||||
|
|
||||||
|
## 2025-10-12 05:51:28
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.636.3 (2.723.11) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.42.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.42.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.42.0 - .
|
||||||
|
|
||||||
|
## 2025-10-12 07:25:38
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.636.3 (2.723.11) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.42.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.42.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.42.1 - .
|
||||||
12
RUNTIMES.md
12
RUNTIMES.md
@@ -2,9 +2,9 @@
|
|||||||
|
|
||||||
This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
|
This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
|
||||||
|
|
||||||
* [Web Fetch API][web-fetch]
|
- [Web Fetch API][web-fetch]
|
||||||
* [Web Streams API][web-streams] and in particular `ReadableStream`
|
- [Web Streams API][web-streams] and in particular `ReadableStream`
|
||||||
* [Async iterables][async-iter] using `Symbol.asyncIterator`
|
- [Async iterables][async-iter] using `Symbol.asyncIterator`
|
||||||
|
|
||||||
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
|
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
|
||||||
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
|
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
|
||||||
@@ -25,7 +25,7 @@ Runtime environments that are explicitly supported are:
|
|||||||
|
|
||||||
The following `tsconfig.json` options are recommended for projects using this
|
The following `tsconfig.json` options are recommended for projects using this
|
||||||
SDK in order to get static type support for features like async iterables,
|
SDK in order to get static type support for features like async iterables,
|
||||||
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
|
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
|
||||||
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
|
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
|
||||||
so on):
|
so on):
|
||||||
|
|
||||||
@@ -38,11 +38,11 @@ so on):
|
|||||||
{
|
{
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"target": "es2020", // or higher
|
"target": "es2020", // or higher
|
||||||
"lib": ["es2020", "dom", "dom.iterable"],
|
"lib": ["es2020", "dom", "dom.iterable"]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
While `target` can be set to older ECMAScript versions, it may result in extra,
|
While `target` can be set to older ECMAScript versions, it may result in extra,
|
||||||
unnecessary compatibility code being generated if you are not targeting old
|
unnecessary compatibility code being generated if you are not targeting old
|
||||||
runtimes.
|
runtimes.
|
||||||
|
|||||||
57
USAGE.md
57
USAGE.md
@@ -1,15 +1,66 @@
|
|||||||
<!-- Start SDK Example Usage [usage] -->
|
<!-- Start SDK Example Usage [usage] -->
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
import {
|
||||||
|
Extension,
|
||||||
|
StartTranscodeSessionLocation,
|
||||||
|
StartTranscodeSessionProtocol,
|
||||||
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
import {
|
||||||
|
Accepts,
|
||||||
|
AdvancedSubtitles,
|
||||||
|
BoolInt,
|
||||||
|
TranscodeType,
|
||||||
|
} from "@lukehagar/plexjs/sdk/models/shared";
|
||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accepts: Accepts.ApplicationXml,
|
||||||
|
clientIdentifier: "abc123",
|
||||||
|
product: "Plex for Roku",
|
||||||
|
version: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
platformVersion: "4.3 build 1057",
|
||||||
|
device: "Roku 3",
|
||||||
|
model: "4200X",
|
||||||
|
deviceVendor: "Roku",
|
||||||
|
deviceName: "Living Room TV",
|
||||||
|
marketplace: "googlePlay",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.server.getServerCapabilities();
|
const result = await plexAPI.transcoder.startTranscodeSession({
|
||||||
|
transcodeType: TranscodeType.Music,
|
||||||
|
extension: Extension.Mpd,
|
||||||
|
advancedSubtitles: AdvancedSubtitles.Burn,
|
||||||
|
audioBoost: 50,
|
||||||
|
audioChannelCount: 5,
|
||||||
|
autoAdjustQuality: BoolInt.One,
|
||||||
|
autoAdjustSubtitle: BoolInt.One,
|
||||||
|
directPlay: BoolInt.One,
|
||||||
|
directStream: BoolInt.One,
|
||||||
|
directStreamAudio: BoolInt.One,
|
||||||
|
disableResolutionRotation: BoolInt.One,
|
||||||
|
hasMDE: BoolInt.One,
|
||||||
|
location: StartTranscodeSessionLocation.Wan,
|
||||||
|
mediaBufferSize: 102400,
|
||||||
|
mediaIndex: 0,
|
||||||
|
musicBitrate: 5000,
|
||||||
|
offset: 90.5,
|
||||||
|
partIndex: 0,
|
||||||
|
path: "/library/metadata/151671",
|
||||||
|
peakBitrate: 12000,
|
||||||
|
photoResolution: "1080x1080",
|
||||||
|
protocol: StartTranscodeSessionProtocol.Dash,
|
||||||
|
secondsPerSegment: 5,
|
||||||
|
subtitleSize: 50,
|
||||||
|
videoBitrate: 12000,
|
||||||
|
videoQuality: 50,
|
||||||
|
videoResolution: "1080x1080",
|
||||||
|
xPlexClientProfileExtra:
|
||||||
|
"add-limitation(scope=videoCodec&scopeName=*&type=upperBound&name=video.frameRate&value=60&replace=true)+append-transcode-target-codec(type=videoProfile&context=streaming&videoCodec=h264%2Chevc&audioCodec=aac&protocol=dash)",
|
||||||
|
xPlexClientProfileName: "generic",
|
||||||
|
});
|
||||||
|
|
||||||
// Handle the result
|
|
||||||
console.log(result);
|
console.log(result);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
7461
codeSamples.yaml
7461
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
@@ -1,18 +0,0 @@
|
|||||||
# AddPlaylistContentsBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { AddPlaylistContentsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.AddPlaylistContentsErrors](../../../sdk/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,21 +0,0 @@
|
|||||||
# AddPlaylistContentsErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { AddPlaylistContentsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: AddPlaylistContentsErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,21 +0,0 @@
|
|||||||
# AddPlaylistContentsPlaylistsErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { AddPlaylistContentsPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: AddPlaylistContentsPlaylistsErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# AddPlaylistContentsUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { AddPlaylistContentsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.AddPlaylistContentsPlaylistsErrors](../../../sdk/models/errors/addplaylistcontentsplaylistserrors.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,18 +0,0 @@
|
|||||||
# ApplyUpdatesBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { ApplyUpdatesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.ApplyUpdatesErrors](../../../sdk/models/errors/applyupdateserrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
# ApplyUpdatesErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { ApplyUpdatesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: ApplyUpdatesErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,18 +0,0 @@
|
|||||||
# ApplyUpdatesUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { ApplyUpdatesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.ApplyUpdatesUpdaterErrors](../../../sdk/models/errors/applyupdatesupdatererrors.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,21 +0,0 @@
|
|||||||
# ApplyUpdatesUpdaterErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { ApplyUpdatesUpdaterErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: ApplyUpdatesUpdaterErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
# CancelServerActivitiesActivitiesErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { CancelServerActivitiesActivitiesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: CancelServerActivitiesActivitiesErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# CancelServerActivitiesBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { CancelServerActivitiesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.CancelServerActivitiesErrors](../../../sdk/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,21 +0,0 @@
|
|||||||
# CancelServerActivitiesErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { CancelServerActivitiesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: CancelServerActivitiesErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,18 +0,0 @@
|
|||||||
# CancelServerActivitiesUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { CancelServerActivitiesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.CancelServerActivitiesActivitiesErrors](../../../sdk/models/errors/cancelserveractivitiesactivitieserrors.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,18 +0,0 @@
|
|||||||
# CheckForUpdatesBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { CheckForUpdatesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.CheckForUpdatesErrors](../../../sdk/models/errors/checkforupdateserrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
# CheckForUpdatesErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { CheckForUpdatesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: CheckForUpdatesErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,18 +0,0 @@
|
|||||||
# CheckForUpdatesUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { CheckForUpdatesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.CheckForUpdatesUpdaterErrors](../../../sdk/models/errors/checkforupdatesupdatererrors.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,21 +0,0 @@
|
|||||||
# CheckForUpdatesUpdaterErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { CheckForUpdatesUpdaterErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: CheckForUpdatesUpdaterErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# ClearPlaylistContentsBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { ClearPlaylistContentsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.ClearPlaylistContentsErrors](../../../sdk/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,21 +0,0 @@
|
|||||||
# ClearPlaylistContentsErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { ClearPlaylistContentsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: ClearPlaylistContentsErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,21 +0,0 @@
|
|||||||
# ClearPlaylistContentsPlaylistsErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { ClearPlaylistContentsPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: ClearPlaylistContentsPlaylistsErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# ClearPlaylistContentsUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { ClearPlaylistContentsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.ClearPlaylistContentsPlaylistsErrors](../../../sdk/models/errors/clearplaylistcontentsplaylistserrors.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,18 +0,0 @@
|
|||||||
# CreatePlaylistBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { CreatePlaylistBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.CreatePlaylistErrors](../../../sdk/models/errors/createplaylisterrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
# CreatePlaylistErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { CreatePlaylistErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: CreatePlaylistErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,21 +0,0 @@
|
|||||||
# CreatePlaylistPlaylistsErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { CreatePlaylistPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: CreatePlaylistPlaylistsErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# CreatePlaylistUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { CreatePlaylistUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.CreatePlaylistPlaylistsErrors](../../../sdk/models/errors/createplaylistplaylistserrors.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,18 +0,0 @@
|
|||||||
# DeleteLibraryBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { DeleteLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.DeleteLibraryErrors](../../../sdk/models/errors/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,21 +0,0 @@
|
|||||||
# DeleteLibraryErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { DeleteLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: DeleteLibraryErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,21 +0,0 @@
|
|||||||
# DeleteLibraryLibraryErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { DeleteLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: DeleteLibraryLibraryErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# DeleteLibraryUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { DeleteLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.DeleteLibraryLibraryErrors](../../../sdk/models/errors/deletelibrarylibraryerrors.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,18 +0,0 @@
|
|||||||
# DeletePlaylistBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { DeletePlaylistBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.DeletePlaylistErrors](../../../sdk/models/errors/deleteplaylisterrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
# DeletePlaylistErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { DeletePlaylistErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: DeletePlaylistErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,21 +0,0 @@
|
|||||||
# DeletePlaylistPlaylistsErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { DeletePlaylistPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: DeletePlaylistPlaylistsErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# DeletePlaylistUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { DeletePlaylistUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.DeletePlaylistPlaylistsErrors](../../../sdk/models/errors/deleteplaylistplaylistserrors.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,18 +0,0 @@
|
|||||||
# EnablePaperTrailBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { EnablePaperTrailBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.EnablePaperTrailErrors](../../../sdk/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,21 +0,0 @@
|
|||||||
# EnablePaperTrailErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { EnablePaperTrailErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: EnablePaperTrailErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,21 +0,0 @@
|
|||||||
# EnablePaperTrailLogErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { EnablePaperTrailLogErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: EnablePaperTrailLogErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# EnablePaperTrailUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { EnablePaperTrailUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.EnablePaperTrailLogErrors](../../../sdk/models/errors/enablepapertraillogerrors.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,21 +0,0 @@
|
|||||||
# Errors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { Errors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: Errors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,18 +0,0 @@
|
|||||||
# GetActorsLibraryBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetActorsLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetActorsLibraryErrors](../../../sdk/models/errors/getactorslibraryerrors.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,21 +0,0 @@
|
|||||||
# GetActorsLibraryErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetActorsLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetActorsLibraryErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,21 +0,0 @@
|
|||||||
# GetActorsLibraryLibraryErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetActorsLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetActorsLibraryLibraryErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# GetActorsLibraryUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetActorsLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetActorsLibraryLibraryErrors](../../../sdk/models/errors/getactorslibrarylibraryerrors.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,18 +0,0 @@
|
|||||||
# GetAllLibrariesBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetAllLibrariesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetAllLibrariesErrors](../../../sdk/models/errors/getalllibrarieserrors.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,21 +0,0 @@
|
|||||||
# GetAllLibrariesErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetAllLibrariesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetAllLibrariesErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,21 +0,0 @@
|
|||||||
# GetAllLibrariesLibraryErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetAllLibrariesLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetAllLibrariesLibraryErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# GetAllLibrariesUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetAllLibrariesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetAllLibrariesLibraryErrors](../../../sdk/models/errors/getalllibrarieslibraryerrors.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,18 +0,0 @@
|
|||||||
# GetAllMediaLibraryBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetAllMediaLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetAllMediaLibraryErrors](../../../sdk/models/errors/getallmedialibraryerrors.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,21 +0,0 @@
|
|||||||
# GetAllMediaLibraryErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetAllMediaLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetAllMediaLibraryErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,21 +0,0 @@
|
|||||||
# GetAllMediaLibraryLibraryErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetAllMediaLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetAllMediaLibraryLibraryErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# GetAllMediaLibraryUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetAllMediaLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetAllMediaLibraryLibraryErrors](../../../sdk/models/errors/getallmedialibrarylibraryerrors.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,18 +0,0 @@
|
|||||||
# GetAvailableClientsBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetAvailableClientsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetAvailableClientsErrors](../../../sdk/models/errors/getavailableclientserrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
# GetAvailableClientsErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetAvailableClientsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetAvailableClientsErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,21 +0,0 @@
|
|||||||
# GetAvailableClientsServerErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetAvailableClientsServerErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetAvailableClientsServerErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# GetAvailableClientsUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetAvailableClientsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetAvailableClientsServerErrors](../../../sdk/models/errors/getavailableclientsservererrors.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,18 +0,0 @@
|
|||||||
# GetBandwidthStatisticsBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetBandwidthStatisticsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetBandwidthStatisticsErrors](../../../sdk/models/errors/getbandwidthstatisticserrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
# GetBandwidthStatisticsErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetBandwidthStatisticsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetBandwidthStatisticsErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,21 +0,0 @@
|
|||||||
# GetBandwidthStatisticsStatisticsErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetBandwidthStatisticsStatisticsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetBandwidthStatisticsStatisticsErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# GetBandwidthStatisticsUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetBandwidthStatisticsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetBandwidthStatisticsStatisticsErrors](../../../sdk/models/errors/getbandwidthstatisticsstatisticserrors.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,18 +0,0 @@
|
|||||||
# GetBannerImageBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetBannerImageBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetBannerImageErrors](../../../sdk/models/errors/getbannerimageerrors.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,21 +0,0 @@
|
|||||||
# GetBannerImageErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetBannerImageErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetBannerImageErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,21 +0,0 @@
|
|||||||
# GetBannerImageMediaErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetBannerImageMediaErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetBannerImageMediaErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# GetBannerImageUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetBannerImageUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetBannerImageMediaErrors](../../../sdk/models/errors/getbannerimagemediaerrors.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,18 +0,0 @@
|
|||||||
# GetButlerTasksBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetButlerTasksBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetButlerTasksErrors](../../../sdk/models/errors/getbutlertaskserrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
# GetButlerTasksButlerErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetButlerTasksButlerErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetButlerTasksButlerErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
# GetButlerTasksErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetButlerTasksErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetButlerTasksErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,18 +0,0 @@
|
|||||||
# GetButlerTasksUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetButlerTasksUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetButlerTasksButlerErrors](../../../sdk/models/errors/getbutlertasksbutlererrors.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,18 +0,0 @@
|
|||||||
# GetCompanionsDataBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetCompanionsDataBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetCompanionsDataErrors](../../../sdk/models/errors/getcompanionsdataerrors.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,21 +0,0 @@
|
|||||||
# GetCompanionsDataErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetCompanionsDataErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetCompanionsDataErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,21 +0,0 @@
|
|||||||
# GetCompanionsDataPlexErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetCompanionsDataPlexErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetCompanionsDataPlexErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# GetCompanionsDataUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetCompanionsDataUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetCompanionsDataPlexErrors](../../../sdk/models/errors/getcompanionsdataplexerrors.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,18 +0,0 @@
|
|||||||
# GetCountriesLibraryBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetCountriesLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetCountriesLibraryErrors](../../../sdk/models/errors/getcountrieslibraryerrors.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,21 +0,0 @@
|
|||||||
# GetCountriesLibraryErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetCountriesLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetCountriesLibraryErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,21 +0,0 @@
|
|||||||
# GetCountriesLibraryLibraryErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetCountriesLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetCountriesLibraryLibraryErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# GetCountriesLibraryUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetCountriesLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetCountriesLibraryLibraryErrors](../../../sdk/models/errors/getcountrieslibrarylibraryerrors.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,18 +0,0 @@
|
|||||||
# GetDevicesBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetDevicesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetDevicesErrors](../../../sdk/models/errors/getdeviceserrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
# GetDevicesErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetDevicesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetDevicesErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,21 +0,0 @@
|
|||||||
# GetDevicesServerErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetDevicesServerErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetDevicesServerErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# GetDevicesUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetDevicesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetDevicesServerErrors](../../../sdk/models/errors/getdevicesservererrors.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,18 +0,0 @@
|
|||||||
# GetFileHashBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetFileHashBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetFileHashErrors](../../../sdk/models/errors/getfilehasherrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
# GetFileHashErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetFileHashErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetFileHashErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,21 +0,0 @@
|
|||||||
# GetFileHashLibraryErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetFileHashLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetFileHashLibraryErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# GetFileHashUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetFileHashUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetFileHashLibraryErrors](../../../sdk/models/errors/getfilehashlibraryerrors.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,18 +0,0 @@
|
|||||||
# GetGenresLibraryBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetGenresLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetGenresLibraryErrors](../../../sdk/models/errors/getgenreslibraryerrors.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,21 +0,0 @@
|
|||||||
# GetGenresLibraryErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetGenresLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetGenresLibraryErrors = {
|
|
||||||
code: 1000,
|
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
|
||||||
status: 400,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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,21 +0,0 @@
|
|||||||
# GetGenresLibraryLibraryErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetGenresLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetGenresLibraryLibraryErrors = {
|
|
||||||
code: 1001,
|
|
||||||
message: "User could not be authenticated",
|
|
||||||
status: 401,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# GetGenresLibraryUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetGenresLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetGenresLibraryLibraryErrors](../../../sdk/models/errors/getgenreslibrarylibraryerrors.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,18 +0,0 @@
|
|||||||
# GetGeoDataBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetGeoDataBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetGeoDataErrors](../../../sdk/models/errors/getgeodataerrors.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