mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
Compare commits
206 Commits
liblab-cod
...
v0.36.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2712820397 | ||
|
|
c895213ae8 | ||
|
|
c473c9d326 | ||
|
|
3c13bba9de | ||
|
|
650c5043ef | ||
|
|
0234804578 | ||
|
|
60d913c8f9 | ||
|
|
8d9f4bbaf1 | ||
|
|
5d57cd7c34 | ||
|
|
1a8e227874 | ||
|
|
8360d057ab | ||
|
|
18b64727c3 | ||
|
|
3152372037 | ||
|
|
13cd8a7fe5 | ||
|
|
cdcdc0ca8e | ||
|
|
b03cc6a609 | ||
|
|
4e989e0de3 | ||
|
|
c10e011a68 | ||
|
|
7e3dca8466 | ||
|
|
8a2d3e04ab | ||
|
|
6c8a73ae84 | ||
|
|
c839d9f6c7 | ||
|
|
77b0ef9507 | ||
|
|
1cfbd17f28 | ||
|
|
2492807c65 | ||
|
|
ead0a8773c | ||
|
|
e254f82e06 | ||
|
|
a4369c999a | ||
|
|
c50b85f29a | ||
|
|
496ebda695 | ||
|
|
d436fc3452 | ||
|
|
99cdf6effe | ||
|
|
fa2ba82f62 | ||
|
|
fd8095a8df | ||
|
|
9911164ab0 | ||
|
|
ffedf47cad | ||
|
|
39d3a40524 | ||
|
|
8dc802ca50 | ||
|
|
5465f1e74c | ||
|
|
2d100b8e75 | ||
|
|
0533836427 | ||
|
|
f0b08b9bd9 | ||
|
|
244adab882 | ||
|
|
4d8ee6c199 | ||
|
|
4fe1356250 | ||
|
|
454b20d045 | ||
|
|
8c39ddc475 | ||
|
|
dca338d40f | ||
|
|
06e59965bd | ||
|
|
0be9307f80 | ||
|
|
25dcf36b37 | ||
|
|
63f13fd266 | ||
|
|
f21eae30b1 | ||
|
|
eb75f8d060 | ||
|
|
5e8618aa6f | ||
|
|
335ccf134f | ||
|
|
9bcd82719e | ||
|
|
58005d93e9 | ||
|
|
a366d87e75 | ||
|
|
d1f30a9f2c | ||
|
|
087db87584 | ||
|
|
7406efba26 | ||
|
|
b48aa356a7 | ||
|
|
f918b86b8c | ||
|
|
d241fca800 | ||
|
|
dafab7ed9d | ||
|
|
18817ccbc0 | ||
|
|
241fc555f6 | ||
|
|
60385aec49 | ||
|
|
502660742d | ||
|
|
796edd7174 | ||
|
|
738f7c347d | ||
|
|
5a3c016a7f | ||
|
|
bb1b355abf | ||
|
|
78522ed5bf | ||
|
|
8a524cf9e6 | ||
|
|
7e8aef026b | ||
|
|
886f24cade | ||
|
|
9c33aaa04f | ||
|
|
fc2f619cff | ||
|
|
2344b8fb5e | ||
|
|
2d0e878983 | ||
|
|
a96e359e00 | ||
|
|
d616464526 | ||
|
|
933b3708db | ||
|
|
ddc4f916f2 | ||
|
|
e418c55013 | ||
|
|
b593c2c54b | ||
|
|
a449d25ac4 | ||
|
|
6af375d524 | ||
|
|
fc838e8ebf | ||
|
|
162b3b3d13 | ||
|
|
3dff2b9225 | ||
|
|
d6d9c46f51 | ||
|
|
f79b24ee0e | ||
|
|
78c540ebf4 | ||
|
|
3fc9856c81 | ||
|
|
bc1fa68557 | ||
|
|
182d88f7f1 | ||
|
|
300cbb21cd | ||
|
|
53f3bfd615 | ||
|
|
92b22220f1 | ||
|
|
a42f887042 | ||
|
|
8b9c5c6e41 | ||
|
|
eab41f5f41 | ||
|
|
e038f1fdcf | ||
|
|
835f4244ec | ||
|
|
287c5cb9ad | ||
|
|
521174faf5 | ||
|
|
6fe948fa1e | ||
|
|
4abb238f51 | ||
|
|
c10b6af7de | ||
|
|
6bec4430ff | ||
|
|
3fe4aee2ea | ||
|
|
5b4a51bee7 | ||
|
|
b0cc884d46 | ||
|
|
a1dc07ae78 | ||
|
|
d100297e1d | ||
|
|
14f7d530ec | ||
|
|
622219b018 | ||
|
|
c4dd496e24 | ||
|
|
cdda7f840f | ||
|
|
2c04752d88 | ||
|
|
242d7d78f2 | ||
|
|
779aa2dc9e | ||
|
|
0d73a769fb | ||
|
|
eeadc8c329 | ||
|
|
dbe2e37bba | ||
|
|
6c314bea48 | ||
|
|
9e28d57f15 | ||
|
|
9da9389549 | ||
|
|
fd886229c2 | ||
|
|
8a8615f241 | ||
|
|
29b8ad88d9 | ||
|
|
fd13b3d892 | ||
|
|
fc0ebfe782 | ||
|
|
9503c9033d | ||
|
|
1c5fa25562 | ||
|
|
3020866795 | ||
|
|
b0f89ba7d4 | ||
|
|
d7d14f28e8 | ||
|
|
e3e80f1dd8 | ||
|
|
4819145e93 | ||
|
|
23c20be9e3 | ||
|
|
2c76c6640a | ||
|
|
4332937cdc | ||
|
|
17d56a96d6 | ||
|
|
1d4f25475d | ||
|
|
a1f6c6f515 | ||
|
|
022d345196 | ||
|
|
6cec42bef1 | ||
|
|
eaa84306f6 | ||
|
|
45ee7680a7 | ||
|
|
8668cc2ca6 | ||
|
|
9fb5c21c03 | ||
|
|
e9cfd11a9c | ||
|
|
7543285c95 | ||
|
|
fa999ea454 | ||
|
|
b562d2a68e | ||
|
|
09060624f9 | ||
|
|
a6620dfce9 | ||
|
|
100d1e093b | ||
|
|
ff9f3dc489 | ||
|
|
b9629abe33 | ||
|
|
f306faa1ff | ||
|
|
e5abca0f3c | ||
|
|
78acc1880a | ||
|
|
a31aae3cd8 | ||
|
|
bc64130459 | ||
|
|
b553c6204c | ||
|
|
9b02d27d5e | ||
|
|
f200bc563f | ||
|
|
5c4b98300b | ||
|
|
1e46343716 | ||
|
|
c34f35ba3d | ||
|
|
b77c4d818f | ||
|
|
ea6e427d7b | ||
|
|
4ed36cd1a2 | ||
|
|
1b0b5c218c | ||
|
|
e92eb2ba92 | ||
|
|
02c32497a7 | ||
|
|
312e0ecc12 | ||
|
|
fa815de1ba | ||
|
|
1bb02c1f94 | ||
|
|
142cc517be | ||
|
|
b1e60ce405 | ||
|
|
a4b62177c6 | ||
|
|
44dc94ca33 | ||
|
|
f5b88fc34b | ||
|
|
058ae4b07a | ||
|
|
1d3fc77b50 | ||
|
|
d725039636 | ||
|
|
1b6e3c7539 | ||
|
|
514ca98c19 | ||
|
|
65d485477d | ||
|
|
47ed721c66 | ||
|
|
3fa96ba701 | ||
|
|
6a98b22eb9 | ||
|
|
cedd748d27 | ||
|
|
1c08bcb10b | ||
|
|
c6ea30019e | ||
|
|
bace1e6304 | ||
|
|
ac331abdb4 | ||
|
|
73ffa5bff9 | ||
|
|
41e670542a | ||
|
|
db845112c4 |
@@ -1,12 +0,0 @@
|
|||||||
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
|
|
||||||
// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node
|
|
||||||
{
|
|
||||||
"name": "TypeScript SDK",
|
|
||||||
"image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bullseye",
|
|
||||||
"postCreateCommand": "cd examples && npm run setup",
|
|
||||||
"customizations": {
|
|
||||||
"codespaces":{
|
|
||||||
"openFiles": ["examples/src/index.ts", "README.md"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,50 +0,0 @@
|
|||||||
{
|
|
||||||
"env": {
|
|
||||||
"browser": true,
|
|
||||||
"commonjs": true,
|
|
||||||
"es2021": true
|
|
||||||
},
|
|
||||||
"extends": [
|
|
||||||
"airbnb-base",
|
|
||||||
"airbnb-typescript/base",
|
|
||||||
"prettier"
|
|
||||||
],
|
|
||||||
"parser": "@typescript-eslint/parser",
|
|
||||||
"parserOptions": {
|
|
||||||
"ecmaVersion": "latest",
|
|
||||||
"sourceType": "module",
|
|
||||||
"project": "./tsconfig.eslint.json"
|
|
||||||
},
|
|
||||||
"plugins": [
|
|
||||||
"@typescript-eslint",
|
|
||||||
"prettier"
|
|
||||||
],
|
|
||||||
"rules": {
|
|
||||||
"no-console": "off",
|
|
||||||
"max-len": [
|
|
||||||
"error",
|
|
||||||
{
|
|
||||||
"code": 150,
|
|
||||||
"ignoreComments": true,
|
|
||||||
"ignoreRegExpLiterals": true,
|
|
||||||
"ignoreStrings": true,
|
|
||||||
"ignoreTemplateLiterals": true
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"prettier/prettier": "error",
|
|
||||||
"@typescript-eslint/dot-notation": "off",
|
|
||||||
"import/prefer-default-export": "off"
|
|
||||||
},
|
|
||||||
"settings": {
|
|
||||||
"import/resolver": {
|
|
||||||
"node": {
|
|
||||||
"extensions": [
|
|
||||||
".js",
|
|
||||||
".jsx",
|
|
||||||
".ts",
|
|
||||||
".tsx"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
2
.gitattributes
vendored
Normal file
2
.gitattributes
vendored
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
# This allows generated code to be indexed correctly
|
||||||
|
*.ts linguist-generated=false
|
||||||
35
.github/workflows/build-checks.yml
vendored
35
.github/workflows/build-checks.yml
vendored
@@ -1,35 +0,0 @@
|
|||||||
name: Release Checks
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
github-publish:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
|
|
||||||
- name: Checkout Repository & Submo
|
|
||||||
uses: actions/checkout@v2
|
|
||||||
with:
|
|
||||||
submodules: recursive
|
|
||||||
|
|
||||||
- name: Setup Node
|
|
||||||
uses: actions/setup-node@v2
|
|
||||||
with:
|
|
||||||
node-version: '16'
|
|
||||||
cache: 'npm'
|
|
||||||
cache-dependency-path: '**/package-lock.json'
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: npm install
|
|
||||||
|
|
||||||
# TODO: Finish fixing eslint issues
|
|
||||||
# - name: Run ESLint check
|
|
||||||
# run: npm run lint:ci
|
|
||||||
|
|
||||||
- name: Run Test & Coverage check
|
|
||||||
run: npm run test
|
|
||||||
|
|
||||||
56
.github/workflows/build_pr.yml
vendored
56
.github/workflows/build_pr.yml
vendored
@@ -1,56 +0,0 @@
|
|||||||
name: "Build TypeScript SDK"
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
push_spec_workflow:
|
|
||||||
name: Build TypeScript SDK
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
# Checkout the master branch request to run rsync
|
|
||||||
- name: Checkout PR branch
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
ref: ${{ github.ref }}
|
|
||||||
|
|
||||||
# Checkout the main branch of api-specs
|
|
||||||
- name: Checkout API Specs Repo
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
repository: lukehagar/plex-api-spec
|
|
||||||
path: api-specs
|
|
||||||
ref: main
|
|
||||||
|
|
||||||
- name: Set up Node
|
|
||||||
uses: actions/setup-node@v3
|
|
||||||
with:
|
|
||||||
node-version: "16"
|
|
||||||
|
|
||||||
- name: Build PMS SDK
|
|
||||||
id: buildPMS
|
|
||||||
run: |
|
|
||||||
rm -rf plexjs/pms
|
|
||||||
java -jar openapi-generator-cli.jar generate -i api-specs/pms/pms-spec.yaml -g typescript-axios -o plexjs/pms --global-property skipFormModel=false --config sdk-resources/pms-config.yaml
|
|
||||||
|
|
||||||
- name: Build PTV SDK
|
|
||||||
id: buildPTV
|
|
||||||
if: steps.buildPMS.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
rm -rf plexjs/plextv
|
|
||||||
java -jar openapi-generator-cli.jar generate -i api-specs/plextv/plextv-spec.yaml -g typescript-axios -o plexjs/plextv --global-property skipFormModel=false --config sdk-resources/plextv-config.yaml
|
|
||||||
|
|
||||||
- name: Run npm install and build Typescript SDK
|
|
||||||
id: buildSDK
|
|
||||||
if: steps.buildPTV.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
cd plexjs
|
|
||||||
npm install
|
|
||||||
npm run build
|
|
||||||
|
|
||||||
- name: Archive test build
|
|
||||||
uses: actions/upload-artifact@v3
|
|
||||||
with:
|
|
||||||
name: PR-Build-${{ github.ref }}
|
|
||||||
path: |
|
|
||||||
plexjs
|
|
||||||
114
.github/workflows/bump_version.yml
vendored
114
.github/workflows/bump_version.yml
vendored
@@ -1,114 +0,0 @@
|
|||||||
name: "Update Typescript SDK Version"
|
|
||||||
|
|
||||||
run-name: Update Typescript SDK Version to ${{ github.event.inputs.version }}
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
version:
|
|
||||||
description: The version to bump to
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
update_typescript_version:
|
|
||||||
name: Update Typescript Version
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
ref: ${{ github.ref }}
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- name: Checkout API Specs Repo
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
repository: lukehagar/plex-api-spec
|
|
||||||
path: api-specs
|
|
||||||
ref: main
|
|
||||||
|
|
||||||
- name: Set up Node
|
|
||||||
uses: actions/setup-node@v3
|
|
||||||
with:
|
|
||||||
node-version: "16"
|
|
||||||
|
|
||||||
# Install yq for working with yaml files
|
|
||||||
- name: Set up yq
|
|
||||||
uses: frenck/action-setup-yq@v1
|
|
||||||
|
|
||||||
# Check input version is greater than the current tag
|
|
||||||
- name: Check valid version
|
|
||||||
run: |
|
|
||||||
function ver { printf "%03d%03d%03d%03d" $(echo "$1" | tr '.' ' '); }
|
|
||||||
LATEST_TAG=$(git describe --tags `git rev-list --tags --max-count=1`)
|
|
||||||
echo $LATEST_TAG
|
|
||||||
if [ $(ver $LATEST_TAG) -lt $(ver ${{ github.event.inputs.version}}) ]
|
|
||||||
then
|
|
||||||
echo "Input version ${{ github.event.inputs.version }} valid"
|
|
||||||
else
|
|
||||||
echo "Current tagged version $LATEST_TAG is greater than input version ${{ github.event.inputs.version }}"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
## Update configuration files to new version
|
|
||||||
- name: Update config files with new version
|
|
||||||
id: updateVersion
|
|
||||||
run: |
|
|
||||||
yq -i '.npmVersion = "${{ github.event.inputs.version }}"' sdk-resources/pms-config.yaml
|
|
||||||
yq -i '.npmVersion = "${{ github.event.inputs.version }}"' sdk-resources/plextv-config.yaml
|
|
||||||
|
|
||||||
## Update package.json file with new version
|
|
||||||
- name: Update package.json version
|
|
||||||
id: updatePackageJsonVersion
|
|
||||||
if: steps.updateVersion.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
LATEST_TAG=$(git describe --tags `git rev-list --tags --max-count=1`)
|
|
||||||
cd plexjs
|
|
||||||
jq '.version = "${{ github.event.inputs.version }}"' package.json > package.json.tmp && mv package.json.tmp package.json
|
|
||||||
|
|
||||||
- name: Build PMS SDK
|
|
||||||
id: buildPMS
|
|
||||||
run: |
|
|
||||||
rm -rf plexjs/pms
|
|
||||||
java -jar openapi-generator-cli.jar generate -i api-specs/pms/pms-spec.yaml -g typescript-axios -o plexjs/pms --global-property skipFormModel=false --config sdk-resources/pms-config.yaml
|
|
||||||
|
|
||||||
- name: Build PTV SDK
|
|
||||||
id: buildPTV
|
|
||||||
if: steps.buildPMS.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
rm -rf plexjs/plextv
|
|
||||||
java -jar openapi-generator-cli.jar generate -i api-specs/plextv/plextv-spec.yaml -g typescript-axios -o plexjs/plextv --global-property skipFormModel=false --config sdk-resources/plextv-config.yaml
|
|
||||||
|
|
||||||
- name: After SDK Build
|
|
||||||
id: buildSDK
|
|
||||||
if: steps.buildPTV.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
cd plexjs
|
|
||||||
npm install
|
|
||||||
npm run build
|
|
||||||
|
|
||||||
- name: Publish to NPM
|
|
||||||
id: publish
|
|
||||||
uses: JS-DevTools/npm-publish@v1
|
|
||||||
with:
|
|
||||||
token: ${{ secrets.NPM_TOKEN }}
|
|
||||||
package: ./plexjs/package.json
|
|
||||||
|
|
||||||
- name: Commit changes and create new version tag
|
|
||||||
if: steps.buildSDK.outcome == 'success'
|
|
||||||
uses: stefanzweifel/git-auto-commit-action@v4
|
|
||||||
with:
|
|
||||||
commit_message: Bump version to ${{ github.event.inputs.version }}
|
|
||||||
tagging_message: ${{ github.event.inputs.version }}
|
|
||||||
|
|
||||||
- name: Create Release
|
|
||||||
id: create_release
|
|
||||||
uses: actions/create-release@v1
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
|
|
||||||
with:
|
|
||||||
tag_name: ${{ github.event.inputs.version }}
|
|
||||||
release_name: ${{ github.event.inputs.version }}
|
|
||||||
draft: false
|
|
||||||
prerelease: false
|
|
||||||
23
.github/workflows/codesee-arch-diagram.yml
vendored
23
.github/workflows/codesee-arch-diagram.yml
vendored
@@ -1,23 +0,0 @@
|
|||||||
# This workflow was added by CodeSee. Learn more at https://codesee.io/
|
|
||||||
# This is v2.0 of this workflow file
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
pull_request_target:
|
|
||||||
types: [opened, synchronize, reopened]
|
|
||||||
|
|
||||||
name: CodeSee
|
|
||||||
|
|
||||||
permissions: read-all
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
codesee:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
continue-on-error: true
|
|
||||||
name: Analyze the repo with CodeSee
|
|
||||||
steps:
|
|
||||||
- uses: Codesee-io/codesee-action@v2
|
|
||||||
with:
|
|
||||||
codesee-token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}
|
|
||||||
codesee-url: https://app.codesee.io
|
|
||||||
28
.github/workflows/pr-checks.yml
vendored
28
.github/workflows/pr-checks.yml
vendored
@@ -1,28 +0,0 @@
|
|||||||
name: Pull Request Checks
|
|
||||||
|
|
||||||
on: [pull_request]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
linting-and-testing:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v2
|
|
||||||
|
|
||||||
- name: Setup Node
|
|
||||||
uses: actions/setup-node@v2
|
|
||||||
with:
|
|
||||||
node-version: '16'
|
|
||||||
cache: 'npm'
|
|
||||||
cache-dependency-path: '**/package-lock.json'
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: npm install
|
|
||||||
|
|
||||||
# TODO: Finish fixing eslint issues
|
|
||||||
# - name: Run ESLint check
|
|
||||||
# run: npm run lint:ci
|
|
||||||
|
|
||||||
- name: Run Test & Coverage check
|
|
||||||
run: npm run test
|
|
||||||
32
.github/workflows/publish-jsr.yaml
vendored
Normal file
32
.github/workflows/publish-jsr.yaml
vendored
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
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
|
||||||
32
.github/workflows/release-checks.yml
vendored
32
.github/workflows/release-checks.yml
vendored
@@ -1,32 +0,0 @@
|
|||||||
name: Release Checks
|
|
||||||
|
|
||||||
on:
|
|
||||||
release:
|
|
||||||
types: [created]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
- uses: actions/setup-node@v3
|
|
||||||
with:
|
|
||||||
node-version: '16'
|
|
||||||
cache: 'npm'
|
|
||||||
- run: npm ci
|
|
||||||
- run: npm run test
|
|
||||||
|
|
||||||
npm-publish:
|
|
||||||
needs: build
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
- uses: actions/setup-node@v3
|
|
||||||
with:
|
|
||||||
node-version: '16'
|
|
||||||
registry-url: https://registry.npmjs.org/
|
|
||||||
- run: npm ci
|
|
||||||
- run: npm publish
|
|
||||||
env:
|
|
||||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
||||||
|
|
||||||
30
.github/workflows/sdk_generation.yaml
vendored
Normal file
30
.github/workflows/sdk_generation.yaml
vendored
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
name: Generate
|
||||||
|
permissions:
|
||||||
|
checks: write
|
||||||
|
contents: write
|
||||||
|
pull-requests: write
|
||||||
|
statuses: write
|
||||||
|
"on":
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
force:
|
||||||
|
description: Force generation of SDKs
|
||||||
|
type: boolean
|
||||||
|
default: false
|
||||||
|
set_version:
|
||||||
|
description: optionally set a specific SDK version
|
||||||
|
type: string
|
||||||
|
schedule:
|
||||||
|
- cron: 0 0 * * *
|
||||||
|
jobs:
|
||||||
|
generate:
|
||||||
|
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
||||||
|
with:
|
||||||
|
force: ${{ github.event.inputs.force }}
|
||||||
|
mode: direct
|
||||||
|
set_version: ${{ github.event.inputs.set_version }}
|
||||||
|
speakeasy_version: latest
|
||||||
|
secrets:
|
||||||
|
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
npm_token: ${{ secrets.NPM_TOKEN }}
|
||||||
|
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||||
73
.github/workflows/test-oag-ver.yml
vendored
73
.github/workflows/test-oag-ver.yml
vendored
@@ -1,73 +0,0 @@
|
|||||||
name: "Test open api generator version"
|
|
||||||
|
|
||||||
run-name: "Test open api generator version ${{ github.event.inputs.version }}"
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
version:
|
|
||||||
description: The version of the OpenAPI Generator to test
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
push_spec_workflow:
|
|
||||||
name: Build TypeScript SDK
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
# Checkout the master branch request to run rsync
|
|
||||||
- name: Checkout PR branch
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
ref: ${{ github.ref }}
|
|
||||||
|
|
||||||
# Checkout the main branch of api-specs
|
|
||||||
- name: Checkout API Specs Repo
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
repository: lukehagar/plex-api-spec
|
|
||||||
path: api-specs
|
|
||||||
ref: main
|
|
||||||
|
|
||||||
- name: Set up Node
|
|
||||||
uses: actions/setup-node@v3
|
|
||||||
with:
|
|
||||||
node-version: "16"
|
|
||||||
|
|
||||||
- name: Install OpenAPI Generator
|
|
||||||
run: |
|
|
||||||
wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/${{ github.event.inputs.version }}/openapi-generator-cli-${{ github.event.inputs.version }}.jar -O openapi-generator-cli.jar
|
|
||||||
|
|
||||||
- name: Build PMS SDK
|
|
||||||
id: buildPMS
|
|
||||||
run: |
|
|
||||||
rm -rf plexjs/pms
|
|
||||||
java -jar openapi-generator-cli.jar generate -i api-specs/pms/pms-spec.yaml -g typescript-axios -o plexjs/pms --config sdk-resources/pms-config-test.yaml
|
|
||||||
|
|
||||||
- name: Build PTV SDK
|
|
||||||
id: buildPTV
|
|
||||||
run: |
|
|
||||||
rm -rf plexjs/plextv
|
|
||||||
java -jar openapi-generator-cli.jar generate -i api-specs/plextv/plextv-spec.yaml -g typescript-axios -o plexjs/plextv --config sdk-resources/plextv-config-test.yaml
|
|
||||||
|
|
||||||
- name: Archive test build
|
|
||||||
uses: actions/upload-artifact@v3
|
|
||||||
with:
|
|
||||||
name: OAG-${{ github.event.inputs.version }}-test-build
|
|
||||||
path: |
|
|
||||||
plexjs/pms
|
|
||||||
plexjs/plextv
|
|
||||||
|
|
||||||
- name: Run npm install and build Typescript SDK
|
|
||||||
id: testPMS
|
|
||||||
if: steps.buildPMS.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
cd plexjs/pms
|
|
||||||
npm install
|
|
||||||
npm run build
|
|
||||||
|
|
||||||
- name: Run npm install and build Typescript SDK
|
|
||||||
id: testPTV
|
|
||||||
if: steps.buildPTV.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
cd plexjs/plextv
|
|
||||||
npm install
|
|
||||||
npm run build
|
|
||||||
156
.gitignore
vendored
156
.gitignore
vendored
@@ -1,132 +1,24 @@
|
|||||||
# Logs
|
/mcp-server
|
||||||
logs
|
/bin
|
||||||
*.log
|
/.eslintcache
|
||||||
npm-debug.log*
|
/.speakeasy/reports
|
||||||
yarn-debug.log*
|
/react-query
|
||||||
yarn-error.log*
|
/sdk/models/errors
|
||||||
lerna-debug.log*
|
/sdk/types
|
||||||
.pnpm-debug.log*
|
/__tests__
|
||||||
|
/funcs
|
||||||
# Diagnostic reports (https://nodejs.org/api/report.html)
|
/core.*
|
||||||
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
|
/esm
|
||||||
|
/dist
|
||||||
# Runtime data
|
/.tshy
|
||||||
pids
|
/.tshy-*
|
||||||
*.pid
|
/hooks
|
||||||
*.seed
|
/models
|
||||||
*.pid.lock
|
/models/errors
|
||||||
|
/types
|
||||||
# Directory for instrumented libs generated by jscoverage/JSCover
|
/lib
|
||||||
lib-cov
|
/sdk
|
||||||
|
/index.*
|
||||||
# Coverage directory used by tools like istanbul
|
/cjs
|
||||||
coverage
|
/node_modules
|
||||||
*.lcov
|
/.tsbuildinfo
|
||||||
|
|
||||||
# nyc test coverage
|
|
||||||
.nyc_output
|
|
||||||
|
|
||||||
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
|
|
||||||
.grunt
|
|
||||||
|
|
||||||
# Bower dependency directory (https://bower.io/)
|
|
||||||
bower_components
|
|
||||||
|
|
||||||
# node-waf configuration
|
|
||||||
.lock-wscript
|
|
||||||
|
|
||||||
# Compiled binary addons (https://nodejs.org/api/addons.html)
|
|
||||||
build/Release
|
|
||||||
|
|
||||||
# Dependency directories
|
|
||||||
node_modules/
|
|
||||||
jspm_packages/
|
|
||||||
|
|
||||||
# Snowpack dependency directory (https://snowpack.dev/)
|
|
||||||
web_modules/
|
|
||||||
|
|
||||||
# TypeScript cache
|
|
||||||
*.tsbuildinfo
|
|
||||||
|
|
||||||
# Optional npm cache directory
|
|
||||||
.npm
|
|
||||||
|
|
||||||
# Optional eslint cache
|
|
||||||
.eslintcache
|
|
||||||
|
|
||||||
# Optional stylelint cache
|
|
||||||
.stylelintcache
|
|
||||||
|
|
||||||
# Microbundle cache
|
|
||||||
.rpt2_cache/
|
|
||||||
.rts2_cache_cjs/
|
|
||||||
.rts2_cache_es/
|
|
||||||
.rts2_cache_umd/
|
|
||||||
|
|
||||||
# Optional REPL history
|
|
||||||
.node_repl_history
|
|
||||||
|
|
||||||
# Output of 'npm pack'
|
|
||||||
*.tgz
|
|
||||||
|
|
||||||
# Yarn Integrity file
|
|
||||||
.yarn-integrity
|
|
||||||
|
|
||||||
# dotenv environment variable files
|
|
||||||
.env
|
|
||||||
.env.development.local
|
|
||||||
.env.test.local
|
|
||||||
.env.production.local
|
|
||||||
.env.local
|
|
||||||
|
|
||||||
# parcel-bundler cache (https://parceljs.org/)
|
|
||||||
.cache
|
|
||||||
.parcel-cache
|
|
||||||
|
|
||||||
# Next.js build output
|
|
||||||
.next
|
|
||||||
out
|
|
||||||
|
|
||||||
# Nuxt.js build / generate output
|
|
||||||
.nuxt
|
|
||||||
dist
|
|
||||||
|
|
||||||
# Gatsby files
|
|
||||||
.cache/
|
|
||||||
# Comment in the public line in if your project uses Gatsby and not Next.js
|
|
||||||
# https://nextjs.org/blog/next-9-1#public-directory-support
|
|
||||||
# public
|
|
||||||
|
|
||||||
# vuepress build output
|
|
||||||
.vuepress/dist
|
|
||||||
|
|
||||||
# vuepress v2.x temp and cache directory
|
|
||||||
.temp
|
|
||||||
.cache
|
|
||||||
|
|
||||||
# Docusaurus cache and generated files
|
|
||||||
.docusaurus
|
|
||||||
|
|
||||||
# Serverless directories
|
|
||||||
.serverless/
|
|
||||||
|
|
||||||
# FuseBox cache
|
|
||||||
.fusebox/
|
|
||||||
|
|
||||||
# DynamoDB Local files
|
|
||||||
.dynamodb/
|
|
||||||
|
|
||||||
# TernJS port file
|
|
||||||
.tern-port
|
|
||||||
|
|
||||||
# Stores VSCode versions used for testing VSCode extensions
|
|
||||||
.vscode-test
|
|
||||||
|
|
||||||
# yarn v2
|
|
||||||
.yarn/cache
|
|
||||||
.yarn/unplugged
|
|
||||||
.yarn/build-state.yml
|
|
||||||
.yarn/install-state.gz
|
|
||||||
.pnp.*
|
|
||||||
|
|
||||||
.parcel-cache
|
|
||||||
|
|||||||
15
.npmignore
Normal file
15
.npmignore
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
**/*
|
||||||
|
!/FUNCTIONS.md
|
||||||
|
!/RUNTIMES.md
|
||||||
|
!/REACT_QUERY.md
|
||||||
|
!/**/*.ts
|
||||||
|
!/**/*.js
|
||||||
|
!/**/*.mjs
|
||||||
|
!/**/*.json
|
||||||
|
!/**/*.map
|
||||||
|
|
||||||
|
/eslint.config.mjs
|
||||||
|
/cjs
|
||||||
|
/.tshy
|
||||||
|
/.tshy-*
|
||||||
|
/__tests__
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
{
|
|
||||||
"printWidth": 100,
|
|
||||||
"tabWidth": 2,
|
|
||||||
"useTabs": false,
|
|
||||||
"semi": true,
|
|
||||||
"singleQuote": true,
|
|
||||||
"quoteProps": "as-needed",
|
|
||||||
"jsxSingleQuote": false,
|
|
||||||
"trailingComma": "all",
|
|
||||||
"bracketSpacing": true,
|
|
||||||
"arrowParens": "always",
|
|
||||||
"overrides": [
|
|
||||||
{
|
|
||||||
"files": ".editorconfig",
|
|
||||||
"options": {
|
|
||||||
"parser": "yaml"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"files": "LICENSE",
|
|
||||||
"options": {
|
|
||||||
"parser": "markdown"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
2406
.speakeasy/gen.lock
Executable file
2406
.speakeasy/gen.lock
Executable file
File diff suppressed because one or more lines are too long
50
.speakeasy/gen.yaml
Executable file
50
.speakeasy/gen.yaml
Executable file
@@ -0,0 +1,50 @@
|
|||||||
|
configVersion: 2.0.0
|
||||||
|
generation:
|
||||||
|
sdkClassName: Plex-API
|
||||||
|
maintainOpenAPIOrder: true
|
||||||
|
usageSnippets:
|
||||||
|
optionalPropertyRendering: withExample
|
||||||
|
useClassNamesForArrayFields: true
|
||||||
|
fixes:
|
||||||
|
nameResolutionDec2023: true
|
||||||
|
nameResolutionFeb2025: false
|
||||||
|
parameterOrderingFeb2024: true
|
||||||
|
requestResponseComponentNamesFeb2024: true
|
||||||
|
securityFeb2025: false
|
||||||
|
auth:
|
||||||
|
oAuth2ClientCredentialsEnabled: true
|
||||||
|
oAuth2PasswordEnabled: false
|
||||||
|
typescript:
|
||||||
|
version: 0.36.0
|
||||||
|
additionalDependencies:
|
||||||
|
dependencies: {}
|
||||||
|
devDependencies: {}
|
||||||
|
peerDependencies: {}
|
||||||
|
additionalPackageJSON: {}
|
||||||
|
author: LukeHagar
|
||||||
|
clientServerStatusCodesAsErrors: true
|
||||||
|
defaultErrorName: SDKError
|
||||||
|
enableCustomCodeRegions: false
|
||||||
|
enableMCPServer: true
|
||||||
|
enableReactQuery: false
|
||||||
|
enumFormat: enum
|
||||||
|
flattenGlobalSecurity: true
|
||||||
|
flatteningOrder: body-first
|
||||||
|
imports:
|
||||||
|
option: openapi
|
||||||
|
paths:
|
||||||
|
callbacks: sdk/models/callbacks
|
||||||
|
errors: sdk/models/errors
|
||||||
|
operations: sdk/models/operations
|
||||||
|
shared: sdk/models/shared
|
||||||
|
webhooks: sdk/models/webhooks
|
||||||
|
inputModelSuffix: input
|
||||||
|
jsonpath: legacy
|
||||||
|
maxMethodParams: 4
|
||||||
|
methodArguments: require-security-and-request
|
||||||
|
moduleFormat: commonjs
|
||||||
|
outputModelSuffix: output
|
||||||
|
packageName: '@lukehagar/plexjs'
|
||||||
|
responseFormat: envelope
|
||||||
|
templateVersion: v2
|
||||||
|
useIndexModules: true
|
||||||
47
.speakeasy/workflow.lock
Normal file
47
.speakeasy/workflow.lock
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
speakeasyVersion: 1.528.1
|
||||||
|
sources:
|
||||||
|
my-source:
|
||||||
|
sourceNamespace: my-source
|
||||||
|
sourceRevisionDigest: sha256:1b8840d540c66b58d1009ec2581fb18464158ec9aa00464eac05ba737f31207e
|
||||||
|
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
||||||
|
tags:
|
||||||
|
- latest
|
||||||
|
- main
|
||||||
|
plexapi:
|
||||||
|
sourceNamespace: plexapi
|
||||||
|
sourceRevisionDigest: sha256:b5580df6ec4a386e12249ff13f35b916fe5559e101de4a816b53e47d6947f1a5
|
||||||
|
sourceBlobDigest: sha256:6108b6c35fbe7e9163ffe0c804170f5e3a6edb63b8e745454ea8ee249bd790c3
|
||||||
|
tags:
|
||||||
|
- latest
|
||||||
|
- speakeasy-sdk-regen-1743639051
|
||||||
|
- 0.0.3
|
||||||
|
targets:
|
||||||
|
plexjs:
|
||||||
|
source: plexapi
|
||||||
|
sourceNamespace: plexapi
|
||||||
|
sourceRevisionDigest: sha256:b5580df6ec4a386e12249ff13f35b916fe5559e101de4a816b53e47d6947f1a5
|
||||||
|
sourceBlobDigest: sha256:6108b6c35fbe7e9163ffe0c804170f5e3a6edb63b8e745454ea8ee249bd790c3
|
||||||
|
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||||
|
codeSamplesRevisionDigest: sha256:1d984798d2ba05ff7dfba1649556f6ece8cbfabbf9260f6a2678748f02977d47
|
||||||
|
workflow:
|
||||||
|
workflowVersion: 1.0.0
|
||||||
|
speakeasyVersion: latest
|
||||||
|
sources:
|
||||||
|
plexapi:
|
||||||
|
inputs:
|
||||||
|
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/output/plex-media-server-spec-dereferenced.yaml
|
||||||
|
registry:
|
||||||
|
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
|
||||||
|
targets:
|
||||||
|
plexjs:
|
||||||
|
target: typescript
|
||||||
|
source: plexapi
|
||||||
|
publish:
|
||||||
|
npm:
|
||||||
|
token: $npm_token
|
||||||
|
codeSamples:
|
||||||
|
output: codeSamples.yaml
|
||||||
|
registry:
|
||||||
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||||
|
labelOverride:
|
||||||
|
fixedValue: PlexJS
|
||||||
21
.speakeasy/workflow.yaml
Normal file
21
.speakeasy/workflow.yaml
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
workflowVersion: 1.0.0
|
||||||
|
speakeasyVersion: latest
|
||||||
|
sources:
|
||||||
|
plexapi:
|
||||||
|
inputs:
|
||||||
|
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/output/plex-media-server-spec-dereferenced.yaml
|
||||||
|
registry:
|
||||||
|
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
|
||||||
|
targets:
|
||||||
|
plexjs:
|
||||||
|
target: typescript
|
||||||
|
source: plexapi
|
||||||
|
publish:
|
||||||
|
npm:
|
||||||
|
token: $npm_token
|
||||||
|
codeSamples:
|
||||||
|
output: codeSamples.yaml
|
||||||
|
registry:
|
||||||
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||||
|
labelOverride:
|
||||||
|
fixedValue: PlexJS
|
||||||
26
CONTRIBUTING.md
Normal file
26
CONTRIBUTING.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# Contributing to This Repository
|
||||||
|
|
||||||
|
Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
|
||||||
|
|
||||||
|
## How to Report Issues
|
||||||
|
|
||||||
|
If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
|
||||||
|
|
||||||
|
- A clear and descriptive title
|
||||||
|
- Steps to reproduce the issue
|
||||||
|
- Expected and actual behavior
|
||||||
|
- Any relevant logs, screenshots, or error messages
|
||||||
|
- Information about your environment (e.g., operating system, software versions)
|
||||||
|
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
|
||||||
|
|
||||||
|
## Issue Triage and Upstream Fixes
|
||||||
|
|
||||||
|
We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
|
||||||
|
|
||||||
|
## Contact
|
||||||
|
|
||||||
|
If you have any questions or need further assistance, please feel free to reach out by opening an issue.
|
||||||
|
|
||||||
|
Thank you for your understanding and cooperation!
|
||||||
|
|
||||||
|
The Maintainers
|
||||||
104
FUNCTIONS.md
Normal file
104
FUNCTIONS.md
Normal file
@@ -0,0 +1,104 @@
|
|||||||
|
# Standalone Functions
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> This section is useful if you are using a bundler and targetting browsers and
|
||||||
|
> runtimes where the size of an application affects performance and load times.
|
||||||
|
|
||||||
|
Every method in this SDK is also available as a standalone function. This
|
||||||
|
alternative API is suitable when targetting the browser or serverless runtimes
|
||||||
|
and using a bundler to build your application since all unused functionality
|
||||||
|
will be tree-shaken away. This includes code for unused methods, Zod schemas,
|
||||||
|
encoding helpers and response handlers. The result is dramatically smaller
|
||||||
|
impact on the application's final bundle size which grows very slowly as you use
|
||||||
|
more and more functionality from this SDK.
|
||||||
|
|
||||||
|
Calling methods through the main SDK class remains a valid and generally more
|
||||||
|
more ergonomic option. Standalone functions represent an optimisation for a
|
||||||
|
specific category of applications.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
|
||||||
|
import { serverGetServerCapabilities } from "@lukehagar/plexjs/funcs/serverGetServerCapabilities.js";
|
||||||
|
import { SDKValidationError } from "@lukehagar/plexjs/sdk/models/errors/sdkvalidationerror.js";
|
||||||
|
|
||||||
|
// Use `PlexAPICore` for best tree-shaking performance.
|
||||||
|
// You can create one instance of it to use across an application.
|
||||||
|
const plexAPI = new PlexAPICore({
|
||||||
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const res = await serverGetServerCapabilities(plexAPI);
|
||||||
|
|
||||||
|
switch (true) {
|
||||||
|
case res.ok:
|
||||||
|
// The success case will be handled outside of the switch block
|
||||||
|
break;
|
||||||
|
case res.error instanceof SDKValidationError:
|
||||||
|
// Pretty-print validation errors.
|
||||||
|
return console.log(res.error.pretty());
|
||||||
|
case res.error instanceof Error:
|
||||||
|
return console.log(res.error);
|
||||||
|
default:
|
||||||
|
// TypeScript's type checking will fail on the following line if the above
|
||||||
|
// cases were not exhaustive.
|
||||||
|
res.error satisfies never;
|
||||||
|
throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
const { value: result } = res;
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
```
|
||||||
|
|
||||||
|
## Result types
|
||||||
|
|
||||||
|
Standalone functions differ from SDK methods in that they return a
|
||||||
|
`Result<Value, Error>` type to capture _known errors_ and document them using
|
||||||
|
the type system. By avoiding throwing errors, application code maintains clear
|
||||||
|
control flow and error-handling become part of the regular flow of application
|
||||||
|
code.
|
||||||
|
|
||||||
|
> We use the term "known errors" because standalone functions, and JavaScript
|
||||||
|
> code in general, can still throw unexpected errors such as `TypeError`s,
|
||||||
|
> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
|
||||||
|
> something this SDK addresses in the future. Nevertheless, there is still a lot
|
||||||
|
> of benefit from capturing most errors and turning them into values.
|
||||||
|
|
||||||
|
The second reason for this style of programming is because these functions will
|
||||||
|
typically be used in front-end applications where exception throwing is
|
||||||
|
sometimes discouraged or considered unidiomatic. React and similar ecosystems
|
||||||
|
and libraries tend to promote this style of programming so that components
|
||||||
|
render useful content under all states (loading, success, error and so on).
|
||||||
|
|
||||||
|
The general pattern when calling standalone functions looks like this:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Core } from "<sdk-package-name>";
|
||||||
|
import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
|
||||||
|
|
||||||
|
const client = new Core();
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await fetchSomething(client, { id: "123" });
|
||||||
|
if (!result.ok) {
|
||||||
|
// You can throw the error or handle it. It's your choice now.
|
||||||
|
throw result.error;
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(result.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
```
|
||||||
|
|
||||||
|
Notably, `result.error` above will have an explicit type compared to a try-catch
|
||||||
|
variation where the error in the catch block can only be of type `unknown` (or
|
||||||
|
`any` depending on your TypeScript settings).
|
||||||
@@ -1,4 +1,6 @@
|
|||||||
Copyright (c) 2023
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2023 LukeHagar
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
@@ -10,10 +12,10 @@ furnished to do so, subject to the following conditions:
|
|||||||
The above copyright notice and this permission notice shall be included in all
|
The above copyright notice and this permission notice shall be included in all
|
||||||
copies or substantial portions of the Software.
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
OR OTHER DEALINGS IN THE SOFTWARE.
|
SOFTWARE.
|
||||||
1291
RELEASES.md
Normal file
1291
RELEASES.md
Normal file
File diff suppressed because it is too large
Load Diff
48
RUNTIMES.md
Normal file
48
RUNTIMES.md
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
# Supported JavaScript runtimes
|
||||||
|
|
||||||
|
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 Streams API][web-streams] and in particular `ReadableStream`
|
||||||
|
* [Async iterables][async-iter] using `Symbol.asyncIterator`
|
||||||
|
|
||||||
|
[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
|
||||||
|
[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
|
||||||
|
|
||||||
|
Runtime environments that are explicitly supported are:
|
||||||
|
|
||||||
|
- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
|
||||||
|
- Node.js active and maintenance LTS releases
|
||||||
|
- Currently, this is v18 and v20
|
||||||
|
- Bun v1 and above
|
||||||
|
- Deno v1.39
|
||||||
|
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
|
||||||
|
|
||||||
|
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
|
||||||
|
|
||||||
|
## Recommended TypeScript compiler options
|
||||||
|
|
||||||
|
The following `tsconfig.json` options are recommended for projects using this
|
||||||
|
SDK in order to get static type support for features like async iterables,
|
||||||
|
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
|
||||||
|
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
|
||||||
|
so on):
|
||||||
|
|
||||||
|
[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
|
||||||
|
[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
|
||||||
|
[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
|
||||||
|
[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"target": "es2020", // or higher
|
||||||
|
"lib": ["es2020", "dom", "dom.iterable"],
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
While `target` can be set to older ECMAScript versions, it may result in extra,
|
||||||
|
unnecessary compatibility code being generated if you are not targeting old
|
||||||
|
runtimes.
|
||||||
19
USAGE.md
Normal file
19
USAGE.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
<!-- Start SDK Example Usage [usage] -->
|
||||||
|
```typescript
|
||||||
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
const plexAPI = new PlexAPI({
|
||||||
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End SDK Example Usage [usage] -->
|
||||||
1844
codeSamples.yaml
Normal file
1844
codeSamples.yaml
Normal file
File diff suppressed because it is too large
Load Diff
24
docs/lib/utils/retryconfig.md
Normal file
24
docs/lib/utils/retryconfig.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# RetryConfig
|
||||||
|
|
||||||
|
Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies.
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Name | Type | Description | Example |
|
||||||
|
| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
|
||||||
|
| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` |
|
||||||
|
| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | |
|
||||||
|
| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` |
|
||||||
|
|
||||||
|
## BackoffStrategy
|
||||||
|
|
||||||
|
The backoff strategy allows retrying a request with an exponential backoff between each retry.
|
||||||
|
|
||||||
|
### Fields
|
||||||
|
|
||||||
|
| Name | Type | Description | Example |
|
||||||
|
| ------------------ | ------------ | ----------------------------------------- | -------- |
|
||||||
|
| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` |
|
||||||
|
| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` |
|
||||||
|
| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` |
|
||||||
|
| `maxElapsedTime` | `*number*` | The maximum elapsed time in milliseconds. | `300000` |
|
||||||
18
docs/sdk/models/errors/addplaylistcontentsbadrequest.md
Normal file
18
docs/sdk/models/errors/addplaylistcontentsbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/addplaylistcontentserrors.md
Normal file
21
docs/sdk/models/errors/addplaylistcontentserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/addplaylistcontentsplaylistserrors.md
Normal file
21
docs/sdk/models/errors/addplaylistcontentsplaylistserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/addplaylistcontentsunauthorized.md
Normal file
18
docs/sdk/models/errors/addplaylistcontentsunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/applyupdatesbadrequest.md
Normal file
18
docs/sdk/models/errors/applyupdatesbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/applyupdateserrors.md
Normal file
21
docs/sdk/models/errors/applyupdateserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/applyupdatesunauthorized.md
Normal file
18
docs/sdk/models/errors/applyupdatesunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/applyupdatesupdatererrors.md
Normal file
21
docs/sdk/models/errors/applyupdatesupdatererrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/cancelserveractivitiesbadrequest.md
Normal file
18
docs/sdk/models/errors/cancelserveractivitiesbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/cancelserveractivitieserrors.md
Normal file
21
docs/sdk/models/errors/cancelserveractivitieserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/cancelserveractivitiesunauthorized.md
Normal file
18
docs/sdk/models/errors/cancelserveractivitiesunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/checkforupdatesbadrequest.md
Normal file
18
docs/sdk/models/errors/checkforupdatesbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/checkforupdateserrors.md
Normal file
21
docs/sdk/models/errors/checkforupdateserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/checkforupdatesunauthorized.md
Normal file
18
docs/sdk/models/errors/checkforupdatesunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/checkforupdatesupdatererrors.md
Normal file
21
docs/sdk/models/errors/checkforupdatesupdatererrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/clearplaylistcontentsbadrequest.md
Normal file
18
docs/sdk/models/errors/clearplaylistcontentsbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/clearplaylistcontentserrors.md
Normal file
21
docs/sdk/models/errors/clearplaylistcontentserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/clearplaylistcontentsunauthorized.md
Normal file
18
docs/sdk/models/errors/clearplaylistcontentsunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/createplaylistbadrequest.md
Normal file
18
docs/sdk/models/errors/createplaylistbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/createplaylisterrors.md
Normal file
21
docs/sdk/models/errors/createplaylisterrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/createplaylistplaylistserrors.md
Normal file
21
docs/sdk/models/errors/createplaylistplaylistserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/createplaylistunauthorized.md
Normal file
18
docs/sdk/models/errors/createplaylistunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/deletelibrarybadrequest.md
Normal file
18
docs/sdk/models/errors/deletelibrarybadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/deletelibraryerrors.md
Normal file
21
docs/sdk/models/errors/deletelibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/deletelibrarylibraryerrors.md
Normal file
21
docs/sdk/models/errors/deletelibrarylibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/deletelibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/deletelibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/deleteplaylistbadrequest.md
Normal file
18
docs/sdk/models/errors/deleteplaylistbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/deleteplaylisterrors.md
Normal file
21
docs/sdk/models/errors/deleteplaylisterrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/deleteplaylistplaylistserrors.md
Normal file
21
docs/sdk/models/errors/deleteplaylistplaylistserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/deleteplaylistunauthorized.md
Normal file
18
docs/sdk/models/errors/deleteplaylistunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/enablepapertrailbadrequest.md
Normal file
18
docs/sdk/models/errors/enablepapertrailbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/enablepapertrailerrors.md
Normal file
21
docs/sdk/models/errors/enablepapertrailerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/enablepapertraillogerrors.md
Normal file
21
docs/sdk/models/errors/enablepapertraillogerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/enablepapertrailunauthorized.md
Normal file
18
docs/sdk/models/errors/enablepapertrailunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/errors.md
Normal file
21
docs/sdk/models/errors/errors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/getactorslibrarybadrequest.md
Normal file
18
docs/sdk/models/errors/getactorslibrarybadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/getactorslibraryerrors.md
Normal file
21
docs/sdk/models/errors/getactorslibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/getactorslibrarylibraryerrors.md
Normal file
21
docs/sdk/models/errors/getactorslibrarylibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/getactorslibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getactorslibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/getalllibrariesbadrequest.md
Normal file
18
docs/sdk/models/errors/getalllibrariesbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/getalllibrarieserrors.md
Normal file
21
docs/sdk/models/errors/getalllibrarieserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/getalllibrarieslibraryerrors.md
Normal file
21
docs/sdk/models/errors/getalllibrarieslibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/getalllibrariesunauthorized.md
Normal file
18
docs/sdk/models/errors/getalllibrariesunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/getallmedialibrarybadrequest.md
Normal file
18
docs/sdk/models/errors/getallmedialibrarybadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/getallmedialibraryerrors.md
Normal file
21
docs/sdk/models/errors/getallmedialibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/getallmedialibrarylibraryerrors.md
Normal file
21
docs/sdk/models/errors/getallmedialibrarylibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/getallmedialibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getallmedialibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/getavailableclientsbadrequest.md
Normal file
18
docs/sdk/models/errors/getavailableclientsbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/getavailableclientserrors.md
Normal file
21
docs/sdk/models/errors/getavailableclientserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/getavailableclientsservererrors.md
Normal file
21
docs/sdk/models/errors/getavailableclientsservererrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/getavailableclientsunauthorized.md
Normal file
18
docs/sdk/models/errors/getavailableclientsunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/getbandwidthstatisticsbadrequest.md
Normal file
18
docs/sdk/models/errors/getbandwidthstatisticsbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/getbandwidthstatisticserrors.md
Normal file
21
docs/sdk/models/errors/getbandwidthstatisticserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/getbandwidthstatisticsunauthorized.md
Normal file
18
docs/sdk/models/errors/getbandwidthstatisticsunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/getbannerimagebadrequest.md
Normal file
18
docs/sdk/models/errors/getbannerimagebadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/getbannerimageerrors.md
Normal file
21
docs/sdk/models/errors/getbannerimageerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/getbannerimagemediaerrors.md
Normal file
21
docs/sdk/models/errors/getbannerimagemediaerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/getbannerimageunauthorized.md
Normal file
18
docs/sdk/models/errors/getbannerimageunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/getbutlertasksbadrequest.md
Normal file
18
docs/sdk/models/errors/getbutlertasksbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/getbutlertasksbutlererrors.md
Normal file
21
docs/sdk/models/errors/getbutlertasksbutlererrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/getbutlertaskserrors.md
Normal file
21
docs/sdk/models/errors/getbutlertaskserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/getbutlertasksunauthorized.md
Normal file
18
docs/sdk/models/errors/getbutlertasksunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/getcompanionsdatabadrequest.md
Normal file
18
docs/sdk/models/errors/getcompanionsdatabadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/getcompanionsdataerrors.md
Normal file
21
docs/sdk/models/errors/getcompanionsdataerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/getcompanionsdataplexerrors.md
Normal file
21
docs/sdk/models/errors/getcompanionsdataplexerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/getcompanionsdataunauthorized.md
Normal file
18
docs/sdk/models/errors/getcompanionsdataunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
18
docs/sdk/models/errors/getcountrieslibrarybadrequest.md
Normal file
18
docs/sdk/models/errors/getcountrieslibrarybadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/getcountrieslibraryerrors.md
Normal file
21
docs/sdk/models/errors/getcountrieslibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
21
docs/sdk/models/errors/getcountrieslibrarylibraryerrors.md
Normal file
21
docs/sdk/models/errors/getcountrieslibrarylibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# 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 |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user