mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 20:47:46 +00:00
Compare commits
79 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
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 |
23
.github/workflows/codesee-arch-diagram.yml
vendored
23
.github/workflows/codesee-arch-diagram.yml
vendored
@@ -1,23 +0,0 @@
|
|||||||
# This workflow was added by CodeSee. Learn more at https://codesee.io/
|
|
||||||
# This is v2.0 of this workflow file
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
pull_request_target:
|
|
||||||
types: [opened, synchronize, reopened]
|
|
||||||
|
|
||||||
name: CodeSee
|
|
||||||
|
|
||||||
permissions: read-all
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
codesee:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
continue-on-error: true
|
|
||||||
name: Analyze the repo with CodeSee
|
|
||||||
steps:
|
|
||||||
- uses: Codesee-io/codesee-action@v2
|
|
||||||
with:
|
|
||||||
codesee-token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}
|
|
||||||
codesee-url: https://app.codesee.io
|
|
||||||
33
.github/workflows/publish-jsr.yaml
vendored
Normal file
33
.github/workflows/publish-jsr.yaml
vendored
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
name: Publish to JSR
|
||||||
|
permissions:
|
||||||
|
checks: write
|
||||||
|
contents: write
|
||||||
|
pull-requests: write
|
||||||
|
statuses: write
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
publish:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
id-token: write
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Set up Node.js
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: 18
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm install
|
||||||
|
|
||||||
|
- name: Publish package
|
||||||
|
run: npx jsr publish
|
||||||
11
.github/workflows/speakeasy_sdk_generation.yml
vendored
11
.github/workflows/speakeasy_sdk_generation.yml
vendored
@@ -4,7 +4,8 @@ permissions:
|
|||||||
contents: write
|
contents: write
|
||||||
pull-requests: write
|
pull-requests: write
|
||||||
statuses: write
|
statuses: write
|
||||||
"on":
|
|
||||||
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
inputs:
|
inputs:
|
||||||
force:
|
force:
|
||||||
@@ -13,17 +14,13 @@ permissions:
|
|||||||
default: false
|
default: false
|
||||||
schedule:
|
schedule:
|
||||||
- cron: 0 0 * * *
|
- cron: 0 0 * * *
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
generate:
|
generate:
|
||||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/sdk-generation.yaml@v14
|
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
||||||
with:
|
with:
|
||||||
force: ${{ github.event.inputs.force }}
|
force: ${{ github.event.inputs.force }}
|
||||||
languages: |
|
|
||||||
- typescript
|
|
||||||
mode: direct
|
mode: direct
|
||||||
openapi_docs: |
|
|
||||||
- https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml
|
|
||||||
publish_typescript: true
|
|
||||||
speakeasy_version: latest
|
speakeasy_version: latest
|
||||||
secrets:
|
secrets:
|
||||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|||||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -1,3 +1,4 @@
|
|||||||
|
/hooks
|
||||||
/models
|
/models
|
||||||
/models/errors
|
/models/errors
|
||||||
/types
|
/types
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
/*
|
**/*
|
||||||
/docs/**/*.md
|
|
||||||
!/**/*.ts
|
!/**/*.ts
|
||||||
!/**/*.js
|
!/**/*.js
|
||||||
!/**/*.map
|
!/**/*.map
|
||||||
|
|||||||
@@ -1,55 +1,69 @@
|
|||||||
lockVersion: 2.0.0
|
lockVersion: 2.0.0
|
||||||
id: 16f22cbf-f23f-4419-8924-3a4b06381947
|
id: 16f22cbf-f23f-4419-8924-3a4b06381947
|
||||||
management:
|
management:
|
||||||
docChecksum: 34d22936f2456c2c461abdfc773e3fc4
|
docChecksum: 911d74baa0d06121d2ce2c71d94e977a
|
||||||
docVersion: 0.0.3
|
docVersion: 0.0.3
|
||||||
speakeasyVersion: internal
|
speakeasyVersion: 1.295.1
|
||||||
generationVersion: 2.228.1
|
generationVersion: 2.335.5
|
||||||
releaseVersion: 0.3.1
|
releaseVersion: 0.16.0
|
||||||
configChecksum: 708deaec8a7918d4523ce16e1e18874a
|
configChecksum: 3944bed5bdaa126637793fcb00b35913
|
||||||
repoURL: https://github.com/LukeHagar/plexjs.git
|
repoURL: https://github.com/LukeHagar/plexjs.git
|
||||||
repoSubDirectory: .
|
repoSubDirectory: .
|
||||||
installationURL: https://github.com/LukeHagar/plexjs
|
installationURL: https://github.com/LukeHagar/plexjs
|
||||||
published: true
|
published: true
|
||||||
features:
|
features:
|
||||||
typescript:
|
typescript:
|
||||||
core: 3.4.2
|
additionalDependencies: 0.1.0
|
||||||
|
constsAndDefaults: 0.1.5
|
||||||
|
core: 3.9.6
|
||||||
flattening: 2.81.1
|
flattening: 2.81.1
|
||||||
globalSecurity: 2.82.2
|
globalSecurity: 2.82.9
|
||||||
globalServerURLs: 2.82.1
|
globalSecurityCallbacks: 0.1.0
|
||||||
nameOverrides: 2.81.1
|
globalSecurityFlattening: 0.1.0
|
||||||
|
globalServerURLs: 2.82.4
|
||||||
|
globals: 2.82.1
|
||||||
|
methodServerURLs: 2.82.1
|
||||||
|
nameOverrides: 2.81.2
|
||||||
|
responseFormat: 0.2.3
|
||||||
|
sdkHooks: 0.1.0
|
||||||
generatedFiles:
|
generatedFiles:
|
||||||
- src/sdk/server.ts
|
- src/sdk/server.ts
|
||||||
- src/sdk/media.ts
|
- src/sdk/media.ts
|
||||||
|
- src/sdk/video.ts
|
||||||
- src/sdk/activities.ts
|
- src/sdk/activities.ts
|
||||||
- src/sdk/butler.ts
|
- src/sdk/butler.ts
|
||||||
- src/sdk/hubs.ts
|
- src/sdk/hubs.ts
|
||||||
- src/sdk/search.ts
|
- src/sdk/search.ts
|
||||||
- src/sdk/library.ts
|
- src/sdk/library.ts
|
||||||
- src/sdk/log.ts
|
- src/sdk/log.ts
|
||||||
|
- src/sdk/plex.ts
|
||||||
- src/sdk/playlists.ts
|
- src/sdk/playlists.ts
|
||||||
- src/sdk/security.ts
|
- src/sdk/authentication.ts
|
||||||
|
- src/sdk/statistics.ts
|
||||||
- src/sdk/sessions.ts
|
- src/sdk/sessions.ts
|
||||||
- src/sdk/updater.ts
|
- src/sdk/updater.ts
|
||||||
- src/sdk/video.ts
|
|
||||||
- src/sdk/sdk.ts
|
- src/sdk/sdk.ts
|
||||||
- .eslintrc.js
|
- .eslintrc.js
|
||||||
- .npmignore
|
- .npmignore
|
||||||
- package-lock.json
|
- RUNTIMES.md
|
||||||
|
- jsr.json
|
||||||
- package.json
|
- package.json
|
||||||
- src/index.ts
|
- src/index.ts
|
||||||
- src/lib/base64.ts
|
- src/lib/base64.ts
|
||||||
- src/lib/config.ts
|
- src/lib/config.ts
|
||||||
- src/lib/encodings.ts
|
- src/lib/encodings.ts
|
||||||
- src/lib/http.ts
|
- src/lib/http.ts
|
||||||
|
- src/lib/primitives.ts
|
||||||
- src/lib/retries.ts
|
- src/lib/retries.ts
|
||||||
|
- src/lib/schemas.ts
|
||||||
- src/lib/sdks.ts
|
- src/lib/sdks.ts
|
||||||
- src/lib/security.ts
|
- src/lib/security.ts
|
||||||
- src/lib/url.ts
|
- src/lib/url.ts
|
||||||
- src/sdk/index.ts
|
- src/sdk/index.ts
|
||||||
- src/models/errors/sdkerror.ts
|
- src/models/errors/sdkerror.ts
|
||||||
|
- src/models/errors/sdkvalidationerror.ts
|
||||||
- src/types/blobs.ts
|
- src/types/blobs.ts
|
||||||
- src/types/decimal.ts
|
- src/types/enums.ts
|
||||||
- src/types/index.ts
|
- src/types/index.ts
|
||||||
- src/types/operations.ts
|
- src/types/operations.ts
|
||||||
- src/types/rfcdate.ts
|
- src/types/rfcdate.ts
|
||||||
@@ -65,6 +79,8 @@ generatedFiles:
|
|||||||
- src/models/operations/markplayed.ts
|
- src/models/operations/markplayed.ts
|
||||||
- src/models/operations/markunplayed.ts
|
- src/models/operations/markunplayed.ts
|
||||||
- src/models/operations/updateplayprogress.ts
|
- src/models/operations/updateplayprogress.ts
|
||||||
|
- src/models/operations/gettimeline.ts
|
||||||
|
- src/models/operations/startuniversaltranscode.ts
|
||||||
- src/models/operations/getserveractivities.ts
|
- src/models/operations/getserveractivities.ts
|
||||||
- src/models/operations/cancelserveractivities.ts
|
- src/models/operations/cancelserveractivities.ts
|
||||||
- src/models/operations/getbutlertasks.ts
|
- src/models/operations/getbutlertasks.ts
|
||||||
@@ -84,14 +100,15 @@ generatedFiles:
|
|||||||
- src/models/operations/deletelibrary.ts
|
- src/models/operations/deletelibrary.ts
|
||||||
- src/models/operations/getlibraryitems.ts
|
- src/models/operations/getlibraryitems.ts
|
||||||
- src/models/operations/refreshlibrary.ts
|
- src/models/operations/refreshlibrary.ts
|
||||||
- src/models/operations/getlatestlibraryitems.ts
|
- src/models/operations/searchlibrary.ts
|
||||||
- src/models/operations/getcommonlibraryitems.ts
|
|
||||||
- src/models/operations/getmetadata.ts
|
- src/models/operations/getmetadata.ts
|
||||||
- src/models/operations/getmetadatachildren.ts
|
- src/models/operations/getmetadatachildren.ts
|
||||||
- src/models/operations/getondeck.ts
|
- src/models/operations/getondeck.ts
|
||||||
- src/models/operations/logline.ts
|
- src/models/operations/logline.ts
|
||||||
- src/models/operations/logmultiline.ts
|
- src/models/operations/logmultiline.ts
|
||||||
- src/models/operations/enablepapertrail.ts
|
- src/models/operations/enablepapertrail.ts
|
||||||
|
- src/models/operations/getpin.ts
|
||||||
|
- src/models/operations/gettoken.ts
|
||||||
- src/models/operations/createplaylist.ts
|
- src/models/operations/createplaylist.ts
|
||||||
- src/models/operations/getplaylists.ts
|
- src/models/operations/getplaylists.ts
|
||||||
- src/models/operations/getplaylist.ts
|
- src/models/operations/getplaylist.ts
|
||||||
@@ -103,6 +120,7 @@ generatedFiles:
|
|||||||
- src/models/operations/uploadplaylist.ts
|
- src/models/operations/uploadplaylist.ts
|
||||||
- src/models/operations/gettransienttoken.ts
|
- src/models/operations/gettransienttoken.ts
|
||||||
- src/models/operations/getsourceconnectioninformation.ts
|
- src/models/operations/getsourceconnectioninformation.ts
|
||||||
|
- src/models/operations/getstatistics.ts
|
||||||
- src/models/operations/getsessions.ts
|
- src/models/operations/getsessions.ts
|
||||||
- src/models/operations/getsessionhistory.ts
|
- src/models/operations/getsessionhistory.ts
|
||||||
- src/models/operations/gettranscodesessions.ts
|
- src/models/operations/gettranscodesessions.ts
|
||||||
@@ -110,8 +128,6 @@ generatedFiles:
|
|||||||
- src/models/operations/getupdatestatus.ts
|
- src/models/operations/getupdatestatus.ts
|
||||||
- src/models/operations/checkforupdates.ts
|
- src/models/operations/checkforupdates.ts
|
||||||
- src/models/operations/applyupdates.ts
|
- src/models/operations/applyupdates.ts
|
||||||
- src/models/operations/startuniversaltranscode.ts
|
|
||||||
- src/models/operations/gettimeline.ts
|
|
||||||
- src/models/errors/getservercapabilities.ts
|
- src/models/errors/getservercapabilities.ts
|
||||||
- src/models/errors/getserverpreferences.ts
|
- src/models/errors/getserverpreferences.ts
|
||||||
- src/models/errors/getavailableclients.ts
|
- src/models/errors/getavailableclients.ts
|
||||||
@@ -123,6 +139,8 @@ generatedFiles:
|
|||||||
- src/models/errors/markplayed.ts
|
- src/models/errors/markplayed.ts
|
||||||
- src/models/errors/markunplayed.ts
|
- src/models/errors/markunplayed.ts
|
||||||
- src/models/errors/updateplayprogress.ts
|
- src/models/errors/updateplayprogress.ts
|
||||||
|
- src/models/errors/gettimeline.ts
|
||||||
|
- src/models/errors/startuniversaltranscode.ts
|
||||||
- src/models/errors/getserveractivities.ts
|
- src/models/errors/getserveractivities.ts
|
||||||
- src/models/errors/cancelserveractivities.ts
|
- src/models/errors/cancelserveractivities.ts
|
||||||
- src/models/errors/getbutlertasks.ts
|
- src/models/errors/getbutlertasks.ts
|
||||||
@@ -142,14 +160,15 @@ generatedFiles:
|
|||||||
- src/models/errors/deletelibrary.ts
|
- src/models/errors/deletelibrary.ts
|
||||||
- src/models/errors/getlibraryitems.ts
|
- src/models/errors/getlibraryitems.ts
|
||||||
- src/models/errors/refreshlibrary.ts
|
- src/models/errors/refreshlibrary.ts
|
||||||
- src/models/errors/getlatestlibraryitems.ts
|
- src/models/errors/searchlibrary.ts
|
||||||
- src/models/errors/getcommonlibraryitems.ts
|
|
||||||
- src/models/errors/getmetadata.ts
|
- src/models/errors/getmetadata.ts
|
||||||
- src/models/errors/getmetadatachildren.ts
|
- src/models/errors/getmetadatachildren.ts
|
||||||
- src/models/errors/getondeck.ts
|
- src/models/errors/getondeck.ts
|
||||||
- src/models/errors/logline.ts
|
- src/models/errors/logline.ts
|
||||||
- src/models/errors/logmultiline.ts
|
- src/models/errors/logmultiline.ts
|
||||||
- src/models/errors/enablepapertrail.ts
|
- src/models/errors/enablepapertrail.ts
|
||||||
|
- src/models/errors/getpin.ts
|
||||||
|
- src/models/errors/gettoken.ts
|
||||||
- src/models/errors/createplaylist.ts
|
- src/models/errors/createplaylist.ts
|
||||||
- src/models/errors/getplaylists.ts
|
- src/models/errors/getplaylists.ts
|
||||||
- src/models/errors/getplaylist.ts
|
- src/models/errors/getplaylist.ts
|
||||||
@@ -161,6 +180,7 @@ generatedFiles:
|
|||||||
- src/models/errors/uploadplaylist.ts
|
- src/models/errors/uploadplaylist.ts
|
||||||
- src/models/errors/gettransienttoken.ts
|
- src/models/errors/gettransienttoken.ts
|
||||||
- src/models/errors/getsourceconnectioninformation.ts
|
- src/models/errors/getsourceconnectioninformation.ts
|
||||||
|
- src/models/errors/getstatistics.ts
|
||||||
- src/models/errors/getsessions.ts
|
- src/models/errors/getsessions.ts
|
||||||
- src/models/errors/getsessionhistory.ts
|
- src/models/errors/getsessionhistory.ts
|
||||||
- src/models/errors/gettranscodesessions.ts
|
- src/models/errors/gettranscodesessions.ts
|
||||||
@@ -168,8 +188,6 @@ generatedFiles:
|
|||||||
- src/models/errors/getupdatestatus.ts
|
- src/models/errors/getupdatestatus.ts
|
||||||
- src/models/errors/checkforupdates.ts
|
- src/models/errors/checkforupdates.ts
|
||||||
- src/models/errors/applyupdates.ts
|
- src/models/errors/applyupdates.ts
|
||||||
- src/models/errors/startuniversaltranscode.ts
|
|
||||||
- src/models/errors/gettimeline.ts
|
|
||||||
- src/models/components/security.ts
|
- src/models/components/security.ts
|
||||||
- src/models/errors/index.ts
|
- src/models/errors/index.ts
|
||||||
- src/models/operations/index.ts
|
- src/models/operations/index.ts
|
||||||
@@ -178,10 +196,13 @@ generatedFiles:
|
|||||||
- docs/models/operations/mediacontainer.md
|
- docs/models/operations/mediacontainer.md
|
||||||
- docs/models/operations/getservercapabilitiesresponsebody.md
|
- docs/models/operations/getservercapabilitiesresponsebody.md
|
||||||
- docs/models/operations/getservercapabilitiesresponse.md
|
- docs/models/operations/getservercapabilitiesresponse.md
|
||||||
|
- docs/models/operations/setting.md
|
||||||
|
- docs/models/operations/getserverpreferencesmediacontainer.md
|
||||||
|
- docs/models/operations/getserverpreferencesresponsebody.md
|
||||||
- docs/models/operations/getserverpreferencesresponse.md
|
- docs/models/operations/getserverpreferencesresponse.md
|
||||||
- docs/models/operations/server.md
|
- docs/models/operations/server.md
|
||||||
- docs/models/operations/getavailableclientsmediacontainer.md
|
- docs/models/operations/getavailableclientsmediacontainer.md
|
||||||
- docs/models/operations/responsebody.md
|
- docs/models/operations/getavailableclientsresponsebody.md
|
||||||
- docs/models/operations/getavailableclientsresponse.md
|
- docs/models/operations/getavailableclientsresponse.md
|
||||||
- docs/models/operations/device.md
|
- docs/models/operations/device.md
|
||||||
- docs/models/operations/getdevicesmediacontainer.md
|
- docs/models/operations/getdevicesmediacontainer.md
|
||||||
@@ -207,6 +228,11 @@ generatedFiles:
|
|||||||
- docs/models/operations/markunplayedresponse.md
|
- docs/models/operations/markunplayedresponse.md
|
||||||
- docs/models/operations/updateplayprogressrequest.md
|
- docs/models/operations/updateplayprogressrequest.md
|
||||||
- docs/models/operations/updateplayprogressresponse.md
|
- docs/models/operations/updateplayprogressresponse.md
|
||||||
|
- docs/models/operations/state.md
|
||||||
|
- docs/models/operations/gettimelinerequest.md
|
||||||
|
- docs/models/operations/gettimelineresponse.md
|
||||||
|
- docs/models/operations/startuniversaltranscoderequest.md
|
||||||
|
- docs/models/operations/startuniversaltranscoderesponse.md
|
||||||
- docs/models/operations/context.md
|
- docs/models/operations/context.md
|
||||||
- docs/models/operations/activity.md
|
- docs/models/operations/activity.md
|
||||||
- docs/models/operations/getserveractivitiesmediacontainer.md
|
- docs/models/operations/getserveractivitiesmediacontainer.md
|
||||||
@@ -228,9 +254,25 @@ generatedFiles:
|
|||||||
- docs/models/operations/stoptaskresponse.md
|
- docs/models/operations/stoptaskresponse.md
|
||||||
- docs/models/operations/onlytransient.md
|
- docs/models/operations/onlytransient.md
|
||||||
- docs/models/operations/getglobalhubsrequest.md
|
- docs/models/operations/getglobalhubsrequest.md
|
||||||
|
- docs/models/operations/getglobalhubsmetadata.md
|
||||||
|
- docs/models/operations/hub.md
|
||||||
|
- docs/models/operations/getglobalhubsmediacontainer.md
|
||||||
|
- docs/models/operations/getglobalhubsresponsebody.md
|
||||||
- docs/models/operations/getglobalhubsresponse.md
|
- docs/models/operations/getglobalhubsresponse.md
|
||||||
- docs/models/operations/queryparamonlytransient.md
|
- docs/models/operations/queryparamonlytransient.md
|
||||||
- docs/models/operations/getlibraryhubsrequest.md
|
- docs/models/operations/getlibraryhubsrequest.md
|
||||||
|
- docs/models/operations/getlibraryhubspart.md
|
||||||
|
- docs/models/operations/getlibraryhubsmedia.md
|
||||||
|
- docs/models/operations/getlibraryhubsgenre.md
|
||||||
|
- docs/models/operations/getlibraryhubscountry.md
|
||||||
|
- docs/models/operations/getlibraryhubsdirector.md
|
||||||
|
- docs/models/operations/getlibraryhubsrole.md
|
||||||
|
- docs/models/operations/getlibraryhubswriter.md
|
||||||
|
- docs/types/rfcdate.md
|
||||||
|
- docs/models/operations/getlibraryhubsmetadata.md
|
||||||
|
- docs/models/operations/getlibraryhubshub.md
|
||||||
|
- docs/models/operations/getlibraryhubsmediacontainer.md
|
||||||
|
- docs/models/operations/getlibraryhubsresponsebody.md
|
||||||
- docs/models/operations/getlibraryhubsresponse.md
|
- docs/models/operations/getlibraryhubsresponse.md
|
||||||
- docs/models/operations/performsearchrequest.md
|
- docs/models/operations/performsearchrequest.md
|
||||||
- docs/models/operations/performsearchresponse.md
|
- docs/models/operations/performsearchresponse.md
|
||||||
@@ -262,28 +304,72 @@ generatedFiles:
|
|||||||
- docs/models/operations/getrecentlyaddedmediacontainer.md
|
- docs/models/operations/getrecentlyaddedmediacontainer.md
|
||||||
- docs/models/operations/getrecentlyaddedresponsebody.md
|
- docs/models/operations/getrecentlyaddedresponsebody.md
|
||||||
- docs/models/operations/getrecentlyaddedresponse.md
|
- docs/models/operations/getrecentlyaddedresponse.md
|
||||||
|
- docs/models/operations/getlibrarieslocation.md
|
||||||
|
- docs/models/operations/getlibrariesdirectory.md
|
||||||
|
- docs/models/operations/getlibrariesmediacontainer.md
|
||||||
|
- docs/models/operations/getlibrariesresponsebody.md
|
||||||
- docs/models/operations/getlibrariesresponse.md
|
- docs/models/operations/getlibrariesresponse.md
|
||||||
- docs/models/operations/includedetails.md
|
- docs/models/operations/includedetails.md
|
||||||
- docs/models/operations/getlibraryrequest.md
|
- docs/models/operations/getlibraryrequest.md
|
||||||
|
- docs/models/operations/getlibrarydirectory.md
|
||||||
|
- docs/models/operations/filter.md
|
||||||
|
- docs/models/operations/sort.md
|
||||||
|
- docs/models/operations/field.md
|
||||||
|
- docs/models/operations/getlibrarytype.md
|
||||||
|
- docs/models/operations/operator.md
|
||||||
|
- docs/models/operations/fieldtype.md
|
||||||
|
- docs/models/operations/getlibrarymediacontainer.md
|
||||||
|
- docs/models/operations/getlibraryresponsebody.md
|
||||||
- docs/models/operations/getlibraryresponse.md
|
- docs/models/operations/getlibraryresponse.md
|
||||||
- docs/models/operations/deletelibraryrequest.md
|
- docs/models/operations/deletelibraryrequest.md
|
||||||
- docs/models/operations/deletelibraryresponse.md
|
- docs/models/operations/deletelibraryresponse.md
|
||||||
|
- docs/models/operations/tag.md
|
||||||
- docs/models/operations/getlibraryitemsrequest.md
|
- docs/models/operations/getlibraryitemsrequest.md
|
||||||
|
- docs/models/operations/getlibraryitemspart.md
|
||||||
|
- docs/models/operations/getlibraryitemsmedia.md
|
||||||
|
- docs/models/operations/getlibraryitemsgenre.md
|
||||||
|
- docs/models/operations/getlibraryitemscountry.md
|
||||||
|
- docs/models/operations/getlibraryitemsdirector.md
|
||||||
|
- docs/models/operations/getlibraryitemswriter.md
|
||||||
|
- docs/models/operations/getlibraryitemsrole.md
|
||||||
|
- docs/models/operations/getlibraryitemsmetadata.md
|
||||||
|
- docs/models/operations/getlibraryitemsmediacontainer.md
|
||||||
|
- docs/models/operations/getlibraryitemsresponsebody.md
|
||||||
- docs/models/operations/getlibraryitemsresponse.md
|
- docs/models/operations/getlibraryitemsresponse.md
|
||||||
- docs/models/operations/refreshlibraryrequest.md
|
- docs/models/operations/refreshlibraryrequest.md
|
||||||
- docs/models/operations/refreshlibraryresponse.md
|
- docs/models/operations/refreshlibraryresponse.md
|
||||||
- docs/models/operations/getlatestlibraryitemsrequest.md
|
- docs/models/operations/type.md
|
||||||
- docs/models/operations/getlatestlibraryitemsresponse.md
|
- docs/models/operations/searchlibraryrequest.md
|
||||||
- docs/models/operations/getcommonlibraryitemsrequest.md
|
- docs/models/operations/searchlibrarymetadata.md
|
||||||
- docs/models/operations/getcommonlibraryitemsresponse.md
|
- docs/models/operations/searchlibrarymediacontainer.md
|
||||||
|
- docs/models/operations/searchlibraryresponsebody.md
|
||||||
|
- docs/models/operations/searchlibraryresponse.md
|
||||||
- docs/models/operations/getmetadatarequest.md
|
- docs/models/operations/getmetadatarequest.md
|
||||||
|
- docs/models/operations/stream.md
|
||||||
|
- docs/models/operations/getmetadatapart.md
|
||||||
|
- docs/models/operations/getmetadatamedia.md
|
||||||
|
- docs/models/operations/getmetadatagenre.md
|
||||||
|
- docs/models/operations/getmetadatacountry.md
|
||||||
|
- docs/models/operations/guids.md
|
||||||
|
- docs/models/operations/ratings.md
|
||||||
|
- docs/models/operations/getmetadatadirector.md
|
||||||
|
- docs/models/operations/getmetadatawriter.md
|
||||||
|
- docs/models/operations/getmetadatarole.md
|
||||||
|
- docs/models/operations/producer.md
|
||||||
|
- docs/models/operations/getmetadatametadata.md
|
||||||
|
- docs/models/operations/getmetadatamediacontainer.md
|
||||||
|
- docs/models/operations/getmetadataresponsebody.md
|
||||||
- docs/models/operations/getmetadataresponse.md
|
- docs/models/operations/getmetadataresponse.md
|
||||||
- docs/models/operations/getmetadatachildrenrequest.md
|
- docs/models/operations/getmetadatachildrenrequest.md
|
||||||
|
- docs/models/operations/getmetadatachildrendirectory.md
|
||||||
|
- docs/models/operations/getmetadatachildrenmetadata.md
|
||||||
|
- docs/models/operations/getmetadatachildrenmediacontainer.md
|
||||||
|
- docs/models/operations/getmetadatachildrenresponsebody.md
|
||||||
- docs/models/operations/getmetadatachildrenresponse.md
|
- docs/models/operations/getmetadatachildrenresponse.md
|
||||||
- docs/models/operations/stream.md
|
- docs/models/operations/getondeckstream.md
|
||||||
- docs/models/operations/getondeckpart.md
|
- docs/models/operations/getondeckpart.md
|
||||||
- docs/models/operations/getondeckmedia.md
|
- docs/models/operations/getondeckmedia.md
|
||||||
- docs/models/operations/guids.md
|
- docs/models/operations/getondeckguids.md
|
||||||
- docs/models/operations/getondeckmetadata.md
|
- docs/models/operations/getondeckmetadata.md
|
||||||
- docs/models/operations/getondeckmediacontainer.md
|
- docs/models/operations/getondeckmediacontainer.md
|
||||||
- docs/models/operations/getondeckresponsebody.md
|
- docs/models/operations/getondeckresponsebody.md
|
||||||
@@ -293,36 +379,85 @@ generatedFiles:
|
|||||||
- docs/models/operations/loglineresponse.md
|
- docs/models/operations/loglineresponse.md
|
||||||
- docs/models/operations/logmultilineresponse.md
|
- docs/models/operations/logmultilineresponse.md
|
||||||
- docs/models/operations/enablepapertrailresponse.md
|
- docs/models/operations/enablepapertrailresponse.md
|
||||||
- docs/models/operations/typet.md
|
- docs/models/operations/getpinglobals.md
|
||||||
|
- docs/models/operations/getpinrequest.md
|
||||||
|
- docs/models/operations/location.md
|
||||||
|
- docs/models/operations/getpinresponsebody.md
|
||||||
|
- docs/models/operations/getpinresponse.md
|
||||||
|
- docs/models/operations/gettokenglobals.md
|
||||||
|
- docs/models/operations/gettokenrequest.md
|
||||||
|
- docs/models/operations/gettokenresponse.md
|
||||||
|
- docs/models/operations/queryparamtype.md
|
||||||
- docs/models/operations/smart.md
|
- docs/models/operations/smart.md
|
||||||
- docs/models/operations/createplaylistrequest.md
|
- docs/models/operations/createplaylistrequest.md
|
||||||
|
- docs/models/operations/createplaylistmetadata.md
|
||||||
|
- docs/models/operations/createplaylistmediacontainer.md
|
||||||
|
- docs/models/operations/createplaylistresponsebody.md
|
||||||
- docs/models/operations/createplaylistresponse.md
|
- docs/models/operations/createplaylistresponse.md
|
||||||
- docs/models/operations/playlisttype.md
|
- docs/models/operations/playlisttype.md
|
||||||
- docs/models/operations/queryparamsmart.md
|
- docs/models/operations/queryparamsmart.md
|
||||||
- docs/models/operations/getplaylistsrequest.md
|
- docs/models/operations/getplaylistsrequest.md
|
||||||
|
- docs/models/operations/getplaylistsmetadata.md
|
||||||
|
- docs/models/operations/getplaylistsmediacontainer.md
|
||||||
|
- docs/models/operations/getplaylistsresponsebody.md
|
||||||
- docs/models/operations/getplaylistsresponse.md
|
- docs/models/operations/getplaylistsresponse.md
|
||||||
- docs/models/operations/getplaylistrequest.md
|
- docs/models/operations/getplaylistrequest.md
|
||||||
|
- docs/models/operations/getplaylistmetadata.md
|
||||||
|
- docs/models/operations/getplaylistmediacontainer.md
|
||||||
|
- docs/models/operations/getplaylistresponsebody.md
|
||||||
- docs/models/operations/getplaylistresponse.md
|
- docs/models/operations/getplaylistresponse.md
|
||||||
- docs/models/operations/deleteplaylistrequest.md
|
- docs/models/operations/deleteplaylistrequest.md
|
||||||
- docs/models/operations/deleteplaylistresponse.md
|
- docs/models/operations/deleteplaylistresponse.md
|
||||||
- docs/models/operations/updateplaylistrequest.md
|
- docs/models/operations/updateplaylistrequest.md
|
||||||
- docs/models/operations/updateplaylistresponse.md
|
- docs/models/operations/updateplaylistresponse.md
|
||||||
- docs/models/operations/getplaylistcontentsrequest.md
|
- docs/models/operations/getplaylistcontentsrequest.md
|
||||||
|
- docs/models/operations/getplaylistcontentspart.md
|
||||||
|
- docs/models/operations/getplaylistcontentsmedia.md
|
||||||
|
- docs/models/operations/getplaylistcontentsgenre.md
|
||||||
|
- docs/models/operations/getplaylistcontentscountry.md
|
||||||
|
- docs/models/operations/getplaylistcontentsdirector.md
|
||||||
|
- docs/models/operations/getplaylistcontentswriter.md
|
||||||
|
- docs/models/operations/getplaylistcontentsrole.md
|
||||||
|
- docs/models/operations/getplaylistcontentsmetadata.md
|
||||||
|
- docs/models/operations/getplaylistcontentsmediacontainer.md
|
||||||
|
- docs/models/operations/getplaylistcontentsresponsebody.md
|
||||||
- docs/models/operations/getplaylistcontentsresponse.md
|
- docs/models/operations/getplaylistcontentsresponse.md
|
||||||
- docs/models/operations/clearplaylistcontentsrequest.md
|
- docs/models/operations/clearplaylistcontentsrequest.md
|
||||||
- docs/models/operations/clearplaylistcontentsresponse.md
|
- docs/models/operations/clearplaylistcontentsresponse.md
|
||||||
- docs/models/operations/addplaylistcontentsrequest.md
|
- docs/models/operations/addplaylistcontentsrequest.md
|
||||||
|
- docs/models/operations/addplaylistcontentsmetadata.md
|
||||||
|
- docs/models/operations/addplaylistcontentsmediacontainer.md
|
||||||
|
- docs/models/operations/addplaylistcontentsresponsebody.md
|
||||||
- docs/models/operations/addplaylistcontentsresponse.md
|
- docs/models/operations/addplaylistcontentsresponse.md
|
||||||
- docs/models/operations/force.md
|
- docs/models/operations/force.md
|
||||||
- docs/models/operations/uploadplaylistrequest.md
|
- docs/models/operations/uploadplaylistrequest.md
|
||||||
- docs/models/operations/uploadplaylistresponse.md
|
- docs/models/operations/uploadplaylistresponse.md
|
||||||
- docs/models/operations/queryparamtype.md
|
- docs/models/operations/gettransienttokenqueryparamtype.md
|
||||||
- docs/models/operations/scope.md
|
- docs/models/operations/scope.md
|
||||||
- docs/models/operations/gettransienttokenrequest.md
|
- docs/models/operations/gettransienttokenrequest.md
|
||||||
- docs/models/operations/gettransienttokenresponse.md
|
- docs/models/operations/gettransienttokenresponse.md
|
||||||
- docs/models/operations/getsourceconnectioninformationrequest.md
|
- docs/models/operations/getsourceconnectioninformationrequest.md
|
||||||
- docs/models/operations/getsourceconnectioninformationresponse.md
|
- docs/models/operations/getsourceconnectioninformationresponse.md
|
||||||
|
- docs/models/operations/getstatisticsrequest.md
|
||||||
|
- docs/models/operations/getstatisticsdevice.md
|
||||||
|
- docs/models/operations/account.md
|
||||||
|
- docs/models/operations/statisticsmedia.md
|
||||||
|
- docs/models/operations/getstatisticsmediacontainer.md
|
||||||
|
- docs/models/operations/getstatisticsresponsebody.md
|
||||||
|
- docs/models/operations/getstatisticsresponse.md
|
||||||
|
- docs/models/operations/getsessionsstream.md
|
||||||
|
- docs/models/operations/getsessionspart.md
|
||||||
|
- docs/models/operations/getsessionsmedia.md
|
||||||
|
- docs/models/operations/user.md
|
||||||
|
- docs/models/operations/player.md
|
||||||
|
- docs/models/operations/session.md
|
||||||
|
- docs/models/operations/getsessionsmetadata.md
|
||||||
|
- docs/models/operations/getsessionsmediacontainer.md
|
||||||
|
- docs/models/operations/getsessionsresponsebody.md
|
||||||
- docs/models/operations/getsessionsresponse.md
|
- docs/models/operations/getsessionsresponse.md
|
||||||
|
- docs/models/operations/getsessionhistorymetadata.md
|
||||||
|
- docs/models/operations/getsessionhistorymediacontainer.md
|
||||||
|
- docs/models/operations/getsessionhistoryresponsebody.md
|
||||||
- docs/models/operations/getsessionhistoryresponse.md
|
- docs/models/operations/getsessionhistoryresponse.md
|
||||||
- docs/models/operations/transcodesession.md
|
- docs/models/operations/transcodesession.md
|
||||||
- docs/models/operations/gettranscodesessionsmediacontainer.md
|
- docs/models/operations/gettranscodesessionsmediacontainer.md
|
||||||
@@ -330,6 +465,9 @@ generatedFiles:
|
|||||||
- docs/models/operations/gettranscodesessionsresponse.md
|
- docs/models/operations/gettranscodesessionsresponse.md
|
||||||
- docs/models/operations/stoptranscodesessionrequest.md
|
- docs/models/operations/stoptranscodesessionrequest.md
|
||||||
- docs/models/operations/stoptranscodesessionresponse.md
|
- docs/models/operations/stoptranscodesessionresponse.md
|
||||||
|
- docs/models/operations/release.md
|
||||||
|
- docs/models/operations/getupdatestatusmediacontainer.md
|
||||||
|
- docs/models/operations/getupdatestatusresponsebody.md
|
||||||
- docs/models/operations/getupdatestatusresponse.md
|
- docs/models/operations/getupdatestatusresponse.md
|
||||||
- docs/models/operations/download.md
|
- docs/models/operations/download.md
|
||||||
- docs/models/operations/checkforupdatesrequest.md
|
- docs/models/operations/checkforupdatesrequest.md
|
||||||
@@ -338,11 +476,6 @@ generatedFiles:
|
|||||||
- docs/models/operations/skip.md
|
- docs/models/operations/skip.md
|
||||||
- docs/models/operations/applyupdatesrequest.md
|
- docs/models/operations/applyupdatesrequest.md
|
||||||
- docs/models/operations/applyupdatesresponse.md
|
- docs/models/operations/applyupdatesresponse.md
|
||||||
- docs/models/operations/startuniversaltranscoderequest.md
|
|
||||||
- docs/models/operations/startuniversaltranscoderesponse.md
|
|
||||||
- docs/models/operations/state.md
|
|
||||||
- docs/models/operations/gettimelinerequest.md
|
|
||||||
- docs/models/operations/gettimelineresponse.md
|
|
||||||
- docs/models/errors/errors.md
|
- docs/models/errors/errors.md
|
||||||
- docs/models/errors/getservercapabilitiesresponsebody.md
|
- docs/models/errors/getservercapabilitiesresponsebody.md
|
||||||
- docs/models/errors/getserverpreferenceserrors.md
|
- docs/models/errors/getserverpreferenceserrors.md
|
||||||
@@ -365,6 +498,10 @@ generatedFiles:
|
|||||||
- docs/models/errors/markunplayedresponsebody.md
|
- docs/models/errors/markunplayedresponsebody.md
|
||||||
- docs/models/errors/updateplayprogresserrors.md
|
- docs/models/errors/updateplayprogresserrors.md
|
||||||
- docs/models/errors/updateplayprogressresponsebody.md
|
- docs/models/errors/updateplayprogressresponsebody.md
|
||||||
|
- docs/models/errors/gettimelineerrors.md
|
||||||
|
- docs/models/errors/gettimelineresponsebody.md
|
||||||
|
- docs/models/errors/startuniversaltranscodeerrors.md
|
||||||
|
- docs/models/errors/startuniversaltranscoderesponsebody.md
|
||||||
- docs/models/errors/getserveractivitieserrors.md
|
- docs/models/errors/getserveractivitieserrors.md
|
||||||
- docs/models/errors/getserveractivitiesresponsebody.md
|
- docs/models/errors/getserveractivitiesresponsebody.md
|
||||||
- docs/models/errors/cancelserveractivitieserrors.md
|
- docs/models/errors/cancelserveractivitieserrors.md
|
||||||
@@ -403,10 +540,8 @@ generatedFiles:
|
|||||||
- docs/models/errors/getlibraryitemsresponsebody.md
|
- docs/models/errors/getlibraryitemsresponsebody.md
|
||||||
- docs/models/errors/refreshlibraryerrors.md
|
- docs/models/errors/refreshlibraryerrors.md
|
||||||
- docs/models/errors/refreshlibraryresponsebody.md
|
- docs/models/errors/refreshlibraryresponsebody.md
|
||||||
- docs/models/errors/getlatestlibraryitemserrors.md
|
- docs/models/errors/searchlibraryerrors.md
|
||||||
- docs/models/errors/getlatestlibraryitemsresponsebody.md
|
- docs/models/errors/searchlibraryresponsebody.md
|
||||||
- docs/models/errors/getcommonlibraryitemserrors.md
|
|
||||||
- docs/models/errors/getcommonlibraryitemsresponsebody.md
|
|
||||||
- docs/models/errors/getmetadataerrors.md
|
- docs/models/errors/getmetadataerrors.md
|
||||||
- docs/models/errors/getmetadataresponsebody.md
|
- docs/models/errors/getmetadataresponsebody.md
|
||||||
- docs/models/errors/getmetadatachildrenerrors.md
|
- docs/models/errors/getmetadatachildrenerrors.md
|
||||||
@@ -419,6 +554,10 @@ generatedFiles:
|
|||||||
- docs/models/errors/logmultilineresponsebody.md
|
- docs/models/errors/logmultilineresponsebody.md
|
||||||
- docs/models/errors/enablepapertrailerrors.md
|
- docs/models/errors/enablepapertrailerrors.md
|
||||||
- docs/models/errors/enablepapertrailresponsebody.md
|
- docs/models/errors/enablepapertrailresponsebody.md
|
||||||
|
- docs/models/errors/getpinerrors.md
|
||||||
|
- docs/models/errors/getpinresponsebody.md
|
||||||
|
- docs/models/errors/gettokenerrors.md
|
||||||
|
- docs/models/errors/gettokenresponsebody.md
|
||||||
- docs/models/errors/createplaylisterrors.md
|
- docs/models/errors/createplaylisterrors.md
|
||||||
- docs/models/errors/createplaylistresponsebody.md
|
- docs/models/errors/createplaylistresponsebody.md
|
||||||
- docs/models/errors/getplaylistserrors.md
|
- docs/models/errors/getplaylistserrors.md
|
||||||
@@ -441,6 +580,8 @@ generatedFiles:
|
|||||||
- docs/models/errors/gettransienttokenresponsebody.md
|
- docs/models/errors/gettransienttokenresponsebody.md
|
||||||
- docs/models/errors/getsourceconnectioninformationerrors.md
|
- docs/models/errors/getsourceconnectioninformationerrors.md
|
||||||
- docs/models/errors/getsourceconnectioninformationresponsebody.md
|
- docs/models/errors/getsourceconnectioninformationresponsebody.md
|
||||||
|
- docs/models/errors/getstatisticserrors.md
|
||||||
|
- docs/models/errors/getstatisticsresponsebody.md
|
||||||
- docs/models/errors/getsessionserrors.md
|
- docs/models/errors/getsessionserrors.md
|
||||||
- docs/models/errors/getsessionsresponsebody.md
|
- docs/models/errors/getsessionsresponsebody.md
|
||||||
- docs/models/errors/getsessionhistoryerrors.md
|
- docs/models/errors/getsessionhistoryerrors.md
|
||||||
@@ -455,24 +596,25 @@ generatedFiles:
|
|||||||
- docs/models/errors/checkforupdatesresponsebody.md
|
- docs/models/errors/checkforupdatesresponsebody.md
|
||||||
- docs/models/errors/applyupdateserrors.md
|
- docs/models/errors/applyupdateserrors.md
|
||||||
- docs/models/errors/applyupdatesresponsebody.md
|
- docs/models/errors/applyupdatesresponsebody.md
|
||||||
- docs/models/errors/startuniversaltranscodeerrors.md
|
|
||||||
- docs/models/errors/startuniversaltranscoderesponsebody.md
|
|
||||||
- docs/models/errors/gettimelineerrors.md
|
|
||||||
- docs/models/errors/gettimelineresponsebody.md
|
|
||||||
- docs/models/components/security.md
|
- docs/models/components/security.md
|
||||||
- docs/sdks/plexapi/README.md
|
- docs/sdks/plexapi/README.md
|
||||||
- docs/sdks/server/README.md
|
- docs/sdks/server/README.md
|
||||||
- docs/sdks/media/README.md
|
- docs/sdks/media/README.md
|
||||||
|
- docs/sdks/video/README.md
|
||||||
- docs/sdks/activities/README.md
|
- docs/sdks/activities/README.md
|
||||||
- docs/sdks/butler/README.md
|
- docs/sdks/butler/README.md
|
||||||
- docs/sdks/hubs/README.md
|
- docs/sdks/hubs/README.md
|
||||||
- docs/sdks/search/README.md
|
- docs/sdks/search/README.md
|
||||||
- docs/sdks/library/README.md
|
- docs/sdks/library/README.md
|
||||||
- docs/sdks/log/README.md
|
- docs/sdks/log/README.md
|
||||||
|
- docs/sdks/plex/README.md
|
||||||
- docs/sdks/playlists/README.md
|
- docs/sdks/playlists/README.md
|
||||||
- docs/sdks/security/README.md
|
- docs/sdks/authentication/README.md
|
||||||
|
- docs/sdks/statistics/README.md
|
||||||
- docs/sdks/sessions/README.md
|
- docs/sdks/sessions/README.md
|
||||||
- docs/sdks/updater/README.md
|
- docs/sdks/updater/README.md
|
||||||
- docs/sdks/video/README.md
|
|
||||||
- USAGE.md
|
- USAGE.md
|
||||||
- .gitattributes
|
- .gitattributes
|
||||||
|
- src/hooks/hooks.ts
|
||||||
|
- src/hooks/types.ts
|
||||||
|
- src/hooks/index.ts
|
||||||
|
|||||||
@@ -7,10 +7,20 @@ generation:
|
|||||||
useClassNamesForArrayFields: true
|
useClassNamesForArrayFields: true
|
||||||
fixes:
|
fixes:
|
||||||
nameResolutionDec2023: false
|
nameResolutionDec2023: false
|
||||||
|
parameterOrderingFeb2024: false
|
||||||
|
requestResponseComponentNamesFeb2024: false
|
||||||
|
auth:
|
||||||
|
oAuth2ClientCredentialsEnabled: false
|
||||||
typescript:
|
typescript:
|
||||||
version: 0.3.1
|
version: 0.16.0
|
||||||
|
additionalDependencies:
|
||||||
|
dependencies: {}
|
||||||
|
devDependencies: {}
|
||||||
|
peerDependencies: {}
|
||||||
|
additionalPackageJSON: {}
|
||||||
author: LukeHagar
|
author: LukeHagar
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
|
enumFormat: enum
|
||||||
flattenGlobalSecurity: true
|
flattenGlobalSecurity: true
|
||||||
imports:
|
imports:
|
||||||
option: openapi
|
option: openapi
|
||||||
@@ -22,6 +32,8 @@ typescript:
|
|||||||
webhooks: models/webhooks
|
webhooks: models/webhooks
|
||||||
inputModelSuffix: input
|
inputModelSuffix: input
|
||||||
maxMethodParams: 4
|
maxMethodParams: 4
|
||||||
|
methodArguments: require-security-and-request
|
||||||
outputModelSuffix: output
|
outputModelSuffix: output
|
||||||
packageName: '@lukehagar/plexjs'
|
packageName: '@lukehagar/plexjs'
|
||||||
|
responseFormat: envelope
|
||||||
templateVersion: v2
|
templateVersion: v2
|
||||||
34
.speakeasy/workflow.lock
Normal file
34
.speakeasy/workflow.lock
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
speakeasyVersion: 1.295.1
|
||||||
|
sources:
|
||||||
|
my-source:
|
||||||
|
sourceNamespace: my-source
|
||||||
|
sourceRevisionDigest: sha256:95fd08c8ca75c7996156c3b09c40a5ee8cad98b2fd2fd5c64af83701f5d8e118
|
||||||
|
sourceBlobDigest: sha256:6760fb8647c9a4f02a2f3e23f563a2de660ae1fc5f6a36958bec130f731cbb01
|
||||||
|
tags:
|
||||||
|
- latest
|
||||||
|
- main
|
||||||
|
targets:
|
||||||
|
plexjs:
|
||||||
|
source: my-source
|
||||||
|
sourceNamespace: my-source
|
||||||
|
sourceRevisionDigest: sha256:95fd08c8ca75c7996156c3b09c40a5ee8cad98b2fd2fd5c64af83701f5d8e118
|
||||||
|
sourceBlobDigest: sha256:6760fb8647c9a4f02a2f3e23f563a2de660ae1fc5f6a36958bec130f731cbb01
|
||||||
|
outLocation: /github/workspace/repo
|
||||||
|
workflow:
|
||||||
|
workflowVersion: 1.0.0
|
||||||
|
speakeasyVersion: latest
|
||||||
|
sources:
|
||||||
|
my-source:
|
||||||
|
inputs:
|
||||||
|
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml
|
||||||
|
registry:
|
||||||
|
location: registry.speakeasyapi.dev/lukehagar/lukehagar/my-source
|
||||||
|
targets:
|
||||||
|
plexjs:
|
||||||
|
target: typescript
|
||||||
|
source: my-source
|
||||||
|
publish:
|
||||||
|
npm:
|
||||||
|
token: $NPM_TOKEN
|
||||||
|
codeSamples:
|
||||||
|
output: codeSamples.yaml
|
||||||
17
.speakeasy/workflow.yaml
Normal file
17
.speakeasy/workflow.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
workflowVersion: 1.0.0
|
||||||
|
speakeasyVersion: latest
|
||||||
|
sources:
|
||||||
|
my-source:
|
||||||
|
inputs:
|
||||||
|
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml
|
||||||
|
registry:
|
||||||
|
location: registry.speakeasyapi.dev/lukehagar/lukehagar/my-source
|
||||||
|
targets:
|
||||||
|
plexjs:
|
||||||
|
target: typescript
|
||||||
|
source: my-source
|
||||||
|
publish:
|
||||||
|
npm:
|
||||||
|
token: $NPM_TOKEN
|
||||||
|
codeSamples:
|
||||||
|
output: codeSamples.yaml
|
||||||
26
Makefile
26
Makefile
@@ -1,26 +0,0 @@
|
|||||||
.PHONY: *
|
|
||||||
|
|
||||||
all: speakeasy
|
|
||||||
|
|
||||||
|
|
||||||
speakeasy: check-speakeasy
|
|
||||||
speakeasy generate sdk --lang typescript -o . -s ./openapi.yaml
|
|
||||||
|
|
||||||
speakeasy-validate: check-speakeasy
|
|
||||||
speakeasy validate openapi -s ./openapi.yaml
|
|
||||||
|
|
||||||
openapi:
|
|
||||||
curl https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml > ./openapi.yaml
|
|
||||||
|
|
||||||
# This will replace the generation source in your workflow file with your local schema path
|
|
||||||
generate-from-local:
|
|
||||||
@if ! which sed >/dev/null; then \
|
|
||||||
echo "sed is not installed. Please install it using the following command:"; \
|
|
||||||
echo "For Ubuntu/Debian: apt-get install sed"; \
|
|
||||||
echo "For macOS: sed is pre-installed"; \
|
|
||||||
exit 1; \
|
|
||||||
fi
|
|
||||||
@sed -i '' '/openapi_docs: |/{n;s|-.*|- ./openapi.yaml|;}' ./.github/workflows/speakeasy_sdk_generation.yml
|
|
||||||
|
|
||||||
check-speakeasy:
|
|
||||||
@command -v speakeasy >/dev/null 2>&1 || { echo >&2 "speakeasy CLI is not installed. Please install before continuing."; exit 1; }
|
|
||||||
206
README.md
206
README.md
@@ -31,18 +31,16 @@ yarn add @lukehagar/plexjs
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
xPlexClientIdentifier: "Postman",
|
||||||
});
|
});
|
||||||
|
|
||||||
const res = await sdk.server.getServerCapabilities();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
if (res?.statusCode !== 200) {
|
// Handle the result
|
||||||
throw new Error("Unexpected status code: " + res?.statusCode || "-");
|
console.log(result);
|
||||||
}
|
|
||||||
|
|
||||||
// handle response
|
|
||||||
}
|
}
|
||||||
|
|
||||||
run();
|
run();
|
||||||
@@ -70,6 +68,11 @@ run();
|
|||||||
* [markUnplayed](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
|
* [markUnplayed](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
|
||||||
* [updatePlayProgress](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress
|
* [updatePlayProgress](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress
|
||||||
|
|
||||||
|
### [video](docs/sdks/video/README.md)
|
||||||
|
|
||||||
|
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
||||||
|
* [startUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
|
||||||
|
|
||||||
### [activities](docs/sdks/activities/README.md)
|
### [activities](docs/sdks/activities/README.md)
|
||||||
|
|
||||||
* [getServerActivities](docs/sdks/activities/README.md#getserveractivities) - Get Server Activities
|
* [getServerActivities](docs/sdks/activities/README.md#getserveractivities) - Get Server Activities
|
||||||
@@ -103,8 +106,7 @@ run();
|
|||||||
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||||
* [refreshLibrary](docs/sdks/library/README.md#refreshlibrary) - Refresh Library
|
* [refreshLibrary](docs/sdks/library/README.md#refreshlibrary) - Refresh Library
|
||||||
* [getLatestLibraryItems](docs/sdks/library/README.md#getlatestlibraryitems) - Get Latest Library Items
|
* [searchLibrary](docs/sdks/library/README.md#searchlibrary) - Search Library
|
||||||
* [getCommonLibraryItems](docs/sdks/library/README.md#getcommonlibraryitems) - Get Common Library Items
|
|
||||||
* [getMetadata](docs/sdks/library/README.md#getmetadata) - Get Items Metadata
|
* [getMetadata](docs/sdks/library/README.md#getmetadata) - Get Items Metadata
|
||||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||||
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||||
@@ -115,6 +117,11 @@ run();
|
|||||||
* [logMultiLine](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
|
* [logMultiLine](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
|
||||||
* [enablePaperTrail](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
|
* [enablePaperTrail](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
|
||||||
|
|
||||||
|
### [plex](docs/sdks/plex/README.md)
|
||||||
|
|
||||||
|
* [getPin](docs/sdks/plex/README.md#getpin) - Get a Pin
|
||||||
|
* [getToken](docs/sdks/plex/README.md#gettoken) - Get Access Token
|
||||||
|
|
||||||
### [playlists](docs/sdks/playlists/README.md)
|
### [playlists](docs/sdks/playlists/README.md)
|
||||||
|
|
||||||
* [createPlaylist](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
|
* [createPlaylist](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
|
||||||
@@ -127,10 +134,14 @@ run();
|
|||||||
* [addPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a Playlist
|
* [addPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a Playlist
|
||||||
* [uploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist) - Upload Playlist
|
* [uploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist) - Upload Playlist
|
||||||
|
|
||||||
### [security](docs/sdks/security/README.md)
|
### [authentication](docs/sdks/authentication/README.md)
|
||||||
|
|
||||||
* [getTransientToken](docs/sdks/security/README.md#gettransienttoken) - Get a Transient Token.
|
* [getTransientToken](docs/sdks/authentication/README.md#gettransienttoken) - Get a Transient Token.
|
||||||
* [getSourceConnectionInformation](docs/sdks/security/README.md#getsourceconnectioninformation) - Get Source Connection Information
|
* [getSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation) - Get Source Connection Information
|
||||||
|
|
||||||
|
### [statistics](docs/sdks/statistics/README.md)
|
||||||
|
|
||||||
|
* [getStatistics](docs/sdks/statistics/README.md#getstatistics) - Get Media Statistics
|
||||||
|
|
||||||
### [sessions](docs/sdks/sessions/README.md)
|
### [sessions](docs/sdks/sessions/README.md)
|
||||||
|
|
||||||
@@ -144,11 +155,6 @@ run();
|
|||||||
* [getUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
|
* [getUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
|
||||||
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
||||||
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
||||||
|
|
||||||
### [video](docs/sdks/video/README.md)
|
|
||||||
|
|
||||||
* [startUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
|
|
||||||
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
|
||||||
<!-- End Available Resources and Operations [operations] -->
|
<!-- End Available Resources and Operations [operations] -->
|
||||||
|
|
||||||
<!-- Start Error Handling [errors] -->
|
<!-- Start Error Handling [errors] -->
|
||||||
@@ -161,31 +167,43 @@ All SDK methods return a response object or throw an error. If Error objects are
|
|||||||
| errors.GetServerCapabilitiesResponseBody | 401 | application/json |
|
| errors.GetServerCapabilitiesResponseBody | 401 | application/json |
|
||||||
| errors.SDKError | 4xx-5xx | */* |
|
| errors.SDKError | 4xx-5xx | */* |
|
||||||
|
|
||||||
Example
|
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
|
||||||
|
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import * as errors from "@lukehagar/plexjs/models/errors";
|
import * as errors from "@lukehagar/plexjs/models/errors";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
xPlexClientIdentifier: "Postman",
|
||||||
});
|
});
|
||||||
|
|
||||||
const res = await sdk.server.getServerCapabilities().catch((err) => {
|
async function run() {
|
||||||
if (err instanceof errors.GetServerCapabilitiesResponseBody) {
|
let result;
|
||||||
|
try {
|
||||||
|
result = await plexAPI.server.getServerCapabilities();
|
||||||
|
} catch (err) {
|
||||||
|
switch (true) {
|
||||||
|
case err instanceof errors.SDKValidationError: {
|
||||||
|
// Validation errors can be pretty-printed
|
||||||
|
console.error(err.pretty());
|
||||||
|
// Raw value may also be inspected
|
||||||
|
console.error(err.rawValue);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
case err instanceof errors.GetServerCapabilitiesResponseBody: {
|
||||||
console.error(err); // handle exception
|
console.error(err); // handle exception
|
||||||
return null;
|
return;
|
||||||
} else {
|
}
|
||||||
|
default: {
|
||||||
throw err;
|
throw err;
|
||||||
}
|
}
|
||||||
});
|
}
|
||||||
|
|
||||||
if (res?.statusCode !== 200) {
|
|
||||||
throw new Error("Unexpected status code: " + res?.statusCode || "-");
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// handle response
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
}
|
}
|
||||||
|
|
||||||
run();
|
run();
|
||||||
@@ -198,13 +216,31 @@ run();
|
|||||||
|
|
||||||
### Select Server by Index
|
### Select Server by Index
|
||||||
|
|
||||||
You can override the default server globally by passing a server index to the `serverIdx: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
|
You can override the default server globally by passing a server index to the `serverIdx` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
|
||||||
|
|
||||||
| # | Server | Variables |
|
| # | Server | Variables |
|
||||||
| - | ------ | --------- |
|
| - | ------ | --------- |
|
||||||
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `http`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `http`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
const plexAPI = new PlexAPI({
|
||||||
|
serverIdx: 0,
|
||||||
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
xPlexClientIdentifier: "Postman",
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
#### Variables
|
#### Variables
|
||||||
|
|
||||||
@@ -215,7 +251,50 @@ Some of the server options above contain variables. If you want to set the value
|
|||||||
|
|
||||||
### Override Server URL Per-Client
|
### Override Server URL Per-Client
|
||||||
|
|
||||||
The default server can also be overridden globally by passing a URL to the `serverURL: str` optional parameter when initializing the SDK client instance. For example:
|
The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
const plexAPI = new PlexAPI({
|
||||||
|
serverURL: "{protocol}://{ip}:{port}",
|
||||||
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
xPlexClientIdentifier: "Postman",
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
|
||||||
|
```
|
||||||
|
### Override Server URL Per-Operation
|
||||||
|
|
||||||
|
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
const plexAPI = new PlexAPI({
|
||||||
|
xPlexClientIdentifier: "Postman",
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await plexAPI.plex.getPin(false, "Postman", {
|
||||||
|
serverURL: "https://plex.tv/api/v2",
|
||||||
|
});
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
|
||||||
|
```
|
||||||
<!-- End Server Selection [server] -->
|
<!-- End Server Selection [server] -->
|
||||||
|
|
||||||
<!-- Start Custom HTTP Client [http-client] -->
|
<!-- Start Custom HTTP Client [http-client] -->
|
||||||
@@ -248,7 +327,7 @@ const httpClient = new HTTPClient({
|
|||||||
|
|
||||||
httpClient.addHook("beforeRequest", (request) => {
|
httpClient.addHook("beforeRequest", (request) => {
|
||||||
const nextRequest = new Request(request, {
|
const nextRequest = new Request(request, {
|
||||||
signal: request.signal || AbortSignal.timeout(5000);
|
signal: request.signal || AbortSignal.timeout(5000)
|
||||||
});
|
});
|
||||||
|
|
||||||
nextRequest.headers.set("x-custom-header", "custom value");
|
nextRequest.headers.set("x-custom-header", "custom value");
|
||||||
@@ -282,18 +361,16 @@ To authenticate with the API the `accessToken` parameter must be set when initia
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
xPlexClientIdentifier: "Postman",
|
||||||
});
|
});
|
||||||
|
|
||||||
const res = await sdk.server.getServerCapabilities();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
if (res?.statusCode !== 200) {
|
// Handle the result
|
||||||
throw new Error("Unexpected status code: " + res?.statusCode || "-");
|
console.log(result);
|
||||||
}
|
|
||||||
|
|
||||||
// handle response
|
|
||||||
}
|
}
|
||||||
|
|
||||||
run();
|
run();
|
||||||
@@ -301,6 +378,53 @@ run();
|
|||||||
```
|
```
|
||||||
<!-- End Authentication [security] -->
|
<!-- End Authentication [security] -->
|
||||||
|
|
||||||
|
<!-- Start Requirements [requirements] -->
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
|
||||||
|
<!-- End Requirements [requirements] -->
|
||||||
|
|
||||||
|
<!-- Start Global Parameters [global-parameters] -->
|
||||||
|
## Global Parameters
|
||||||
|
|
||||||
|
A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
|
||||||
|
|
||||||
|
For example, you can set `X-Plex-Client-Identifier` to `"Postman"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getPin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
||||||
|
|
||||||
|
|
||||||
|
### Available Globals
|
||||||
|
|
||||||
|
The following global parameter is available. The required parameter must be set when you initialize the SDK client.
|
||||||
|
|
||||||
|
| Name | Type | Required | Description |
|
||||||
|
| ---- | ---- |:--------:| ----------- |
|
||||||
|
| xPlexClientIdentifier | string | ✔️ | The unique identifier for the client application
|
||||||
|
This is used to track the client application and its usage
|
||||||
|
(UUID, serial number, or other number unique per device)
|
||||||
|
|
|
||||||
|
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
const plexAPI = new PlexAPI({
|
||||||
|
xPlexClientIdentifier: "Postman",
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await plexAPI.plex.getPin(false, "Postman");
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End Global Parameters [global-parameters] -->
|
||||||
|
|
||||||
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
||||||
|
|
||||||
# Development
|
# Development
|
||||||
|
|||||||
530
RELEASES.md
530
RELEASES.md
@@ -49,3 +49,533 @@ Based on:
|
|||||||
- [typescript v0.3.1] .
|
- [typescript v0.3.1] .
|
||||||
### Releases
|
### Releases
|
||||||
- [NPM v0.3.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.1 - .
|
- [NPM v0.3.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.1 - .
|
||||||
|
|
||||||
|
## 2024-01-09 00:28:08
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.134.0 (2.230.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.3.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.3.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.2 - .
|
||||||
|
|
||||||
|
## 2024-01-10 00:27:58
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.134.1 (2.230.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.3.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.3.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.3 - .
|
||||||
|
|
||||||
|
## 2024-01-16 00:27:43
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.141.1 (2.233.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.4.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.4.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.4.0 - .
|
||||||
|
|
||||||
|
## 2024-01-17 00:27:57
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.142.1 (2.234.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.4.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.4.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.4.0 - .
|
||||||
|
|
||||||
|
## 2024-01-18 23:37:12
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.147.0 (2.237.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.4.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.4.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.4.1 - .
|
||||||
|
|
||||||
|
## 2024-01-19 17:27:25
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.147.0 (2.237.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.4.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.4.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.4.2 - .
|
||||||
|
|
||||||
|
## 2024-01-20 03:10:24
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.148.0 (2.237.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.5.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.5.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.5.0 - .
|
||||||
|
|
||||||
|
## 2024-01-22 17:16:30
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.148.0 (2.237.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.5.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.5.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.5.1 - .
|
||||||
|
|
||||||
|
## 2024-01-23 20:47:26
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.150.0 (2.237.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.5.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.5.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.5.2 - .
|
||||||
|
|
||||||
|
## 2024-01-23 21:55:23
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.150.0 (2.237.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.5.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.5.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.5.3 - .
|
||||||
|
|
||||||
|
## 2024-01-31 15:05:58
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.158.0 (2.239.4) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.6.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.6.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.6.0 - .
|
||||||
|
|
||||||
|
## 2024-02-01 00:27:20
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.161.0 (2.245.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.6.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.6.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.6.1 - .
|
||||||
|
|
||||||
|
## 2024-02-05 14:23:50
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.166.1 (2.249.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.7.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.7.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.7.0 - .
|
||||||
|
|
||||||
|
## 2024-02-23 14:46:22
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.193.0 (2.269.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.8.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.8.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.8.0 - .
|
||||||
|
|
||||||
|
## 2024-02-24 00:24:27
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.193.4 (2.272.4) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.9.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.9.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.9.0 - .
|
||||||
|
|
||||||
|
## 2024-03-01 00:29:35
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.198.1 (2.275.4) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.9.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.9.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.9.1 - .
|
||||||
|
|
||||||
|
## 2024-03-02 00:24:38
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.200.0 (2.277.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.9.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.9.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.9.2 - .
|
||||||
|
|
||||||
|
## 2024-03-08 00:26:13
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.204.1 (2.279.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.10.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.10.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.10.0 - .
|
||||||
|
|
||||||
|
## 2024-03-13 00:25:35
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.207.1 (2.280.6) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.10.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.10.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.10.1 - .
|
||||||
|
|
||||||
|
## 2024-03-14 00:25:24
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.209.2 (2.281.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.10.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.10.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.10.2 - .
|
||||||
|
|
||||||
|
## 2024-03-15 15:02:11
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.209.3 (2.281.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.10.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.10.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.10.3 - .
|
||||||
|
|
||||||
|
## 2024-03-20 00:25:49
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.213.0 (2.283.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.10.4] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.10.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.10.4 - .
|
||||||
|
|
||||||
|
## 2024-03-27 00:25:29
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.227.0 (2.291.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.11.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.11.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.11.0 - .
|
||||||
|
|
||||||
|
## 2024-03-29 16:36:42
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.228.1 (2.292.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.12.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.12.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.12.0 - .
|
||||||
|
|
||||||
|
## 2024-04-02 00:26:20
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.231.1 (2.295.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.12.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.12.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.12.1 - .
|
||||||
|
|
||||||
|
## 2024-04-13 00:23:00
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.252.0 (2.306.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.12.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.12.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.12.2 - .
|
||||||
|
|
||||||
|
## 2024-04-18 00:26:16
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.257.1 (2.308.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.12.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.12.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.12.3 - .
|
||||||
|
|
||||||
|
## 2024-04-19 00:26:47
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.260.6 (2.311.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.13.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.13.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.0 - .
|
||||||
|
|
||||||
|
## 2024-04-20 00:26:02
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.267.0 (2.312.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.13.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.13.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.0 - .
|
||||||
|
|
||||||
|
## 2024-04-22 16:14:48
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.267.2 (2.312.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.13.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.13.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.1 - .
|
||||||
|
|
||||||
|
## 2024-04-22 16:25:57
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.267.2 (2.312.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.13.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.13.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.2 - .
|
||||||
|
|
||||||
|
## 2024-04-23 00:26:56
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.269.1 (2.312.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.13.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.13.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.2 - .
|
||||||
|
|
||||||
|
## 2024-04-25 00:28:39
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.274.1 (2.314.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.0 - .
|
||||||
|
|
||||||
|
## 2024-04-26 00:27:03
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.274.1 (2.314.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.0 - .
|
||||||
|
|
||||||
|
## 2024-04-27 00:26:14
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.276.0 (2.314.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.0 - .
|
||||||
|
|
||||||
|
## 2024-04-28 00:29:48
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.276.0 (2.314.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.0 - .
|
||||||
|
|
||||||
|
## 2024-04-29 00:27:42
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.276.0 (2.314.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.0 - .
|
||||||
|
|
||||||
|
## 2024-04-30 00:26:07
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.277.0 (2.317.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.1 - .
|
||||||
|
|
||||||
|
## 2024-05-01 00:29:15
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.277.4 (2.318.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.1 - .
|
||||||
|
|
||||||
|
## 2024-05-02 00:26:42
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.277.4 (2.318.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.1 - .
|
||||||
|
|
||||||
|
## 2024-05-03 00:27:14
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.277.8 (2.319.10) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.2 - .
|
||||||
|
|
||||||
|
## 2024-05-04 00:26:20
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.279.0 (2.322.5) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.2 - .
|
||||||
|
|
||||||
|
## 2024-05-05 00:29:26
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.279.0 (2.322.5) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.2 - .
|
||||||
|
|
||||||
|
## 2024-05-06 00:28:07
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.279.0 (2.322.5) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.2 - .
|
||||||
|
|
||||||
|
## 2024-05-07 00:27:12
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.280.1 (2.322.5) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.2 - .
|
||||||
|
|
||||||
|
## 2024-05-08 00:22:14
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.283.1 (2.324.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.14.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.14.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.2 - .
|
||||||
|
|
||||||
|
## 2024-05-08 18:14:57
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.285.0 (2.326.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.15.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.15.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.15.0 - .
|
||||||
|
|
||||||
|
## 2024-05-09 00:26:57
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.285.1 (2.326.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.15.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.15.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.15.0 - .
|
||||||
|
|
||||||
|
## 2024-05-09 03:30:33
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.285.1 (2.326.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.15.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.15.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.15.1 - .
|
||||||
|
|
||||||
|
## 2024-05-09 03:45:22
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.285.1 (2.326.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.15.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.15.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.15.2 - .
|
||||||
|
|
||||||
|
## 2024-05-09 04:14:12
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.285.1 (2.326.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.15.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.15.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.15.3 - .
|
||||||
|
|
||||||
|
## 2024-05-09 04:22:48
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.285.1 (2.326.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.15.4] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.15.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.15.4 - .
|
||||||
|
|
||||||
|
## 2024-05-23 15:56:57
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.295.1 (2.335.5) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.16.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.16.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.0 - .
|
||||||
22
RUNTIMES.md
Normal file
22
RUNTIMES.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
# Supported JavaScript runtimes
|
||||||
|
|
||||||
|
This SDK is intended to be used in JavaScript runtimes that support 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
|
||||||
14
USAGE.md
14
USAGE.md
@@ -2,18 +2,16 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
xPlexClientIdentifier: "Postman",
|
||||||
});
|
});
|
||||||
|
|
||||||
const res = await sdk.server.getServerCapabilities();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
if (res?.statusCode !== 200) {
|
// Handle the result
|
||||||
throw new Error("Unexpected status code: " + res?.statusCode || "-");
|
console.log(result);
|
||||||
}
|
|
||||||
|
|
||||||
// handle response
|
|
||||||
}
|
}
|
||||||
|
|
||||||
run();
|
run();
|
||||||
|
|||||||
1322
codeSamples.yaml
Normal file
1322
codeSamples.yaml
Normal file
File diff suppressed because it is too large
Load Diff
@@ -1,11 +0,0 @@
|
|||||||
# GetCommonLibraryItemsResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
|
||||||
| `errors` | [errors.GetCommonLibraryItemsErrors](../../models/errors/getcommonlibraryitemserrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
10
docs/models/errors/getpinerrors.md
Normal file
10
docs/models/errors/getpinerrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetPinErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
@@ -1,10 +1,11 @@
|
|||||||
# GetLatestLibraryItemsResponse
|
# GetPinResponseBody
|
||||||
|
|
||||||
|
X-Plex-Client-Identifier is missing
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `errors` | [errors.GetPinErrors](../../models/errors/getpinerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
| `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_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetLatestLibraryItemsErrors
|
# GetStatisticsErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
11
docs/models/errors/getstatisticsresponsebody.md
Normal file
11
docs/models/errors/getstatisticsresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetStatisticsResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetStatisticsErrors](../../models/errors/getstatisticserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/models/errors/gettokenerrors.md
Normal file
10
docs/models/errors/gettokenerrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetTokenErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
11
docs/models/errors/gettokenresponsebody.md
Normal file
11
docs/models/errors/gettokenresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetTokenResponseBody
|
||||||
|
|
||||||
|
X-Plex-Client-Identifier is missing
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetTokenErrors](../../models/errors/gettokenerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetCommonLibraryItemsErrors
|
# SearchLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
11
docs/models/errors/searchlibraryresponsebody.md
Normal file
11
docs/models/errors/searchlibraryresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# SearchLibraryResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.SearchLibraryErrors](../../models/errors/searchlibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
15
docs/models/operations/account.md
Normal file
15
docs/models/operations/account.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# Account
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A | 238960586 |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | /accounts/238960586 |
|
||||||
|
| `name` | *string* | :heavy_minus_sign: | N/A | Diane |
|
||||||
|
| `defaultAudioLanguage` | *string* | :heavy_minus_sign: | N/A | en |
|
||||||
|
| `autoSelectAudio` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `defaultSubtitleLanguage` | *string* | :heavy_minus_sign: | N/A | en |
|
||||||
|
| `subtitleMode` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `thumb` | *string* | :heavy_minus_sign: | N/A | https://plex.tv/users/50d83634246da1de/avatar?c=1707110967 |
|
||||||
11
docs/models/operations/addplaylistcontentsmediacontainer.md
Normal file
11
docs/models/operations/addplaylistcontentsmediacontainer.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# AddPlaylistContentsMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `leafCountAdded` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `leafCountRequested` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `metadata` | [operations.AddPlaylistContentsMetadata](../../models/operations/addplaylistcontentsmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
20
docs/models/operations/addplaylistcontentsmetadata.md
Normal file
20
docs/models/operations/addplaylistcontentsmetadata.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# AddPlaylistContentsMetadata
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||||
|
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 94 |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | /playlists/94/items |
|
||||||
|
| `guid` | *string* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2 |
|
||||||
|
| `type` | *string* | :heavy_minus_sign: | N/A | playlist |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | N/A | A great playlist |
|
||||||
|
| `summary` | *string* | :heavy_minus_sign: | N/A | One of my great playlists |
|
||||||
|
| `smart` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `playlistType` | *string* | :heavy_minus_sign: | N/A | video |
|
||||||
|
| `composite` | *string* | :heavy_minus_sign: | N/A | /playlists/94/composite/1705800070 |
|
||||||
|
| `duration` | *number* | :heavy_minus_sign: | N/A | 423000 |
|
||||||
|
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 3 |
|
||||||
|
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1705716458 |
|
||||||
|
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705800070 |
|
||||||
@@ -4,7 +4,7 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||||
| `playlistID` | *number* | :heavy_check_mark: | the ID of the playlist | |
|
| `playlistID` | *number* | :heavy_check_mark: | the ID of the playlist | |
|
||||||
| `uri` | *string* | :heavy_check_mark: | the content URI for the playlist | library://.. |
|
| `uri` | *string* | :heavy_check_mark: | the content URI for the playlist | server://12345/com.plexapp.plugins.library/library/metadata/1 |
|
||||||
| `playQueueID` | *number* | :heavy_check_mark: | the play queue to add to a playlist | 123 |
|
| `playQueueID` | *number* | :heavy_minus_sign: | the play queue to add to a playlist | 123 |
|
||||||
@@ -4,7 +4,8 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code 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 |
|
| `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.AddPlaylistContentsResponseBody](../../models/operations/addplaylistcontentsresponsebody.md) | :heavy_minus_sign: | Playlist Updated |
|
||||||
10
docs/models/operations/addplaylistcontentsresponsebody.md
Normal file
10
docs/models/operations/addplaylistcontentsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# AddPlaylistContentsResponseBody
|
||||||
|
|
||||||
|
Playlist Updated
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `mediaContainer` | [operations.AddPlaylistContentsMediaContainer](../../models/operations/addplaylistcontentsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `tonight` | [operations.Tonight](../../models/operations/tonight.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install |
|
| `tonight` | [operations.Tonight](../../models/operations/tonight.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install | 1 |
|
||||||
| `skip` | [operations.Skip](../../models/operations/skip.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The <Release> entry for this version will have the `state` set to `skipped`. |
|
| `skip` | [operations.Skip](../../models/operations/skip.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The <Release> entry for this version will have the `state` set to `skipped`. | 1 |
|
||||||
@@ -3,6 +3,6 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||||
| `activityUUID` | *string* | :heavy_check_mark: | The UUID of the activity to cancel. |
|
| `activityUUID` | *string* | :heavy_check_mark: | The UUID of the activity to cancel. | 25b71ed5-0f9d-461c-baa7-d404e9e10d3e |
|
||||||
@@ -3,6 +3,6 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||||
| `download` | [operations.Download](../../models/operations/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. |
|
| `download` | [operations.Download](../../models/operations/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |
|
||||||
9
docs/models/operations/createplaylistmediacontainer.md
Normal file
9
docs/models/operations/createplaylistmediacontainer.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# CreatePlaylistMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *number* | :heavy_minus_sign: | N/A | 7 |
|
||||||
|
| `metadata` | [operations.CreatePlaylistMetadata](../../models/operations/createplaylistmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
23
docs/models/operations/createplaylistmetadata.md
Normal file
23
docs/models/operations/createplaylistmetadata.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# CreatePlaylistMetadata
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||||
|
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 96 |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | /playlists/96/items |
|
||||||
|
| `guid` | *string* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55 |
|
||||||
|
| `type` | *string* | :heavy_minus_sign: | N/A | playlist |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | N/A | A Great Playlist |
|
||||||
|
| `summary` | *string* | :heavy_minus_sign: | N/A | What a great playlist |
|
||||||
|
| `smart` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `playlistType` | *string* | :heavy_minus_sign: | N/A | video |
|
||||||
|
| `icon` | *string* | :heavy_minus_sign: | N/A | playlist://image.smart |
|
||||||
|
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1705719589 |
|
||||||
|
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1705719589 |
|
||||||
|
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705724593 |
|
||||||
|
| `composite` | *string* | :heavy_minus_sign: | N/A | /playlists/96/composite/1705724593 |
|
||||||
|
| `duration` | *number* | :heavy_minus_sign: | N/A | 141000 |
|
||||||
@@ -4,9 +4,9 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||||
| `title` | *string* | :heavy_check_mark: | name of the playlist |
|
| `title` | *string* | :heavy_check_mark: | name of the playlist |
|
||||||
| `type` | [operations.TypeT](../../models/operations/typet.md) | :heavy_check_mark: | type of playlist to create |
|
| `type` | [operations.QueryParamType](../../models/operations/queryparamtype.md) | :heavy_check_mark: | type of playlist to create |
|
||||||
| `smart` | [operations.Smart](../../models/operations/smart.md) | :heavy_check_mark: | whether the playlist is smart or not |
|
| `smart` | [operations.Smart](../../models/operations/smart.md) | :heavy_check_mark: | whether the playlist is smart or not |
|
||||||
| `uri` | *string* | :heavy_minus_sign: | the content URI for the playlist |
|
| `uri` | *string* | :heavy_check_mark: | the content URI for the playlist |
|
||||||
| `playQueueID` | *number* | :heavy_minus_sign: | the play queue to copy to a playlist |
|
| `playQueueID` | *number* | :heavy_minus_sign: | the play queue to copy to a playlist |
|
||||||
@@ -4,7 +4,8 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code 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 |
|
| `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.CreatePlaylistResponseBody](../../models/operations/createplaylistresponsebody.md) | :heavy_minus_sign: | returns all playlists |
|
||||||
10
docs/models/operations/createplaylistresponsebody.md
Normal file
10
docs/models/operations/createplaylistresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CreatePlaylistResponseBody
|
||||||
|
|
||||||
|
returns all playlists
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||||
|
| `mediaContainer` | [operations.CreatePlaylistMediaContainer](../../models/operations/createplaylistmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
11
docs/models/operations/field.md
Normal file
11
docs/models/operations/field.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# Field
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | label |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | N/A | Label |
|
||||||
|
| `type` | *string* | :heavy_minus_sign: | N/A | tag |
|
||||||
|
| `subType` | *string* | :heavy_minus_sign: | N/A | bitrate |
|
||||||
9
docs/models/operations/fieldtype.md
Normal file
9
docs/models/operations/fieldtype.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# FieldType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||||
|
| `type` | *string* | :heavy_minus_sign: | N/A | resolution |
|
||||||
|
| `operator` | [operations.Operator](../../models/operations/operator.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
12
docs/models/operations/filter.md
Normal file
12
docs/models/operations/filter.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# Filter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||||
|
| `filter` | *string* | :heavy_minus_sign: | N/A | label |
|
||||||
|
| `filterType` | *string* | :heavy_minus_sign: | N/A | string |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/label |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | N/A | Labels |
|
||||||
|
| `type` | *string* | :heavy_minus_sign: | N/A | filter |
|
||||||
@@ -1,7 +1,9 @@
|
|||||||
# Force
|
# Force
|
||||||
|
|
||||||
force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist.
|
Force overwriting of duplicate playlists.
|
||||||
The `force` argument is used to disable overwriting. If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.
|
By default, a playlist file uploaded with the same path will overwrite the existing playlist.
|
||||||
|
The `force` argument is used to disable overwriting.
|
||||||
|
If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -4,8 +4,8 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code 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 |
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
| `responseBodies` | [operations.ResponseBody](../../models/operations/responsebody.md)[] | :heavy_minus_sign: | Available Clients |
|
| `object` | [operations.GetAvailableClientsResponseBody](../../models/operations/getavailableclientsresponsebody.md) | :heavy_minus_sign: | Available Clients |
|
||||||
@@ -1,4 +1,6 @@
|
|||||||
# ResponseBody
|
# GetAvailableClientsResponseBody
|
||||||
|
|
||||||
|
Available Clients
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetCommonLibraryItemsRequest
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
|
||||||
| `sectionId` | *number* | :heavy_check_mark: | the Id of the library to query |
|
|
||||||
| `type` | *number* | :heavy_check_mark: | item type |
|
|
||||||
| `filter` | *string* | :heavy_minus_sign: | the filter parameter |
|
|
||||||
11
docs/models/operations/getglobalhubsmediacontainer.md
Normal file
11
docs/models/operations/getglobalhubsmediacontainer.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetGlobalHubsMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
|
||||||
|
| `size` | *number* | :heavy_minus_sign: | N/A | 8 |
|
||||||
|
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||||
|
| `hub` | [operations.Hub](../../models/operations/hub.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
24
docs/models/operations/getglobalhubsmetadata.md
Normal file
24
docs/models/operations/getglobalhubsmetadata.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# GetGlobalHubsMetadata
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||||
|
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 57070 |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | /playlists/57070/items |
|
||||||
|
| `guid` | *string* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c |
|
||||||
|
| `type` | *string* | :heavy_minus_sign: | N/A | playlist |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | N/A | November Movie Day |
|
||||||
|
| `titleSort` | *string* | :heavy_minus_sign: | N/A | Tracks |
|
||||||
|
| `summary` | *string* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `smart` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `playlistType` | *string* | :heavy_minus_sign: | N/A | video |
|
||||||
|
| `composite` | *string* | :heavy_minus_sign: | N/A | /playlists/57070/composite/1668787730 |
|
||||||
|
| `icon` | *string* | :heavy_minus_sign: | N/A | playlist://image.smart |
|
||||||
|
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 2 |
|
||||||
|
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1668787732 |
|
||||||
|
| `duration` | *number* | :heavy_minus_sign: | N/A | 16873000 |
|
||||||
|
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 3 |
|
||||||
|
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1668779618 |
|
||||||
|
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1668787730 |
|
||||||
@@ -4,7 +4,8 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code 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 |
|
| `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.GetGlobalHubsResponseBody](../../models/operations/getglobalhubsresponsebody.md) | :heavy_minus_sign: | returns global hubs |
|
||||||
10
docs/models/operations/getglobalhubsresponsebody.md
Normal file
10
docs/models/operations/getglobalhubsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetGlobalHubsResponseBody
|
||||||
|
|
||||||
|
returns global hubs
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||||
|
| `mediaContainer` | [operations.GetGlobalHubsMediaContainer](../../models/operations/getglobalhubsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetLatestLibraryItemsRequest
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
|
||||||
| `sectionId` | *number* | :heavy_check_mark: | the Id of the library to query |
|
|
||||||
| `type` | *number* | :heavy_check_mark: | item type |
|
|
||||||
| `filter` | *string* | :heavy_minus_sign: | the filter parameter |
|
|
||||||
28
docs/models/operations/getlibrariesdirectory.md
Normal file
28
docs/models/operations/getlibrariesdirectory.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
# GetLibrariesDirectory
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||||
|
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
||||||
|
| `composite` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/composite/1705615584 |
|
||||||
|
| `filters` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `refreshing` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||||
|
| `agent` | *string* | :heavy_minus_sign: | N/A | tv.plex.agents.movie |
|
||||||
|
| `scanner` | *string* | :heavy_minus_sign: | N/A | Plex Movie |
|
||||||
|
| `language` | *string* | :heavy_minus_sign: | N/A | en-US |
|
||||||
|
| `uuid` | *string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||||
|
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705615634 |
|
||||||
|
| `createdAt` | *number* | :heavy_minus_sign: | N/A | 1654131312 |
|
||||||
|
| `scannedAt` | *number* | :heavy_minus_sign: | N/A | 1705615584 |
|
||||||
|
| `content` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `directory` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `contentChangedAt` | *number* | :heavy_minus_sign: | N/A | 3192854 |
|
||||||
|
| `hidden` | *number* | :heavy_minus_sign: | N/A | 0 |
|
||||||
|
| `location` | [operations.GetLibrariesLocation](../../models/operations/getlibrarieslocation.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
9
docs/models/operations/getlibrarieslocation.md
Normal file
9
docs/models/operations/getlibrarieslocation.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibrariesLocation
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `path` | *string* | :heavy_minus_sign: | N/A | /movies |
|
||||||
11
docs/models/operations/getlibrariesmediacontainer.md
Normal file
11
docs/models/operations/getlibrariesmediacontainer.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibrariesMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *number* | :heavy_minus_sign: | N/A | 5 |
|
||||||
|
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `title1` | *string* | :heavy_minus_sign: | N/A | Plex Library |
|
||||||
|
| `directory` | [operations.GetLibrariesDirectory](../../models/operations/getlibrariesdirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
@@ -4,7 +4,8 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code 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 |
|
| `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.GetLibrariesResponseBody](../../models/operations/getlibrariesresponsebody.md) | :heavy_minus_sign: | The libraries available on the Server |
|
||||||
10
docs/models/operations/getlibrariesresponsebody.md
Normal file
10
docs/models/operations/getlibrariesresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibrariesResponseBody
|
||||||
|
|
||||||
|
The libraries available on the Server
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||||
|
| `mediaContainer` | [operations.GetLibrariesMediaContainer](../../models/operations/getlibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
12
docs/models/operations/getlibrarydirectory.md
Normal file
12
docs/models/operations/getlibrarydirectory.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibraryDirectory
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | search?type=1 |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | N/A | Search... |
|
||||||
|
| `secondary` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `prompt` | *string* | :heavy_minus_sign: | N/A | Search Movies |
|
||||||
|
| `search` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
8
docs/models/operations/getlibraryhubscountry.md
Normal file
8
docs/models/operations/getlibraryhubscountry.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibraryHubsCountry
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||||
|
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America |
|
||||||
8
docs/models/operations/getlibraryhubsdirector.md
Normal file
8
docs/models/operations/getlibraryhubsdirector.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibraryHubsDirector
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `tag` | *string* | :heavy_minus_sign: | N/A | Nathan Greno |
|
||||||
8
docs/models/operations/getlibraryhubsgenre.md
Normal file
8
docs/models/operations/getlibraryhubsgenre.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibraryHubsGenre
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `tag` | *string* | :heavy_minus_sign: | N/A | Animation |
|
||||||
19
docs/models/operations/getlibraryhubshub.md
Normal file
19
docs/models/operations/getlibraryhubshub.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# GetLibraryHubsHub
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/all?sort=lastViewedAt:desc&unwatched=0&viewOffset=0 |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | N/A | Recently Played Movies |
|
||||||
|
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||||
|
| `hubIdentifier` | *string* | :heavy_minus_sign: | N/A | movie.recentlyviewed.1 |
|
||||||
|
| `context` | *string* | :heavy_minus_sign: | N/A | hub.movie.recentlyviewed |
|
||||||
|
| `size` | *number* | :heavy_minus_sign: | N/A | 6 |
|
||||||
|
| `more` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `style` | *string* | :heavy_minus_sign: | N/A | shelf |
|
||||||
|
| `hubKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66485,66098,57249,11449,5858,14944 |
|
||||||
|
| `metadata` | [operations.GetLibraryHubsMetadata](../../models/operations/getlibraryhubsmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `promoted` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `random` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
24
docs/models/operations/getlibraryhubsmedia.md
Normal file
24
docs/models/operations/getlibraryhubsmedia.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# GetLibraryHubsMedia
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A | 38247 |
|
||||||
|
| `duration` | *number* | :heavy_minus_sign: | N/A | 6017237 |
|
||||||
|
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 2051 |
|
||||||
|
| `width` | *number* | :heavy_minus_sign: | N/A | 1920 |
|
||||||
|
| `height` | *number* | :heavy_minus_sign: | N/A | 1080 |
|
||||||
|
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 1.78 |
|
||||||
|
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 2 |
|
||||||
|
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | aac |
|
||||||
|
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | h264 |
|
||||||
|
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 1080 |
|
||||||
|
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
|
||||||
|
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
|
||||||
|
| `optimizedForStreaming` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
||||||
|
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
|
||||||
|
| `part` | [operations.GetLibraryHubsPart](../../models/operations/getlibraryhubspart.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
14
docs/models/operations/getlibraryhubsmediacontainer.md
Normal file
14
docs/models/operations/getlibraryhubsmediacontainer.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# GetLibraryHubsMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||||
|
| `size` | *number* | :heavy_minus_sign: | N/A | 7 |
|
||||||
|
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||||
|
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||||
|
| `librarySectionUUID` | *string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||||
|
| `hub` | [operations.GetLibraryHubsHub](../../models/operations/getlibraryhubshub.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
41
docs/models/operations/getlibraryhubsmetadata.md
Normal file
41
docs/models/operations/getlibraryhubsmetadata.md
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
# GetLibraryHubsMetadata
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 14944 |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/14944 |
|
||||||
|
| `guid` | *string* | :heavy_minus_sign: | N/A | plex://movie/5d77686eeb5d26001f1eb339 |
|
||||||
|
| `studio` | *string* | :heavy_minus_sign: | N/A | Walt Disney Animation Studios |
|
||||||
|
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | N/A | Tangled |
|
||||||
|
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||||
|
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||||
|
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG |
|
||||||
|
| `summary` | *string* | :heavy_minus_sign: | N/A | The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is. |
|
||||||
|
| `rating` | *number* | :heavy_minus_sign: | N/A | 8.9 |
|
||||||
|
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 8.7 |
|
||||||
|
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1704936047 |
|
||||||
|
| `year` | *number* | :heavy_minus_sign: | N/A | 2010 |
|
||||||
|
| `tagline` | *string* | :heavy_minus_sign: | N/A | They're taking adventure to new lengths. |
|
||||||
|
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/14944/thumb/1705739847 |
|
||||||
|
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/14944/art/1705739847 |
|
||||||
|
| `duration` | *number* | :heavy_minus_sign: | N/A | 6017237 |
|
||||||
|
| `originallyAvailableAt` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2010-11-24 00:00:00 +0000 UTC |
|
||||||
|
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1589412494 |
|
||||||
|
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705739847 |
|
||||||
|
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||||
|
| `primaryExtraKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/14952 |
|
||||||
|
| `ratingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||||
|
| `media` | [operations.GetLibraryHubsMedia](../../models/operations/getlibraryhubsmedia.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `genre` | [operations.GetLibraryHubsGenre](../../models/operations/getlibraryhubsgenre.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `country` | [operations.GetLibraryHubsCountry](../../models/operations/getlibraryhubscountry.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `director` | [operations.GetLibraryHubsDirector](../../models/operations/getlibraryhubsdirector.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `role` | [operations.GetLibraryHubsRole](../../models/operations/getlibraryhubsrole.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `writer` | [operations.GetLibraryHubsWriter](../../models/operations/getlibraryhubswriter.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `skipCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `chapterSource` | *string* | :heavy_minus_sign: | N/A | media |
|
||||||
17
docs/models/operations/getlibraryhubspart.md
Normal file
17
docs/models/operations/getlibraryhubspart.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetLibraryHubsPart
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A | 38247 |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | /library/parts/38247/1589412494/file.mp4 |
|
||||||
|
| `duration` | *number* | :heavy_minus_sign: | N/A | 6017237 |
|
||||||
|
| `file` | *string* | :heavy_minus_sign: | N/A | /movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4 |
|
||||||
|
| `size` | *number* | :heavy_minus_sign: | N/A | 1545647447 |
|
||||||
|
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
||||||
|
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
|
||||||
|
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `optimizedForStreaming` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
|
||||||
@@ -4,7 +4,8 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code 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 |
|
| `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.GetLibraryHubsResponseBody](../../models/operations/getlibraryhubsresponsebody.md) | :heavy_minus_sign: | The hubs specific to the library |
|
||||||
10
docs/models/operations/getlibraryhubsresponsebody.md
Normal file
10
docs/models/operations/getlibraryhubsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibraryHubsResponseBody
|
||||||
|
|
||||||
|
The hubs specific to the library
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||||
|
| `mediaContainer` | [operations.GetLibraryHubsMediaContainer](../../models/operations/getlibraryhubsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
8
docs/models/operations/getlibraryhubsrole.md
Normal file
8
docs/models/operations/getlibraryhubsrole.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibraryHubsRole
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `tag` | *string* | :heavy_minus_sign: | N/A | Donna Murphy |
|
||||||
8
docs/models/operations/getlibraryhubswriter.md
Normal file
8
docs/models/operations/getlibraryhubswriter.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibraryHubsWriter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `tag` | *string* | :heavy_minus_sign: | N/A | Wilhelm Grimm |
|
||||||
8
docs/models/operations/getlibraryitemscountry.md
Normal file
8
docs/models/operations/getlibraryitemscountry.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibraryItemsCountry
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||||
|
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America |
|
||||||
8
docs/models/operations/getlibraryitemsdirector.md
Normal file
8
docs/models/operations/getlibraryitemsdirector.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibraryItemsDirector
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `tag` | *string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||||
8
docs/models/operations/getlibraryitemsgenre.md
Normal file
8
docs/models/operations/getlibraryitemsgenre.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibraryItemsGenre
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `tag` | *string* | :heavy_minus_sign: | N/A | Adventure |
|
||||||
21
docs/models/operations/getlibraryitemsmedia.md
Normal file
21
docs/models/operations/getlibraryitemsmedia.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetLibraryItemsMedia
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A | 119534 |
|
||||||
|
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
||||||
|
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 25025 |
|
||||||
|
| `width` | *number* | :heavy_minus_sign: | N/A | 3840 |
|
||||||
|
| `height` | *number* | :heavy_minus_sign: | N/A | 2072 |
|
||||||
|
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 1.85 |
|
||||||
|
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 6 |
|
||||||
|
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | eac3 |
|
||||||
|
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | hevc |
|
||||||
|
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 4k |
|
||||||
|
| `container` | *string* | :heavy_minus_sign: | N/A | mkv |
|
||||||
|
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
|
||||||
|
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main 10 |
|
||||||
|
| `part` | [operations.GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
23
docs/models/operations/getlibraryitemsmediacontainer.md
Normal file
23
docs/models/operations/getlibraryitemsmediacontainer.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# GetLibraryItemsMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||||
|
| `size` | *number* | :heavy_minus_sign: | N/A | 70 |
|
||||||
|
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
||||||
|
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||||
|
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||||
|
| `librarySectionUUID` | *string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||||
|
| `mediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||||
|
| `mediaTagVersion` | *number* | :heavy_minus_sign: | N/A | 1701731894 |
|
||||||
|
| `thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
||||||
|
| `title1` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||||
|
| `title2` | *string* | :heavy_minus_sign: | N/A | Recently Released |
|
||||||
|
| `viewGroup` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||||
|
| `viewMode` | *number* | :heavy_minus_sign: | N/A | 65592 |
|
||||||
|
| `mixedParents` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `metadata` | [operations.GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
64
docs/models/operations/getlibraryitemsmetadata.md
Normal file
64
docs/models/operations/getlibraryitemsmetadata.md
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
# GetLibraryItemsMetadata
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 58683 |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683 |
|
||||||
|
| `guid` | *string* | :heavy_minus_sign: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||||
|
| `studio` | *string* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||||
|
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | N/A | Avatar: The Way of Water |
|
||||||
|
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 |
|
||||||
|
| `summary` | *string* | :heavy_minus_sign: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
||||||
|
| `rating` | *number* | :heavy_minus_sign: | N/A | 7.6 |
|
||||||
|
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 9.2 |
|
||||||
|
| `year` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
||||||
|
| `tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||||
|
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||||
|
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||||
|
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
||||||
|
| `originallyAvailableAt` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
||||||
|
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1680457607 |
|
||||||
|
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1703239236 |
|
||||||
|
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||||
|
| `chapterSource` | *string* | :heavy_minus_sign: | N/A | media |
|
||||||
|
| `primaryExtraKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||||
|
| `ratingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||||
|
| `grandparentRatingKey` | *string* | :heavy_minus_sign: | N/A | 66 |
|
||||||
|
| `grandparentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
|
| `grandparentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||||
|
| `grandparentTitle` | *string* | :heavy_minus_sign: | N/A | Caprica |
|
||||||
|
| `grandparentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||||
|
| `grandparentArt` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||||
|
| `grandparentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||||
|
| `media` | [operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `genre` | [operations.GetLibraryItemsGenre](../../models/operations/getlibraryitemsgenre.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `country` | [operations.GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `director` | [operations.GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `writer` | [operations.GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `role` | [operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `titleSort` | *string* | :heavy_minus_sign: | N/A | Whale |
|
||||||
|
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||||
|
| `originalTitle` | *string* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
||||||
|
| `viewOffset` | *number* | :heavy_minus_sign: | N/A | 5222500 |
|
||||||
|
| `skipCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `index` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `theme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
||||||
|
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 14 |
|
||||||
|
| `viewedLeafCount` | *number* | :heavy_minus_sign: | N/A | 0 |
|
||||||
|
| `childCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `hasPremiumExtras` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `hasPremiumPrimaryExtra` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `parentRatingKey` | *string* | :heavy_minus_sign: | N/A | 66 |
|
||||||
|
| `parentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
|
| `parentStudio` | *string* | :heavy_minus_sign: | N/A | UCP |
|
||||||
|
| `parentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||||
|
| `parentTitle` | *string* | :heavy_minus_sign: | N/A | Caprica |
|
||||||
|
| `parentIndex` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `parentYear` | *number* | :heavy_minus_sign: | N/A | 2010 |
|
||||||
|
| `parentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||||
|
| `parentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||||
14
docs/models/operations/getlibraryitemspart.md
Normal file
14
docs/models/operations/getlibraryitemspart.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# GetLibraryItemsPart
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A | 119542 |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||||
|
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
||||||
|
| `file` | *string* | :heavy_minus_sign: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||||
|
| `size` | *number* | :heavy_minus_sign: | N/A | 36158371307 |
|
||||||
|
| `container` | *string* | :heavy_minus_sign: | N/A | mkv |
|
||||||
|
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main 10 |
|
||||||
@@ -3,8 +3,7 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||||
| `sectionId` | *number* | :heavy_check_mark: | the Id of the library to query |
|
| `sectionId` | *number* | :heavy_check_mark: | the Id of the library to query | 1 |
|
||||||
| `type` | *number* | :heavy_minus_sign: | item type |
|
| `tag` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||||
| `filter` | *string* | :heavy_minus_sign: | the filter parameter |
|
|
||||||
@@ -4,7 +4,8 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code 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 |
|
| `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.GetLibraryItemsResponseBody](../../models/operations/getlibraryitemsresponsebody.md) | :heavy_minus_sign: | The contents of the library by section and tag |
|
||||||
10
docs/models/operations/getlibraryitemsresponsebody.md
Normal file
10
docs/models/operations/getlibraryitemsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibraryItemsResponseBody
|
||||||
|
|
||||||
|
The contents of the library by section and tag
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||||
|
| `mediaContainer` | [operations.GetLibraryItemsMediaContainer](../../models/operations/getlibraryitemsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
8
docs/models/operations/getlibraryitemsrole.md
Normal file
8
docs/models/operations/getlibraryitemsrole.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibraryItemsRole
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `tag` | *string* | :heavy_minus_sign: | N/A | Sigourney Weaver |
|
||||||
8
docs/models/operations/getlibraryitemswriter.md
Normal file
8
docs/models/operations/getlibraryitemswriter.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibraryItemsWriter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `tag` | *string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||||
22
docs/models/operations/getlibrarymediacontainer.md
Normal file
22
docs/models/operations/getlibrarymediacontainer.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
# GetLibraryMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *number* | :heavy_minus_sign: | N/A | 29 |
|
||||||
|
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
||||||
|
| `content` | *string* | :heavy_minus_sign: | N/A | secondary |
|
||||||
|
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||||
|
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `mediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||||
|
| `mediaTagVersion` | *number* | :heavy_minus_sign: | N/A | 1701731894 |
|
||||||
|
| `thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
||||||
|
| `title1` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||||
|
| `viewGroup` | *string* | :heavy_minus_sign: | N/A | secondary |
|
||||||
|
| `viewMode` | *number* | :heavy_minus_sign: | N/A | 65592 |
|
||||||
|
| `directory` | [operations.GetLibraryDirectory](../../models/operations/getlibrarydirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `type` | [operations.GetLibraryType](../../models/operations/getlibrarytype.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `fieldType` | [operations.FieldType](../../models/operations/fieldtype.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
@@ -4,7 +4,8 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code 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 |
|
| `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.GetLibraryResponseBody](../../models/operations/getlibraryresponsebody.md) | :heavy_minus_sign: | The details of the library |
|
||||||
@@ -1,11 +1,10 @@
|
|||||||
# GetLatestLibraryItemsResponseBody
|
# GetLibraryResponseBody
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
The details of the library
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | [errors.GetLatestLibraryItemsErrors](../../models/errors/getlatestlibraryitemserrors.md)[] | :heavy_minus_sign: | N/A |
|
| `mediaContainer` | [operations.GetLibraryMediaContainer](../../models/operations/getlibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
14
docs/models/operations/getlibrarytype.md
Normal file
14
docs/models/operations/getlibrarytype.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# GetLibraryType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/all?type=1 |
|
||||||
|
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||||
|
| `active` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `filter` | [operations.Filter](../../models/operations/filter.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `sort` | [operations.Sort](../../models/operations/sort.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `field` | [operations.Field](../../models/operations/field.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
12
docs/models/operations/getmetadatachildrendirectory.md
Normal file
12
docs/models/operations/getmetadatachildrendirectory.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetMetadataChildrenDirectory
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||||
|
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 16 |
|
||||||
|
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072/thumb/1705739923 |
|
||||||
|
| `viewedLeafCount` | *number* | :heavy_minus_sign: | N/A | 16 |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072/allLeaves |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | N/A | All episodes |
|
||||||
30
docs/models/operations/getmetadatachildrenmediacontainer.md
Normal file
30
docs/models/operations/getmetadatachildrenmediacontainer.md
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
# GetMetadataChildrenMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *number* | :heavy_minus_sign: | N/A | 3 |
|
||||||
|
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072/art/1705739923 |
|
||||||
|
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | 30072 |
|
||||||
|
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 2 |
|
||||||
|
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | TV Shows |
|
||||||
|
| `librarySectionUUID` | *string* | :heavy_minus_sign: | N/A | 4bb2521c-8ba9-459b-aaee-8ab8bc35eabd |
|
||||||
|
| `mediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||||
|
| `mediaTagVersion` | *number* | :heavy_minus_sign: | N/A | 1701731894 |
|
||||||
|
| `nocache` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `parentIndex` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `parentTitle` | *string* | :heavy_minus_sign: | N/A | Reacher |
|
||||||
|
| `parentYear` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
||||||
|
| `summary` | *string* | :heavy_minus_sign: | N/A | When retired Military Police Officer Jack Reacher is arrested for a murder he did not commit, he finds himself in the middle of a deadly conspiracy full of dirty cops, shady businessmen, and scheming politicians. With nothing but his wits, he must figure out what is happening in Margrave, Georgia. |
|
||||||
|
| `theme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072/theme/1705739923 |
|
||||||
|
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072/thumb/1705739923 |
|
||||||
|
| `title1` | *string* | :heavy_minus_sign: | N/A | TV Shows |
|
||||||
|
| `title2` | *string* | :heavy_minus_sign: | N/A | Reacher |
|
||||||
|
| `viewGroup` | *string* | :heavy_minus_sign: | N/A | season |
|
||||||
|
| `viewMode` | *number* | :heavy_minus_sign: | N/A | 65593 |
|
||||||
|
| `directory` | [operations.GetMetadataChildrenDirectory](../../models/operations/getmetadatachildrendirectory.md)[] | :heavy_minus_sign: | N/A | [<br/>{<br/>"leafCount": 16,<br/>"thumb": "/library/metadata/30072/thumb/1705739923",<br/>"viewedLeafCount": 16,<br/>"key": "/library/metadata/30072/allLeaves",<br/>"title": "All episodes"<br/>}<br/>] |
|
||||||
|
| `metadata` | [operations.GetMetadataChildrenMetadata](../../models/operations/getmetadatachildrenmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
34
docs/models/operations/getmetadatachildrenmetadata.md
Normal file
34
docs/models/operations/getmetadatachildrenmetadata.md
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
# GetMetadataChildrenMetadata
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 66488 |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66488/children |
|
||||||
|
| `parentRatingKey` | *string* | :heavy_minus_sign: | N/A | 30072 |
|
||||||
|
| `guid` | *string* | :heavy_minus_sign: | N/A | plex://season/652aea6549508477c34c6000 |
|
||||||
|
| `parentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c09190aaccd001f8f42f0 |
|
||||||
|
| `parentStudio` | *string* | :heavy_minus_sign: | N/A | Amazon Studios |
|
||||||
|
| `type` | *string* | :heavy_minus_sign: | N/A | season |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | N/A | Season 2 |
|
||||||
|
| `parentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072 |
|
||||||
|
| `parentTitle` | *string* | :heavy_minus_sign: | N/A | Reacher |
|
||||||
|
| `summary` | *string* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge. |
|
||||||
|
| `index` | *number* | :heavy_minus_sign: | N/A | 2 |
|
||||||
|
| `parentIndex` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 11 |
|
||||||
|
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1705646565 |
|
||||||
|
| `parentYear` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
||||||
|
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66488/thumb/1703065033 |
|
||||||
|
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072/art/1705739923 |
|
||||||
|
| `parentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072/thumb/1705739923 |
|
||||||
|
| `parentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072/theme/1705739923 |
|
||||||
|
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 8 |
|
||||||
|
| `viewedLeafCount` | *number* | :heavy_minus_sign: | N/A | 8 |
|
||||||
|
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1702602021 |
|
||||||
|
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1703065033 |
|
||||||
|
| `userRating` | *number* | :heavy_minus_sign: | N/A | 9 |
|
||||||
|
| `skipCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `lastRatedAt` | *number* | :heavy_minus_sign: | N/A | 1703881224 |
|
||||||
@@ -4,7 +4,8 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code 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 |
|
| `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.GetMetadataChildrenResponseBody](../../models/operations/getmetadatachildrenresponsebody.md) | :heavy_minus_sign: | The children of the library item. |
|
||||||
10
docs/models/operations/getmetadatachildrenresponsebody.md
Normal file
10
docs/models/operations/getmetadatachildrenresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetMetadataChildrenResponseBody
|
||||||
|
|
||||||
|
The children of the library item.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `mediaContainer` | [operations.GetMetadataChildrenMediaContainer](../../models/operations/getmetadatachildrenmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/getmetadatacountry.md
Normal file
10
docs/models/operations/getmetadatacountry.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetMetadataCountry
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A | 116 |
|
||||||
|
| `filter` | *string* | :heavy_minus_sign: | N/A | country=116 |
|
||||||
|
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America |
|
||||||
12
docs/models/operations/getmetadatadirector.md
Normal file
12
docs/models/operations/getmetadatadirector.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetMetadataDirector
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A | 130 |
|
||||||
|
| `filter` | *string* | :heavy_minus_sign: | N/A | director=130 |
|
||||||
|
| `tag` | *string* | :heavy_minus_sign: | N/A | Joss Whedon |
|
||||||
|
| `tagKey` | *string* | :heavy_minus_sign: | N/A | 5d776828880197001ec90e8f |
|
||||||
|
| `thumb` | *string* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg |
|
||||||
10
docs/models/operations/getmetadatagenre.md
Normal file
10
docs/models/operations/getmetadatagenre.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetMetadataGenre
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A | 184 |
|
||||||
|
| `filter` | *string* | :heavy_minus_sign: | N/A | genre=184 |
|
||||||
|
| `tag` | *string* | :heavy_minus_sign: | N/A | Thriller |
|
||||||
24
docs/models/operations/getmetadatamedia.md
Normal file
24
docs/models/operations/getmetadatamedia.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# GetMetadataMedia
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A | 15 |
|
||||||
|
| `duration` | *number* | :heavy_minus_sign: | N/A | 141417 |
|
||||||
|
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 2278 |
|
||||||
|
| `width` | *number* | :heavy_minus_sign: | N/A | 1920 |
|
||||||
|
| `height` | *number* | :heavy_minus_sign: | N/A | 814 |
|
||||||
|
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 2.35 |
|
||||||
|
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 2 |
|
||||||
|
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | aac |
|
||||||
|
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | h264 |
|
||||||
|
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 1080 |
|
||||||
|
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
|
||||||
|
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
|
||||||
|
| `optimizedForStreaming` | *number* | :heavy_minus_sign: | N/A | 0 |
|
||||||
|
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
||||||
|
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
|
||||||
|
| `part` | [operations.GetMetadataPart](../../models/operations/getmetadatapart.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
16
docs/models/operations/getmetadatamediacontainer.md
Normal file
16
docs/models/operations/getmetadatamediacontainer.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# GetMetadataMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||||
|
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||||
|
| `librarySectionUUID` | *string* | :heavy_minus_sign: | N/A | cfc899d7-3000-46f6-8489-b9592714ada5 |
|
||||||
|
| `mediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||||
|
| `mediaTagVersion` | *number* | :heavy_minus_sign: | N/A | 1698860922 |
|
||||||
|
| `metadata` | [operations.GetMetadataMetadata](../../models/operations/getmetadatametadata.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
40
docs/models/operations/getmetadatametadata.md
Normal file
40
docs/models/operations/getmetadatametadata.md
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
# GetMetadataMetadata
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 17 |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/17 |
|
||||||
|
| `guid` | *string* | :heavy_minus_sign: | N/A | plex://movie/5d77683f6f4521001ea9dc53 |
|
||||||
|
| `studio` | *string* | :heavy_minus_sign: | N/A | Universal Pictures |
|
||||||
|
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | N/A | Serenity |
|
||||||
|
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||||
|
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||||
|
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 |
|
||||||
|
| `summary` | *string* | :heavy_minus_sign: | N/A | Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job. |
|
||||||
|
| `rating` | *number* | :heavy_minus_sign: | N/A | 8.2 |
|
||||||
|
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 9.1 |
|
||||||
|
| `year` | *number* | :heavy_minus_sign: | N/A | 2005 |
|
||||||
|
| `tagline` | *string* | :heavy_minus_sign: | N/A | They aim to misbehave. |
|
||||||
|
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/17/thumb/1705637165 |
|
||||||
|
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/17/art/1705637165 |
|
||||||
|
| `duration` | *number* | :heavy_minus_sign: | N/A | 141417 |
|
||||||
|
| `originallyAvailableAt` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2005-09-29 00:00:00 +0000 UTC |
|
||||||
|
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1705637164 |
|
||||||
|
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705637165 |
|
||||||
|
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||||
|
| `hasPremiumPrimaryExtra` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `ratingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||||
|
| `media` | [operations.GetMetadataMedia](../../models/operations/getmetadatamedia.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `genre` | [operations.GetMetadataGenre](../../models/operations/getmetadatagenre.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `country` | [operations.GetMetadataCountry](../../models/operations/getmetadatacountry.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `guids` | [operations.Guids](../../models/operations/guids.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `ratings` | [operations.Ratings](../../models/operations/ratings.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `director` | [operations.GetMetadataDirector](../../models/operations/getmetadatadirector.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `writer` | [operations.GetMetadataWriter](../../models/operations/getmetadatawriter.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `role` | [operations.GetMetadataRole](../../models/operations/getmetadatarole.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `producer` | [operations.Producer](../../models/operations/producer.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
18
docs/models/operations/getmetadatapart.md
Normal file
18
docs/models/operations/getmetadatapart.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetMetadataPart
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A | 15 |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 |
|
||||||
|
| `duration` | *number* | :heavy_minus_sign: | N/A | 141417 |
|
||||||
|
| `file` | *string* | :heavy_minus_sign: | N/A | /movies/Serenity (2005)/Serenity (2005).mp4 |
|
||||||
|
| `size` | *number* | :heavy_minus_sign: | N/A | 40271948 |
|
||||||
|
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
||||||
|
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
|
||||||
|
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `optimizedForStreaming` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
|
||||||
|
| `stream` | [operations.Stream](../../models/operations/stream.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
@@ -4,7 +4,8 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code 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 |
|
| `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.GetMetadataResponseBody](../../models/operations/getmetadataresponsebody.md) | :heavy_minus_sign: | The metadata of the library item. |
|
||||||
10
docs/models/operations/getmetadataresponsebody.md
Normal file
10
docs/models/operations/getmetadataresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetMetadataResponseBody
|
||||||
|
|
||||||
|
The metadata of the library item.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||||
|
| `mediaContainer` | [operations.GetMetadataMediaContainer](../../models/operations/getmetadatamediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
13
docs/models/operations/getmetadatarole.md
Normal file
13
docs/models/operations/getmetadatarole.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# GetMetadataRole
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A | 220 |
|
||||||
|
| `filter` | *string* | :heavy_minus_sign: | N/A | actor=220 |
|
||||||
|
| `tag` | *string* | :heavy_minus_sign: | N/A | Dennis Keiffer |
|
||||||
|
| `tagKey` | *string* | :heavy_minus_sign: | N/A | 5d77683554f42c001f8c4708 |
|
||||||
|
| `role` | *string* | :heavy_minus_sign: | N/A | Bar Guy (uncredited) |
|
||||||
|
| `thumb` | *string* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg |
|
||||||
12
docs/models/operations/getmetadatawriter.md
Normal file
12
docs/models/operations/getmetadatawriter.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetMetadataWriter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A | 132 |
|
||||||
|
| `filter` | *string* | :heavy_minus_sign: | N/A | writer=132 |
|
||||||
|
| `tag` | *string* | :heavy_minus_sign: | N/A | Joss Whedon |
|
||||||
|
| `tagKey` | *string* | :heavy_minus_sign: | N/A | 5d776828880197001ec90e8f |
|
||||||
|
| `thumb` | *string* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user