mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
Compare commits
337 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
03c047afa2 | ||
|
|
03910be91f | ||
|
|
25ed9aa97d | ||
|
|
cf2cf981be | ||
|
|
de0bc5c344 | ||
|
|
c31a963aa6 | ||
|
|
faffbfd137 | ||
|
|
2853ce6b54 | ||
|
|
ed63eb13b9 | ||
|
|
442b11c11a | ||
|
|
c56a0f5d3c | ||
|
|
fe48f93ccb | ||
|
|
a7ec77cd04 | ||
|
|
2b38478255 | ||
|
|
6bd12d8759 | ||
|
|
891a7d39a1 | ||
|
|
763aa8e800 | ||
|
|
7a950ea773 | ||
|
|
379a408d74 | ||
|
|
2712820397 | ||
|
|
c895213ae8 | ||
|
|
c473c9d326 | ||
|
|
3c13bba9de | ||
|
|
650c5043ef | ||
|
|
0234804578 | ||
|
|
60d913c8f9 | ||
|
|
8d9f4bbaf1 | ||
|
|
5d57cd7c34 | ||
|
|
1a8e227874 | ||
|
|
8360d057ab | ||
|
|
18b64727c3 | ||
|
|
3152372037 | ||
|
|
13cd8a7fe5 | ||
|
|
cdcdc0ca8e | ||
|
|
b03cc6a609 | ||
|
|
4e989e0de3 | ||
|
|
c10e011a68 | ||
|
|
7e3dca8466 | ||
|
|
8a2d3e04ab | ||
|
|
6c8a73ae84 | ||
|
|
c839d9f6c7 | ||
|
|
77b0ef9507 | ||
|
|
1cfbd17f28 | ||
|
|
2492807c65 | ||
|
|
ead0a8773c | ||
|
|
e254f82e06 | ||
|
|
a4369c999a | ||
|
|
c50b85f29a | ||
|
|
496ebda695 | ||
|
|
d436fc3452 | ||
|
|
99cdf6effe | ||
|
|
fa2ba82f62 | ||
|
|
fd8095a8df | ||
|
|
9911164ab0 | ||
|
|
ffedf47cad | ||
|
|
39d3a40524 | ||
|
|
8dc802ca50 | ||
|
|
5465f1e74c | ||
|
|
2d100b8e75 | ||
|
|
0533836427 | ||
|
|
f0b08b9bd9 | ||
|
|
244adab882 | ||
|
|
4d8ee6c199 | ||
|
|
4fe1356250 | ||
|
|
454b20d045 | ||
|
|
8c39ddc475 | ||
|
|
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 | ||
|
|
88c6825688 | ||
|
|
0a07813e04 | ||
|
|
9ecba973b2 | ||
|
|
8f1f267eab | ||
|
|
6aae156cbf | ||
|
|
ec7ccb9cdf | ||
|
|
0bdcb1b09d | ||
|
|
889627a1fc | ||
|
|
6eaf9ce448 | ||
|
|
5cb5ef5c1e | ||
|
|
b2ea2bba7c | ||
|
|
7afaafe395 | ||
|
|
74ccf497a7 | ||
|
|
1ff8b0aa97 | ||
|
|
008c94be97 | ||
|
|
d2a1aac321 | ||
|
|
907cfca700 | ||
|
|
aeb70e35d0 | ||
|
|
87bdb7cd58 | ||
|
|
90dbe3183a | ||
|
|
ccff49c365 | ||
|
|
b07bac6999 | ||
|
|
dcddc72b18 | ||
|
|
591d498f7c | ||
|
|
b1b902eac3 | ||
|
|
ad603e2e66 | ||
|
|
e8423d9480 | ||
|
|
8783e65fd0 | ||
|
|
3a402640e1 | ||
|
|
387996f522 | ||
|
|
6589fbdcd1 | ||
|
|
97586f1313 | ||
|
|
041ff8984a | ||
|
|
925dd2419e | ||
|
|
3df6241d0b | ||
|
|
2178a02b6d | ||
|
|
c170ec368b | ||
|
|
f1f692b8c7 | ||
|
|
690a61d9c2 | ||
|
|
e1c8c15d05 | ||
|
|
c80882f3f7 | ||
|
|
1d2ad047bd | ||
|
|
bc1c4c63ec | ||
|
|
0eb55c9ca6 | ||
|
|
d5eaadc4dc | ||
|
|
eb0fd03f0d | ||
|
|
5dad6a62c6 | ||
|
|
3db513ac7d | ||
|
|
fe8f8f571b | ||
|
|
e65a0f1719 | ||
|
|
29ea6c0d75 | ||
|
|
c5d773bf41 | ||
|
|
35cf322f7b | ||
|
|
1d03f750b9 | ||
|
|
00eaf93095 | ||
|
|
d3a82b8467 | ||
|
|
85ce11cadc | ||
|
|
1b4f9dbf96 | ||
|
|
2f0a7b96d4 | ||
|
|
fa3519f1bb | ||
|
|
8afc3f323d | ||
|
|
7fd2b4ceda | ||
|
|
87bb486f1f | ||
|
|
18c735a920 | ||
|
|
331618b77a | ||
|
|
5f601ecf65 | ||
|
|
8eeef06c9c | ||
|
|
bc9335abcf | ||
|
|
792fedc759 | ||
|
|
e343455e77 | ||
|
|
7a7931b0d0 | ||
|
|
b3c26fd1a7 | ||
|
|
26fa0aef86 | ||
|
|
74ecefac8b | ||
|
|
8855195c09 | ||
|
|
227636620e | ||
|
|
5866739942 | ||
|
|
0eacb0e7c4 | ||
|
|
c0efb9a732 | ||
|
|
71484de76e | ||
|
|
be73efff0b | ||
|
|
a00c394526 | ||
|
|
3d57b22b26 | ||
|
|
995bbedbb6 | ||
|
|
d638acb5d2 | ||
|
|
f87006d3e8 | ||
|
|
fcab6f2532 | ||
|
|
4c552faaf5 | ||
|
|
7ea8776750 | ||
|
|
b9487a78df | ||
|
|
4addcb43e0 | ||
|
|
05444f54ad | ||
|
|
a7139cc510 | ||
|
|
ddbf96d1d1 | ||
|
|
a40e1f6ee9 | ||
|
|
b37ec6d21e | ||
|
|
b868a95db1 | ||
|
|
7d18553ff0 | ||
|
|
e83d09070a | ||
|
|
0794b8457e | ||
|
|
c6ba56222a | ||
|
|
e8f38b8d0a | ||
|
|
898fa0212d | ||
|
|
67a632bbc2 | ||
|
|
19c72dd7d3 | ||
|
|
f4e18606ce | ||
|
|
dfb04b01ca | ||
|
|
59185de71e | ||
|
|
ef52691a35 | ||
|
|
5ae5c02dbf | ||
|
|
3da49e7178 | ||
|
|
e8658f4d85 |
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
|
||||
1
.github/PROTECTED_BRANCHES
vendored
Normal file
1
.github/PROTECTED_BRANCHES
vendored
Normal file
@@ -0,0 +1 @@
|
||||
main
|
||||
42
.github/workflows/build_pr.yml
vendored
42
.github/workflows/build_pr.yml
vendored
@@ -1,42 +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 TS SDK
|
||||
id: buildTS
|
||||
run: |
|
||||
rm -rf plexjs/
|
||||
java -jar openapi-generator-cli.jar generate -i api-specs/referenced/plex-api-spec.yaml -g typescript-axios -o plexjs/ --global-property skipFormModel=false --config config.yaml
|
||||
|
||||
- name: Run npm install and build Typescript SDK
|
||||
id: buildSDK
|
||||
if: steps.buildTS.outcome == 'success'
|
||||
run: |
|
||||
cd plexjs
|
||||
npm install
|
||||
npm run build
|
||||
88
.github/workflows/bump_version.yml
vendored
88
.github/workflows/bump_version.yml
vendored
@@ -1,88 +0,0 @@
|
||||
name: "Update Typescript SDK 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 }}"' config.yaml
|
||||
|
||||
- name: Build TS SDK
|
||||
id: buildTS
|
||||
run: |
|
||||
rm -rf plexjs/
|
||||
java -jar openapi-generator-cli.jar generate -i api-specs/referenced/plex-api-spec.yaml -g typescript-axios -o plexjs/ --global-property skipFormModel=false --config config.yaml
|
||||
|
||||
- name: After SDK Build
|
||||
id: buildSDK
|
||||
if: steps.buildTS.outcome == 'success'
|
||||
run: |
|
||||
cd plexjs
|
||||
npm install
|
||||
npm run build
|
||||
|
||||
- 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: true
|
||||
prerelease: false
|
||||
21
.github/workflows/publish-to-npm.yml
vendored
21
.github/workflows/publish-to-npm.yml
vendored
@@ -1,21 +0,0 @@
|
||||
name: Publish SDK package to npmjs
|
||||
on:
|
||||
release:
|
||||
types: [created]
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 12
|
||||
- run: |
|
||||
cd plexjs
|
||||
npm ci
|
||||
|
||||
- id: publish
|
||||
uses: JS-DevTools/npm-publish@v1
|
||||
with:
|
||||
token: ${{ secrets.NPM_TOKEN }}
|
||||
package: ./plexjs/package.json
|
||||
54
.github/workflows/sdk_generation.yaml
vendored
Normal file
54
.github/workflows/sdk_generation.yaml
vendored
Normal file
@@ -0,0 +1,54 @@
|
||||
name: Generate and Publish to NPM and JSR
|
||||
|
||||
permissions:
|
||||
checks: write
|
||||
contents: write
|
||||
pull-requests: write
|
||||
statuses: write
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
force:
|
||||
description: Force generation of SDKs
|
||||
type: boolean
|
||||
default: false
|
||||
set_version:
|
||||
description: optionally set a specific SDK version
|
||||
type: string
|
||||
schedule:
|
||||
- cron: 0 0 * * *
|
||||
|
||||
jobs:
|
||||
generate:
|
||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
||||
with:
|
||||
force: ${{ github.event.inputs.force }}
|
||||
mode: direct
|
||||
set_version: ${{ github.event.inputs.set_version }}
|
||||
speakeasy_version: latest
|
||||
secrets:
|
||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
npm_token: ${{ secrets.NPM_TOKEN }}
|
||||
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||
|
||||
publish:
|
||||
runs-on: ubuntu-latest
|
||||
needs: generate
|
||||
permissions:
|
||||
contents: read
|
||||
id-token: write
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@v5
|
||||
with:
|
||||
node-version: 20
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm install
|
||||
|
||||
- name: Publish package
|
||||
run: npx jsr publish
|
||||
37
.gitignore
vendored
37
.gitignore
vendored
@@ -1,5 +1,32 @@
|
||||
node_modules
|
||||
build
|
||||
dist
|
||||
api-specs
|
||||
.env
|
||||
/examples/node_modules
|
||||
.env
|
||||
.env.local
|
||||
.env.*.local
|
||||
.DS_Store
|
||||
**/.speakeasy/temp/
|
||||
**/.speakeasy/logs/
|
||||
.DS_Store
|
||||
/mcp-server
|
||||
/bin
|
||||
/.eslintcache
|
||||
/.speakeasy/reports
|
||||
/react-query
|
||||
/sdk/models/errors
|
||||
/sdk/types
|
||||
/__tests__
|
||||
/funcs
|
||||
/core.*
|
||||
/esm
|
||||
/dist
|
||||
/.tshy
|
||||
/.tshy-*
|
||||
/hooks
|
||||
/models
|
||||
/models/errors
|
||||
/types
|
||||
/lib
|
||||
/sdk
|
||||
/index.*
|
||||
/cjs
|
||||
/node_modules
|
||||
/.tsbuildinfo
|
||||
|
||||
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__
|
||||
7542
.speakeasy/gen.lock
Executable file
7542
.speakeasy/gen.lock
Executable file
File diff suppressed because one or more lines are too long
72
.speakeasy/gen.yaml
Executable file
72
.speakeasy/gen.yaml
Executable file
@@ -0,0 +1,72 @@
|
||||
configVersion: 2.0.0
|
||||
generation:
|
||||
sdkClassName: Plex-API
|
||||
maintainOpenAPIOrder: true
|
||||
usageSnippets:
|
||||
optionalPropertyRendering: withExample
|
||||
sdkInitStyle: constructor
|
||||
useClassNamesForArrayFields: true
|
||||
fixes:
|
||||
nameResolutionDec2023: true
|
||||
nameResolutionFeb2025: true
|
||||
parameterOrderingFeb2024: true
|
||||
requestResponseComponentNamesFeb2024: true
|
||||
securityFeb2025: true
|
||||
sharedErrorComponentsApr2025: true
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
oAuth2PasswordEnabled: false
|
||||
hoistGlobalSecurity: true
|
||||
schemas:
|
||||
allOfMergeStrategy: shallowMerge
|
||||
requestBodyFieldName: ""
|
||||
tests:
|
||||
generateTests: true
|
||||
generateNewTests: true
|
||||
skipResponseBodyAssertions: false
|
||||
typescript:
|
||||
version: 0.43.0
|
||||
acceptHeaderEnum: true
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies: {}
|
||||
peerDependencies: {}
|
||||
additionalPackageJSON: {}
|
||||
additionalScripts: {}
|
||||
alwaysIncludeInboundAndOutbound: false
|
||||
author: LukeHagar
|
||||
baseErrorName: PlexAPIError
|
||||
clientServerStatusCodesAsErrors: true
|
||||
constFieldsAlwaysOptional: true
|
||||
defaultErrorName: SDKError
|
||||
enableCustomCodeRegions: false
|
||||
enableMCPServer: true
|
||||
enableReactQuery: false
|
||||
enumFormat: enum
|
||||
exportZodModelNamespace: false
|
||||
flattenGlobalSecurity: true
|
||||
flatteningOrder: body-first
|
||||
generateExamples: true
|
||||
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
|
||||
modelPropertyCasing: camel
|
||||
moduleFormat: commonjs
|
||||
outputModelSuffix: output
|
||||
packageName: '@lukehagar/plexjs'
|
||||
responseFormat: envelope
|
||||
sseFlatResponse: false
|
||||
templateVersion: v2
|
||||
unionStrategy: left-to-right
|
||||
usageSDKInitImports: []
|
||||
useIndexModules: true
|
||||
zodVersion: v3
|
||||
7782
.speakeasy/tests.arazzo.yaml
Normal file
7782
.speakeasy/tests.arazzo.yaml
Normal file
File diff suppressed because one or more lines are too long
47
.speakeasy/workflow.lock
Normal file
47
.speakeasy/workflow.lock
Normal file
@@ -0,0 +1,47 @@
|
||||
speakeasyVersion: 1.656.1
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
sourceRevisionDigest: sha256:1b8840d540c66b58d1009ec2581fb18464158ec9aa00464eac05ba737f31207e
|
||||
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
||||
tags:
|
||||
- latest
|
||||
- main
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:56fc783b16af019db4eb0fe52df504315e8e7c7ae41e319a61bba8823f19df4b
|
||||
sourceBlobDigest: sha256:b62613477fd824bb42cf0bf5d0f9980448259c9c7456e03ca6a10eef39a3994f
|
||||
tags:
|
||||
- latest
|
||||
- speakeasy-sdk-regen-1762992705
|
||||
- 1.1.1
|
||||
targets:
|
||||
plexjs:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:56fc783b16af019db4eb0fe52df504315e8e7c7ae41e319a61bba8823f19df4b
|
||||
sourceBlobDigest: sha256:b62613477fd824bb42cf0bf5d0f9980448259c9c7456e03ca6a10eef39a3994f
|
||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||
codeSamplesRevisionDigest: sha256:9c301d7b022dab8173b220aa8f2546378c973a75491335d1742c60d131abdf27
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
sources:
|
||||
plexapi:
|
||||
inputs:
|
||||
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/plex-api-spec.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/plex-api-spec.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
|
||||
129
FUNCTIONS.md
Normal file
129
FUNCTIONS.md
Normal file
@@ -0,0 +1,129 @@
|
||||
# Standalone Functions
|
||||
|
||||
> [!NOTE]
|
||||
> This section is useful if you are using a bundler and targetting browsers and
|
||||
> runtimes where the size of an application affects performance and load times.
|
||||
|
||||
Every method in this SDK is also available as a standalone function. This
|
||||
alternative API is suitable when targetting the browser or serverless runtimes
|
||||
and using a bundler to build your application since all unused functionality
|
||||
will be tree-shaken away. This includes code for unused methods, Zod schemas,
|
||||
encoding helpers and response handlers. The result is dramatically smaller
|
||||
impact on the application's final bundle size which grows very slowly as you use
|
||||
more and more functionality from this SDK.
|
||||
|
||||
Calling methods through the main SDK class remains a valid and generally more
|
||||
more ergonomic option. Standalone functions represent an optimisation for a
|
||||
specific category of applications.
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
|
||||
import { transcoderStartTranscodeSession } from "@lukehagar/plexjs/funcs/transcoderStartTranscodeSession.js";
|
||||
import { Extension, StartTranscodeSessionLocation, StartTranscodeSessionProtocol } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { Accepts, AdvancedSubtitles, BoolInt, TranscodeType } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
|
||||
// Use `PlexAPICore` for best tree-shaking performance.
|
||||
// You can create one instance of it to use across an application.
|
||||
const plexAPI = new PlexAPICore({
|
||||
accepts: Accepts.ApplicationXml,
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const res = await transcoderStartTranscodeSession(plexAPI, {
|
||||
transcodeType: TranscodeType.Music,
|
||||
extension: Extension.Mpd,
|
||||
advancedSubtitles: AdvancedSubtitles.Burn,
|
||||
audioBoost: 50,
|
||||
audioChannelCount: 5,
|
||||
autoAdjustQuality: BoolInt.One,
|
||||
autoAdjustSubtitle: BoolInt.One,
|
||||
directPlay: BoolInt.One,
|
||||
directStream: BoolInt.One,
|
||||
directStreamAudio: BoolInt.One,
|
||||
disableResolutionRotation: BoolInt.One,
|
||||
hasMDE: BoolInt.One,
|
||||
location: StartTranscodeSessionLocation.Wan,
|
||||
mediaBufferSize: 102400,
|
||||
mediaIndex: 0,
|
||||
musicBitrate: 5000,
|
||||
offset: 90.5,
|
||||
partIndex: 0,
|
||||
path: "/library/metadata/151671",
|
||||
peakBitrate: 12000,
|
||||
photoResolution: "1080x1080",
|
||||
protocol: StartTranscodeSessionProtocol.Dash,
|
||||
secondsPerSegment: 5,
|
||||
subtitleSize: 50,
|
||||
videoBitrate: 12000,
|
||||
videoQuality: 50,
|
||||
videoResolution: "1080x1080",
|
||||
xPlexClientProfileExtra: "add-limitation(scope=videoCodec&scopeName=*&type=upperBound&name=video.frameRate&value=60&replace=true)+append-transcode-target-codec(type=videoProfile&context=streaming&videoCodec=h264%2Chevc&audioCodec=aac&protocol=dash)",
|
||||
xPlexClientProfileName: "generic",
|
||||
});
|
||||
if (res.ok) {
|
||||
const { value: result } = res;
|
||||
console.log(result);
|
||||
} else {
|
||||
console.log("transcoderStartTranscodeSession failed:", res.error);
|
||||
}
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
## Result types
|
||||
|
||||
Standalone functions differ from SDK methods in that they return a
|
||||
`Result<Value, Error>` type to capture _known errors_ and document them using
|
||||
the type system. By avoiding throwing errors, application code maintains clear
|
||||
control flow and error-handling become part of the regular flow of application
|
||||
code.
|
||||
|
||||
> We use the term "known errors" because standalone functions, and JavaScript
|
||||
> code in general, can still throw unexpected errors such as `TypeError`s,
|
||||
> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
|
||||
> something this SDK addresses in the future. Nevertheless, there is still a lot
|
||||
> of benefit from capturing most errors and turning them into values.
|
||||
|
||||
The second reason for this style of programming is because these functions will
|
||||
typically be used in front-end applications where exception throwing is
|
||||
sometimes discouraged or considered unidiomatic. React and similar ecosystems
|
||||
and libraries tend to promote this style of programming so that components
|
||||
render useful content under all states (loading, success, error and so on).
|
||||
|
||||
The general pattern when calling standalone functions looks like this:
|
||||
|
||||
```typescript
|
||||
import { Core } from "<sdk-package-name>";
|
||||
import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
|
||||
|
||||
const client = new Core();
|
||||
|
||||
async function run() {
|
||||
const result = await fetchSomething(client, { id: "123" });
|
||||
if (!result.ok) {
|
||||
// You can throw the error or handle it. It's your choice now.
|
||||
throw result.error;
|
||||
}
|
||||
|
||||
console.log(result.value);
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
Notably, `result.error` above will have an explicit type compared to a try-catch
|
||||
variation where the error in the catch block can only be of type `unknown` (or
|
||||
`any` depending on your TypeScript settings).
|
||||
21
LICENSE.md
Normal file
21
LICENSE.md
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2023 LukeHagar
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
1441
RELEASES.md
Normal file
1441
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.
|
||||
70
USAGE.md
Normal file
70
USAGE.md
Normal file
@@ -0,0 +1,70 @@
|
||||
<!-- Start SDK Example Usage [usage] -->
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import {
|
||||
Extension,
|
||||
StartTranscodeSessionLocation,
|
||||
StartTranscodeSessionProtocol,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import {
|
||||
Accepts,
|
||||
AdvancedSubtitles,
|
||||
BoolInt,
|
||||
TranscodeType,
|
||||
} from "@lukehagar/plexjs/sdk/models/shared";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accepts: Accepts.ApplicationXml,
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.transcoder.startTranscodeSession({
|
||||
transcodeType: TranscodeType.Music,
|
||||
extension: Extension.Mpd,
|
||||
advancedSubtitles: AdvancedSubtitles.Burn,
|
||||
audioBoost: 50,
|
||||
audioChannelCount: 5,
|
||||
autoAdjustQuality: BoolInt.One,
|
||||
autoAdjustSubtitle: BoolInt.One,
|
||||
directPlay: BoolInt.One,
|
||||
directStream: BoolInt.One,
|
||||
directStreamAudio: BoolInt.One,
|
||||
disableResolutionRotation: BoolInt.One,
|
||||
hasMDE: BoolInt.One,
|
||||
location: StartTranscodeSessionLocation.Wan,
|
||||
mediaBufferSize: 102400,
|
||||
mediaIndex: 0,
|
||||
musicBitrate: 5000,
|
||||
offset: 90.5,
|
||||
partIndex: 0,
|
||||
path: "/library/metadata/151671",
|
||||
peakBitrate: 12000,
|
||||
photoResolution: "1080x1080",
|
||||
protocol: StartTranscodeSessionProtocol.Dash,
|
||||
secondsPerSegment: 5,
|
||||
subtitleSize: 50,
|
||||
videoBitrate: 12000,
|
||||
videoQuality: 50,
|
||||
videoResolution: "1080x1080",
|
||||
xPlexClientProfileExtra:
|
||||
"add-limitation(scope=videoCodec&scopeName=*&type=upperBound&name=video.frameRate&value=60&replace=true)+append-transcode-target-codec(type=videoProfile&context=streaming&videoCodec=h264%2Chevc&audioCodec=aac&protocol=dash)",
|
||||
xPlexClientProfileName: "generic",
|
||||
});
|
||||
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End SDK Example Usage [usage] -->
|
||||
7631
codeSamples.yaml
Normal file
7631
codeSamples.yaml
Normal file
File diff suppressed because it is too large
Load Diff
12
config.yaml
12
config.yaml
@@ -1,12 +0,0 @@
|
||||
templateDir: ./sdk-resources
|
||||
files:
|
||||
package.mustache:
|
||||
templateType: SupportingFiles
|
||||
destinationFilename: package.json
|
||||
npmName: plexjs
|
||||
npmRepository: lukehagar
|
||||
npmVersion: 0.0.10
|
||||
useSingleRequestParameter: true
|
||||
sortParamsByRequiredFlag: true
|
||||
gitUserID: lukehagar
|
||||
gitRepoID: plexjs
|
||||
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` |
|
||||
16
docs/sdk/models/operations/account.md
Normal file
16
docs/sdk/models/operations/account.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# Account
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Account } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Account = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `globalViewCount` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||
19
docs/sdk/models/operations/action.md
Normal file
19
docs/sdk/models/operations/action.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# Action
|
||||
|
||||
The action to perform for this item on this optimizer queue
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Action } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Action = Action.Enable;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| `Reprocess` | reprocess |
|
||||
| `Disable` | disable |
|
||||
| `Enable` | enable |
|
||||
23
docs/sdk/models/operations/activity.md
Normal file
23
docs/sdk/models/operations/activity.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# Activity
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Activity } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Activity = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `cancellable` | *boolean* | :heavy_minus_sign: | Indicates whether this activity can be cancelled |
|
||||
| `context` | Record<string, *any*> | :heavy_minus_sign: | An object with additional values |
|
||||
| `progress` | *number* | :heavy_minus_sign: | A progress percentage. A value of -1 means the progress is indeterminate |
|
||||
| `response` | Record<string, *any*> | :heavy_minus_sign: | An object with the response to the async opperation |
|
||||
| `subtitle` | *string* | :heavy_minus_sign: | A user-friendly sub-title for this activity |
|
||||
| `title` | *string* | :heavy_minus_sign: | A user-friendly title for this activity |
|
||||
| `type` | *string* | :heavy_minus_sign: | The type of activity |
|
||||
| `userID` | *number* | :heavy_minus_sign: | The user this activity belongs to |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | The ID of the activity |
|
||||
36
docs/sdk/models/operations/addcollectionitemsglobals.md
Normal file
36
docs/sdk/models/operations/addcollectionitemsglobals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# AddCollectionItemsGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddCollectionItemsGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddCollectionItemsGlobals = {
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
30
docs/sdk/models/operations/addcollectionitemsrequest.md
Normal file
30
docs/sdk/models/operations/addcollectionitemsrequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AddCollectionItemsRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddCollectionItemsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddCollectionItemsRequest = {
|
||||
collectionId: 705686,
|
||||
uri: "https://mad-handle.biz/",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `collectionId` | *number* | :heavy_check_mark: | The collection id | |
|
||||
| `uri` | *string* | :heavy_check_mark: | The URI describing the items to add to this collection | |
|
||||
21
docs/sdk/models/operations/addcollectionitemsresponse.md
Normal file
21
docs/sdk/models/operations/addcollectionitemsresponse.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# AddCollectionItemsResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddCollectionItemsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddCollectionItemsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 637232,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `mediaContainerWithMetadata` | [shared.MediaContainerWithMetadata](../../../sdk/models/shared/mediacontainerwithmetadata.md) | :heavy_minus_sign: | OK |
|
||||
36
docs/sdk/models/operations/adddeviceglobals.md
Normal file
36
docs/sdk/models/operations/adddeviceglobals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# AddDeviceGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddDeviceGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddDeviceGlobals = {
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
28
docs/sdk/models/operations/adddevicerequest.md
Normal file
28
docs/sdk/models/operations/adddevicerequest.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# AddDeviceRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddDeviceRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddDeviceRequest = {
|
||||
uri: "http://10.0.0.5",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `uri` | *string* | :heavy_minus_sign: | The URI of the device. | http://10.0.0.5 |
|
||||
21
docs/sdk/models/operations/adddeviceresponse.md
Normal file
21
docs/sdk/models/operations/adddeviceresponse.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# AddDeviceResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddDeviceResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddDeviceResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 298653,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `mediaContainerWithDevice` | [shared.MediaContainerWithDevice](../../../sdk/models/shared/mediacontainerwithdevice.md) | :heavy_minus_sign: | OK |
|
||||
19
docs/sdk/models/operations/adddevicetodvrdvr.md
Normal file
19
docs/sdk/models/operations/adddevicetodvrdvr.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# AddDeviceToDVRDVR
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddDeviceToDVRDVR } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddDeviceToDVRDVR = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `device` | [shared.Device](../../../sdk/models/shared/device.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `language` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `lineup` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | N/A |
|
||||
36
docs/sdk/models/operations/adddevicetodvrglobals.md
Normal file
36
docs/sdk/models/operations/adddevicetodvrglobals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# AddDeviceToDVRGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddDeviceToDVRGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddDeviceToDVRGlobals = {
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
16
docs/sdk/models/operations/adddevicetodvrmediacontainer.md
Normal file
16
docs/sdk/models/operations/adddevicetodvrmediacontainer.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# AddDeviceToDVRMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddDeviceToDVRMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddDeviceToDVRMediaContainer = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.AddDeviceToDVRMediaContainerMediaContainer](../../../sdk/models/operations/adddevicetodvrmediacontainermediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
| `dvr` | [operations.AddDeviceToDVRDVR](../../../sdk/models/operations/adddevicetodvrdvr.md)[] | :heavy_minus_sign: | N/A |
|
||||
@@ -0,0 +1,24 @@
|
||||
# AddDeviceToDVRMediaContainerMediaContainer
|
||||
|
||||
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
|
||||
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
|
||||
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddDeviceToDVRMediaContainerMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddDeviceToDVRMediaContainerMediaContainer = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `identifier` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `offset` | *number* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `totalSize` | *number* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
|
||||
| `status` | *number* | :heavy_minus_sign: | A status indicator. If present and non-zero, indicates an error |
|
||||
30
docs/sdk/models/operations/adddevicetodvrrequest.md
Normal file
30
docs/sdk/models/operations/adddevicetodvrrequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AddDeviceToDVRRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddDeviceToDVRRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddDeviceToDVRRequest = {
|
||||
dvrId: 595771,
|
||||
deviceId: 611322,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `dvrId` | *number* | :heavy_check_mark: | The ID of the DVR. | |
|
||||
| `deviceId` | *number* | :heavy_check_mark: | The ID of the device to add. | |
|
||||
29
docs/sdk/models/operations/adddevicetodvrresponse.md
Normal file
29
docs/sdk/models/operations/adddevicetodvrresponse.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# AddDeviceToDVRResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddDeviceToDVRResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddDeviceToDVRResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 350017,
|
||||
headers: {
|
||||
"key": [
|
||||
"<value 1>",
|
||||
"<value 2>",
|
||||
"<value 3>",
|
||||
],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.AddDeviceToDVRResponseBody](../../../sdk/models/operations/adddevicetodvrresponsebody.md) | :heavy_minus_sign: | OK |
|
||||
| `headers` | Record<string, *string*[]> | :heavy_check_mark: | N/A |
|
||||
17
docs/sdk/models/operations/adddevicetodvrresponsebody.md
Normal file
17
docs/sdk/models/operations/adddevicetodvrresponsebody.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# AddDeviceToDVRResponseBody
|
||||
|
||||
OK
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddDeviceToDVRResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddDeviceToDVRResponseBody = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.AddDeviceToDVRMediaContainer](../../../sdk/models/operations/adddevicetodvrmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
36
docs/sdk/models/operations/adddownloadqueueitemsglobals.md
Normal file
36
docs/sdk/models/operations/adddownloadqueueitemsglobals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# AddDownloadQueueItemsGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddDownloadQueueItemsGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddDownloadQueueItemsGlobals = {
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
@@ -0,0 +1,24 @@
|
||||
# AddDownloadQueueItemsMediaContainer
|
||||
|
||||
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
|
||||
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
|
||||
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddDownloadQueueItemsMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddDownloadQueueItemsMediaContainer = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `identifier` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `offset` | *number* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `totalSize` | *number* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
|
||||
| `addedQueueItems` | [operations.AddedQueueItem](../../../sdk/models/operations/addedqueueitem.md)[] | :heavy_minus_sign: | N/A |
|
||||
86
docs/sdk/models/operations/adddownloadqueueitemsrequest.md
Normal file
86
docs/sdk/models/operations/adddownloadqueueitemsrequest.md
Normal file
@@ -0,0 +1,86 @@
|
||||
# AddDownloadQueueItemsRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddDownloadQueueItemsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { AdvancedSubtitles, BoolInt, LocationParameter, Protocol, Subtitles } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
|
||||
let value: AddDownloadQueueItemsRequest = {
|
||||
queueId: 44894,
|
||||
keys: [
|
||||
"/library/metadata/3",
|
||||
"/library/metadata/6",
|
||||
],
|
||||
advancedSubtitles: AdvancedSubtitles.Burn,
|
||||
audioBoost: 50,
|
||||
audioChannelCount: 5,
|
||||
autoAdjustQuality: BoolInt.One,
|
||||
autoAdjustSubtitle: BoolInt.One,
|
||||
directPlay: BoolInt.One,
|
||||
directStream: BoolInt.One,
|
||||
directStreamAudio: BoolInt.One,
|
||||
disableResolutionRotation: BoolInt.One,
|
||||
hasMDE: BoolInt.One,
|
||||
location: LocationParameter.Wan,
|
||||
mediaBufferSize: 102400,
|
||||
mediaIndex: 0,
|
||||
musicBitrate: 5000,
|
||||
offset: 90.5,
|
||||
partIndex: 0,
|
||||
path: "/library/metadata/151671",
|
||||
peakBitrate: 12000,
|
||||
photoResolution: "1080x1080",
|
||||
protocol: Protocol.Dash,
|
||||
secondsPerSegment: 5,
|
||||
subtitleSize: 50,
|
||||
subtitles: Subtitles.Sidecar,
|
||||
videoBitrate: 12000,
|
||||
videoQuality: 50,
|
||||
videoResolution: "1080x1080",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `queueId` | *number* | :heavy_check_mark: | The queue id | |
|
||||
| `keys` | *string*[] | :heavy_check_mark: | Keys to add | [<br/>"/library/metadata/3",<br/>"/library/metadata/6"<br/>] |
|
||||
| `advancedSubtitles` | [shared.AdvancedSubtitles](../../../sdk/models/shared/advancedsubtitles.md) | :heavy_minus_sign: | Indicates how incompatible advanced subtitles (such as ass/ssa) should be included: * 'burn' - Burn incompatible advanced text subtitles into the video stream * 'text' - Transcode incompatible advanced text subtitles to a compatible text format, even if some markup is lost<br/> | burn |
|
||||
| `audioBoost` | *number* | :heavy_minus_sign: | Percentage of original audio loudness to use when transcoding (100 is equivalent to original volume, 50 is half, 200 is double, etc) | 50 |
|
||||
| `audioChannelCount` | *number* | :heavy_minus_sign: | Target video number of audio channels. | 5 |
|
||||
| `autoAdjustQuality` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports ABR. | 1 |
|
||||
| `autoAdjustSubtitle` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates if the server should adjust subtitles based on Voice Activity Data. | 1 |
|
||||
| `directPlay` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports direct playing the indicated content. | 1 |
|
||||
| `directStream` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports direct streaming the video of the indicated content. | 1 |
|
||||
| `directStreamAudio` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports direct streaming the audio of the indicated content. | 1 |
|
||||
| `disableResolutionRotation` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates if resolution should be adjusted for orientation. | 1 |
|
||||
| `hasMDE` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Ignore client profiles when determining if direct play is possible. Only has an effect when directPlay=1 and both mediaIndex and partIndex are specified and neither are -1 | 1 |
|
||||
| `location` | [shared.LocationParameter](../../../sdk/models/shared/locationparameter.md) | :heavy_minus_sign: | Network type of the client, can be used to help determine target bitrate. | wan |
|
||||
| `mediaBufferSize` | *number* | :heavy_minus_sign: | Buffer size used in playback (in KB). Clients should specify a lower bound if not known exactly. This value could make the difference between transcoding and direct play on bandwidth constrained networks. | 102400 |
|
||||
| `mediaIndex` | *number* | :heavy_minus_sign: | Index of the media to transcode. -1 or not specified indicates let the server choose. | 0 |
|
||||
| `musicBitrate` | *number* | :heavy_minus_sign: | Target bitrate for audio only files (in kbps, used to transcode). | 5000 |
|
||||
| `offset` | *number* | :heavy_minus_sign: | Offset from the start of the media (in seconds). | 90.5 |
|
||||
| `partIndex` | *number* | :heavy_minus_sign: | Index of the part to transcode. -1 or not specified indicates the server should join parts together in a transcode | 0 |
|
||||
| `path` | *string* | :heavy_minus_sign: | Internal PMS path of the media to transcode. | /library/metadata/151671 |
|
||||
| `peakBitrate` | *number* | :heavy_minus_sign: | Maximum bitrate (in kbps) to use in ABR. | 12000 |
|
||||
| `photoResolution` | *string* | :heavy_minus_sign: | Target photo resolution. | 1080x1080 |
|
||||
| `protocol` | [shared.Protocol](../../../sdk/models/shared/protocol.md) | :heavy_minus_sign: | Indicates the network streaming protocol to be used for the transcode session: * 'http' - include the file in the http response such as MKV streaming * 'hls' - hls stream (RFC 8216) * 'dash' - dash stream (ISO/IEC 23009-1:2022)<br/> | dash |
|
||||
| `secondsPerSegment` | *number* | :heavy_minus_sign: | Number of seconds to include in each transcoded segment | 5 |
|
||||
| `subtitleSize` | *number* | :heavy_minus_sign: | Percentage of original subtitle size to use when burning subtitles (100 is equivalent to original size, 50 is half, ect) | 50 |
|
||||
| `subtitles` | [shared.Subtitles](../../../sdk/models/shared/subtitles.md) | :heavy_minus_sign: | Indicates how subtitles should be included: * 'auto' - Compute the appropriate subtitle setting automatically * 'burn' - Burn the selected subtitle; auto if no selected subtitle * 'none' - Ignore all subtitle streams * 'sidecar' - The selected subtitle should be provided as a sidecar * 'embedded' - The selected subtitle should be provided as an embedded stream * 'segmented' - The selected subtitle should be provided as a segmented stream<br/> | Burn |
|
||||
| `videoBitrate` | *number* | :heavy_minus_sign: | Target video bitrate (in kbps). | 12000 |
|
||||
| `videoQuality` | *number* | :heavy_minus_sign: | Target photo quality. | 50 |
|
||||
| `videoResolution` | *string* | :heavy_minus_sign: | Target maximum video resolution. | 1080x1080 |
|
||||
21
docs/sdk/models/operations/adddownloadqueueitemsresponse.md
Normal file
21
docs/sdk/models/operations/adddownloadqueueitemsresponse.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# AddDownloadQueueItemsResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddDownloadQueueItemsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddDownloadQueueItemsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 35315,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.AddDownloadQueueItemsResponseBody](../../../sdk/models/operations/adddownloadqueueitemsresponsebody.md) | :heavy_minus_sign: | OK |
|
||||
@@ -0,0 +1,17 @@
|
||||
# AddDownloadQueueItemsResponseBody
|
||||
|
||||
OK
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddDownloadQueueItemsResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddDownloadQueueItemsResponseBody = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.AddDownloadQueueItemsMediaContainer](../../../sdk/models/operations/adddownloadqueueitemsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
16
docs/sdk/models/operations/addedqueueitem.md
Normal file
16
docs/sdk/models/operations/addedqueueitem.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# AddedQueueItem
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddedQueueItem } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddedQueueItem = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | The queue item id that was added or the existing one if an item already exists in this queue with the same parameters |
|
||||
| `key` | *string* | :heavy_minus_sign: | The key added to the queue |
|
||||
36
docs/sdk/models/operations/addextrasglobals.md
Normal file
36
docs/sdk/models/operations/addextrasglobals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# AddExtrasGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddExtrasGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddExtrasGlobals = {
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
32
docs/sdk/models/operations/addextrasrequest.md
Normal file
32
docs/sdk/models/operations/addextrasrequest.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# AddExtrasRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddExtrasRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddExtrasRequest = {
|
||||
ids: "<value>",
|
||||
url: "https://agitated-tribe.name/",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `ids` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `extraType` | *number* | :heavy_minus_sign: | The metadata type of the extra | |
|
||||
| `url` | *string* | :heavy_check_mark: | The URL of the extra | |
|
||||
| `title` | *string* | :heavy_minus_sign: | The title to filter by or assign | |
|
||||
20
docs/sdk/models/operations/addextrasresponse.md
Normal file
20
docs/sdk/models/operations/addextrasresponse.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# AddExtrasResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddExtrasResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddExtrasResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 968715,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
19
docs/sdk/models/operations/addlineupdvr.md
Normal file
19
docs/sdk/models/operations/addlineupdvr.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# AddLineupDVR
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddLineupDVR } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddLineupDVR = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `device` | [shared.Device](../../../sdk/models/shared/device.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `language` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `lineup` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | N/A |
|
||||
36
docs/sdk/models/operations/addlineupglobals.md
Normal file
36
docs/sdk/models/operations/addlineupglobals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# AddLineupGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddLineupGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddLineupGlobals = {
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
16
docs/sdk/models/operations/addlineupmediacontainer.md
Normal file
16
docs/sdk/models/operations/addlineupmediacontainer.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# AddLineupMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddLineupMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddLineupMediaContainer = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.AddLineupMediaContainerMediaContainer](../../../sdk/models/operations/addlineupmediacontainermediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
| `dvr` | [operations.AddLineupDVR](../../../sdk/models/operations/addlineupdvr.md)[] | :heavy_minus_sign: | N/A |
|
||||
@@ -0,0 +1,24 @@
|
||||
# AddLineupMediaContainerMediaContainer
|
||||
|
||||
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
|
||||
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
|
||||
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddLineupMediaContainerMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddLineupMediaContainerMediaContainer = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `identifier` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `offset` | *number* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `totalSize` | *number* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
|
||||
| `status` | *number* | :heavy_minus_sign: | A status indicator. If present and non-zero, indicates an error |
|
||||
30
docs/sdk/models/operations/addlineuprequest.md
Normal file
30
docs/sdk/models/operations/addlineuprequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AddLineupRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddLineupRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddLineupRequest = {
|
||||
dvrId: 950730,
|
||||
lineup: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `dvrId` | *number* | :heavy_check_mark: | The ID of the DVR. | |
|
||||
| `lineup` | *string* | :heavy_check_mark: | The lineup to delete | |
|
||||
23
docs/sdk/models/operations/addlineupresponse.md
Normal file
23
docs/sdk/models/operations/addlineupresponse.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# AddLineupResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddLineupResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddLineupResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 652088,
|
||||
headers: {},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.AddLineupResponseBody](../../../sdk/models/operations/addlineupresponsebody.md) | :heavy_minus_sign: | OK |
|
||||
| `headers` | Record<string, *string*[]> | :heavy_check_mark: | N/A |
|
||||
17
docs/sdk/models/operations/addlineupresponsebody.md
Normal file
17
docs/sdk/models/operations/addlineupresponsebody.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# AddLineupResponseBody
|
||||
|
||||
OK
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddLineupResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddLineupResponseBody = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.AddLineupMediaContainer](../../../sdk/models/operations/addlineupmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
36
docs/sdk/models/operations/addplaylistitemsglobals.md
Normal file
36
docs/sdk/models/operations/addplaylistitemsglobals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# AddPlaylistItemsGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddPlaylistItemsGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddPlaylistItemsGlobals = {
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
30
docs/sdk/models/operations/addplaylistitemsrequest.md
Normal file
30
docs/sdk/models/operations/addplaylistitemsrequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AddPlaylistItemsRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddPlaylistItemsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddPlaylistItemsRequest = {
|
||||
playlistId: 174404,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `playlistId` | *number* | :heavy_check_mark: | The ID of the playlist | |
|
||||
| `uri` | *string* | :heavy_minus_sign: | The content URI for the playlist. | |
|
||||
| `playQueueID` | *number* | :heavy_minus_sign: | The play queue to add to a playlist. | |
|
||||
21
docs/sdk/models/operations/addplaylistitemsresponse.md
Normal file
21
docs/sdk/models/operations/addplaylistitemsresponse.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# AddPlaylistItemsResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddPlaylistItemsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddPlaylistItemsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 789450,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `mediaContainerWithPlaylistMetadata` | [shared.MediaContainerWithPlaylistMetadata](../../../sdk/models/shared/mediacontainerwithplaylistmetadata.md) | :heavy_minus_sign: | OK |
|
||||
36
docs/sdk/models/operations/addproviderglobals.md
Normal file
36
docs/sdk/models/operations/addproviderglobals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# AddProviderGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddProviderGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddProviderGlobals = {
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
28
docs/sdk/models/operations/addproviderrequest.md
Normal file
28
docs/sdk/models/operations/addproviderrequest.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# AddProviderRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddProviderRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddProviderRequest = {
|
||||
url: "https://bright-unique.biz/",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `url` | *string* | :heavy_check_mark: | The URL of the media provider to add. | |
|
||||
20
docs/sdk/models/operations/addproviderresponse.md
Normal file
20
docs/sdk/models/operations/addproviderresponse.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# AddProviderResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddProviderResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddProviderResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 30014,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
36
docs/sdk/models/operations/addsectionglobals.md
Normal file
36
docs/sdk/models/operations/addsectionglobals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# AddSectionGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddSectionGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddSectionGlobals = {
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
16
docs/sdk/models/operations/addsectionprefs.md
Normal file
16
docs/sdk/models/operations/addsectionprefs.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# AddSectionPrefs
|
||||
|
||||
The preferences for this section
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddSectionPrefs } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddSectionPrefs = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
48
docs/sdk/models/operations/addsectionrequest.md
Normal file
48
docs/sdk/models/operations/addsectionrequest.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# AddSectionRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddSectionRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
|
||||
let value: AddSectionRequest = {
|
||||
name: "<value>",
|
||||
type: 583726,
|
||||
agent: "<value>",
|
||||
language: "<value>",
|
||||
locations: [
|
||||
"O:\fatboy\\Media\\Ripped\\Music",
|
||||
"O:\fatboy\\Media\\My Music",
|
||||
],
|
||||
prefs: {},
|
||||
relative: BoolInt.One,
|
||||
importFromiTunes: BoolInt.One,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `name` | *string* | :heavy_check_mark: | The name of the new section | |
|
||||
| `type` | *number* | :heavy_check_mark: | The type of library section | |
|
||||
| `scanner` | *string* | :heavy_minus_sign: | The scanner this section should use | |
|
||||
| `agent` | *string* | :heavy_check_mark: | The agent this section should use for metadata | |
|
||||
| `metadataAgentProviderGroupId` | *string* | :heavy_minus_sign: | The agent group id for this section | |
|
||||
| `language` | *string* | :heavy_check_mark: | The language of this section | |
|
||||
| `locations` | *string*[] | :heavy_minus_sign: | The locations on disk to add to this section | [<br/>"O:\\fatboy\\Media\\Ripped\\Music",<br/>"O:\\fatboy\\Media\\My Music"<br/>] |
|
||||
| `prefs` | [operations.AddSectionPrefs](../../../sdk/models/operations/addsectionprefs.md) | :heavy_minus_sign: | The preferences for this section | {<br/>"collectionMode": 2,<br/>"hidden": 0<br/>} |
|
||||
| `relative` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | If set, paths are relative to `Media Upload` path | 1 |
|
||||
| `importFromiTunes` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | If set, import media from iTunes. | 1 |
|
||||
21
docs/sdk/models/operations/addsectionresponse.md
Normal file
21
docs/sdk/models/operations/addsectionresponse.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# AddSectionResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddSectionResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddSectionResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 465224,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `slashGetResponses200` | [shared.SlashGetResponses200](../../../sdk/models/shared/slashgetresponses200.md) | :heavy_minus_sign: | OK |
|
||||
36
docs/sdk/models/operations/addsubtitlesglobals.md
Normal file
36
docs/sdk/models/operations/addsubtitlesglobals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# AddSubtitlesGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddSubtitlesGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddSubtitlesGlobals = {
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
38
docs/sdk/models/operations/addsubtitlesrequest.md
Normal file
38
docs/sdk/models/operations/addsubtitlesrequest.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# AddSubtitlesRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddSubtitlesRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
|
||||
let value: AddSubtitlesRequest = {
|
||||
ids: "<value>",
|
||||
forced: BoolInt.One,
|
||||
hearingImpaired: BoolInt.One,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `ids` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | |
|
||||
| `language` | *string* | :heavy_minus_sign: | N/A | |
|
||||
| `mediaItemID` | *number* | :heavy_minus_sign: | N/A | |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL of the subtitle. If not provided, the contents of the subtitle must be in the post body | |
|
||||
| `format` | *string* | :heavy_minus_sign: | N/A | |
|
||||
| `forced` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `hearingImpaired` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
20
docs/sdk/models/operations/addsubtitlesresponse.md
Normal file
20
docs/sdk/models/operations/addsubtitlesresponse.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# AddSubtitlesResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddSubtitlesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddSubtitlesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 406595,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
36
docs/sdk/models/operations/addtoplayqueueglobals.md
Normal file
36
docs/sdk/models/operations/addtoplayqueueglobals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# AddToPlayQueueGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddToPlayQueueGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddToPlayQueueGlobals = {
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
33
docs/sdk/models/operations/addtoplayqueuerequest.md
Normal file
33
docs/sdk/models/operations/addtoplayqueuerequest.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# AddToPlayQueueRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddToPlayQueueRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
|
||||
let value: AddToPlayQueueRequest = {
|
||||
playQueueId: 354193,
|
||||
next: BoolInt.One,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `playQueueId` | *number* | :heavy_check_mark: | The ID of the play queue. | |
|
||||
| `uri` | *string* | :heavy_minus_sign: | The content URI for what we're adding to the queue. | |
|
||||
| `playlistID` | *string* | :heavy_minus_sign: | The ID of the playlist to add to the playQueue. | |
|
||||
| `next` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Play this item next (defaults to 0 - queueing at the end of manually queued items). | 1 |
|
||||
21
docs/sdk/models/operations/addtoplayqueueresponse.md
Normal file
21
docs/sdk/models/operations/addtoplayqueueresponse.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# AddToPlayQueueResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddToPlayQueueResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddToPlayQueueResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 727375,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `mediaContainerWithPlaylistMetadata` | [shared.MediaContainerWithPlaylistMetadata](../../../sdk/models/shared/mediacontainerwithplaylistmetadata.md) | :heavy_minus_sign: | OK |
|
||||
20
docs/sdk/models/operations/advancedsubtitles.md
Normal file
20
docs/sdk/models/operations/advancedsubtitles.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# AdvancedSubtitles
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AdvancedSubtitles } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AdvancedSubtitles = AdvancedSubtitles.Auto;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| `Auto` | auto |
|
||||
| `Burn` | burn |
|
||||
| `None` | none |
|
||||
| `Sidecar` | sidecar |
|
||||
| `Embedded` | embedded |
|
||||
| `Segmented` | segmented |
|
||||
36
docs/sdk/models/operations/analyzemetadataglobals.md
Normal file
36
docs/sdk/models/operations/analyzemetadataglobals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# AnalyzeMetadataGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AnalyzeMetadataGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AnalyzeMetadataGlobals = {
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
30
docs/sdk/models/operations/analyzemetadatarequest.md
Normal file
30
docs/sdk/models/operations/analyzemetadatarequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AnalyzeMetadataRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AnalyzeMetadataRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AnalyzeMetadataRequest = {
|
||||
ids: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `ids` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `thumbOffset` | *number* | :heavy_minus_sign: | Set the offset to be used for thumbnails | |
|
||||
| `artOffset` | *number* | :heavy_minus_sign: | Set the offset to be used for artwork | |
|
||||
20
docs/sdk/models/operations/analyzemetadataresponse.md
Normal file
20
docs/sdk/models/operations/analyzemetadataresponse.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# AnalyzeMetadataResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AnalyzeMetadataResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AnalyzeMetadataResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 941124,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
36
docs/sdk/models/operations/applyupdatesglobals.md
Normal file
36
docs/sdk/models/operations/applyupdatesglobals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# ApplyUpdatesGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ApplyUpdatesGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ApplyUpdatesGlobals = {
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
31
docs/sdk/models/operations/applyupdatesrequest.md
Normal file
31
docs/sdk/models/operations/applyupdatesrequest.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# ApplyUpdatesRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ApplyUpdatesRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
|
||||
let value: ApplyUpdatesRequest = {
|
||||
tonight: BoolInt.One,
|
||||
skip: BoolInt.One,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `tonight` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install immediately. | 1 |
|
||||
| `skip` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The <Release> entry for this version will have the `state` set to `skipped`. | 1 |
|
||||
20
docs/sdk/models/operations/applyupdatesresponse.md
Normal file
20
docs/sdk/models/operations/applyupdatesresponse.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# ApplyUpdatesResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ApplyUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ApplyUpdatesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 99456,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
36
docs/sdk/models/operations/autocompleteglobals.md
Normal file
36
docs/sdk/models/operations/autocompleteglobals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# AutocompleteGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AutocompleteGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AutocompleteGlobals = {
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
31
docs/sdk/models/operations/autocompleterequest.md
Normal file
31
docs/sdk/models/operations/autocompleterequest.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AutocompleteRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AutocompleteRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AutocompleteRequest = {
|
||||
sectionId: 594987,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `sectionId` | *number* | :heavy_check_mark: | Section identifier | |
|
||||
| `type` | *number* | :heavy_minus_sign: | Item type | |
|
||||
| `fieldQuery` | *string* | :heavy_minus_sign: | The "field" stands in for any field, the value is a partial string for matching | |
|
||||
| `mediaQuery` | [shared.MediaQuery](../../../sdk/models/shared/mediaquery.md) | :heavy_minus_sign: | This is a complex query built of several parameters. See [API Info section](#section/API-Info/Media-Queries) for information on building media queries | |
|
||||
34
docs/sdk/models/operations/autocompleteresponse.md
Normal file
34
docs/sdk/models/operations/autocompleteresponse.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# AutocompleteResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AutocompleteResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AutocompleteResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 451053,
|
||||
headers: {
|
||||
"key": [
|
||||
"<value 1>",
|
||||
],
|
||||
"key1": [
|
||||
"<value 1>",
|
||||
],
|
||||
"key2": [
|
||||
"<value 1>",
|
||||
"<value 2>",
|
||||
],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `mediaContainerWithMetadata` | [shared.MediaContainerWithMetadata](../../../sdk/models/shared/mediacontainerwithmetadata.md) | :heavy_minus_sign: | OK |
|
||||
| `headers` | Record<string, *string*[]> | :heavy_check_mark: | N/A |
|
||||
17
docs/sdk/models/operations/bandwidth.md
Normal file
17
docs/sdk/models/operations/bandwidth.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Bandwidth
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Bandwidth } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Bandwidth = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
|
||||
| `bandwidth` | *number* | :heavy_minus_sign: | The bandwidth at this time in kbps |
|
||||
| `resolution` | *string* | :heavy_minus_sign: | The user-friendly resolution at this time |
|
||||
| `time` | *number* | :heavy_minus_sign: | Media playback time where this bandwidth started |
|
||||
17
docs/sdk/models/operations/bandwidths.md
Normal file
17
docs/sdk/models/operations/bandwidths.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Bandwidths
|
||||
|
||||
A list of media times and bandwidths when trascoding is using with auto adjustment of bandwidth
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Bandwidths } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Bandwidths = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `bandwidth` | [operations.Bandwidth](../../../sdk/models/operations/bandwidth.md)[] | :heavy_minus_sign: | N/A |
|
||||
20
docs/sdk/models/operations/butlertask.md
Normal file
20
docs/sdk/models/operations/butlertask.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# ButlerTask
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ButlerTask } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ButlerTask = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `description` | *string* | :heavy_minus_sign: | A user-friendly description of the task |
|
||||
| `enabled` | *boolean* | :heavy_minus_sign: | Whether this task is enabled or not |
|
||||
| `interval` | *number* | :heavy_minus_sign: | The interval (in days) of when this task is run. A value of 1 is run every day, 7 is every week, etc. |
|
||||
| `name` | *string* | :heavy_minus_sign: | The name of the task |
|
||||
| `scheduleRandomized` | *boolean* | :heavy_minus_sign: | Indicates whether the timing of the task is randomized within the butler interval |
|
||||
| `title` | *string* | :heavy_minus_sign: | A user-friendly title of the task |
|
||||
15
docs/sdk/models/operations/butlertasks.md
Normal file
15
docs/sdk/models/operations/butlertasks.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# ButlerTasks
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ButlerTasks } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ButlerTasks = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||||
| `butlerTask` | [operations.ButlerTask](../../../sdk/models/operations/butlertask.md)[] | :heavy_minus_sign: | N/A |
|
||||
36
docs/sdk/models/operations/cancelactivityglobals.md
Normal file
36
docs/sdk/models/operations/cancelactivityglobals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# CancelActivityGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CancelActivityGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CancelActivityGlobals = {
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
28
docs/sdk/models/operations/cancelactivityrequest.md
Normal file
28
docs/sdk/models/operations/cancelactivityrequest.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# CancelActivityRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CancelActivityRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CancelActivityRequest = {
|
||||
activityId: "d6199ba1-fb5e-4cae-bf17-1a5369c1cf1e",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `activityId` | *string* | :heavy_check_mark: | The UUID of the activity to cancel. | d6199ba1-fb5e-4cae-bf17-1a5369c1cf1e |
|
||||
20
docs/sdk/models/operations/cancelactivityresponse.md
Normal file
20
docs/sdk/models/operations/cancelactivityresponse.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# CancelActivityResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CancelActivityResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CancelActivityResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 891380,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
36
docs/sdk/models/operations/cancelgrabglobals.md
Normal file
36
docs/sdk/models/operations/cancelgrabglobals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# CancelGrabGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CancelGrabGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CancelGrabGlobals = {
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
28
docs/sdk/models/operations/cancelgrabrequest.md
Normal file
28
docs/sdk/models/operations/cancelgrabrequest.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# CancelGrabRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CancelGrabRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CancelGrabRequest = {
|
||||
operationId: "<id>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `operationId` | *string* | :heavy_check_mark: | The ID of the operation. | |
|
||||
20
docs/sdk/models/operations/cancelgrabresponse.md
Normal file
20
docs/sdk/models/operations/cancelgrabresponse.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# CancelGrabResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CancelGrabResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CancelGrabResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 762769,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
36
docs/sdk/models/operations/cancelrefreshglobals.md
Normal file
36
docs/sdk/models/operations/cancelrefreshglobals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# CancelRefreshGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CancelRefreshGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CancelRefreshGlobals = {
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
28
docs/sdk/models/operations/cancelrefreshrequest.md
Normal file
28
docs/sdk/models/operations/cancelrefreshrequest.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# CancelRefreshRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CancelRefreshRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CancelRefreshRequest = {
|
||||
sectionId: 569134,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `sectionId` | *number* | :heavy_check_mark: | Section identifier | |
|
||||
20
docs/sdk/models/operations/cancelrefreshresponse.md
Normal file
20
docs/sdk/models/operations/cancelrefreshresponse.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# CancelRefreshResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CancelRefreshResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CancelRefreshResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 662485,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
16
docs/sdk/models/operations/channelmappingbykey.md
Normal file
16
docs/sdk/models/operations/channelmappingbykey.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# ChannelMappingByKey
|
||||
|
||||
The mapping of changes, passed as a map of device channel to lineup key.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ChannelMappingByKey } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ChannelMappingByKey = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
36
docs/sdk/models/operations/checkupdatesglobals.md
Normal file
36
docs/sdk/models/operations/checkupdatesglobals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# CheckUpdatesGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CheckUpdatesGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CheckUpdatesGlobals = {
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
29
docs/sdk/models/operations/checkupdatesrequest.md
Normal file
29
docs/sdk/models/operations/checkupdatesrequest.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# CheckUpdatesRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CheckUpdatesRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
|
||||
let value: CheckUpdatesRequest = {
|
||||
download: BoolInt.One,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `download` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |
|
||||
20
docs/sdk/models/operations/checkupdatesresponse.md
Normal file
20
docs/sdk/models/operations/checkupdatesresponse.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# CheckUpdatesResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CheckUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CheckUpdatesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 957467,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
25
docs/sdk/models/operations/chromasubsampling.md
Normal file
25
docs/sdk/models/operations/chromasubsampling.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# ChromaSubsampling
|
||||
|
||||
Use the specified chroma subsambling.
|
||||
- 0: 411
|
||||
- 1: 420
|
||||
- 2: 422
|
||||
- 3: 444
|
||||
Defaults to 3 (444)
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ChromaSubsampling } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ChromaSubsampling = ChromaSubsampling.Two;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
| `Two` | 2 |
|
||||
| `Three` | 3 |
|
||||
20
docs/sdk/models/operations/cleanbundlesresponse.md
Normal file
20
docs/sdk/models/operations/cleanbundlesresponse.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# CleanBundlesResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CleanBundlesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CleanBundlesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 909877,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user