mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8360d057ab | ||
|
|
18b64727c3 | ||
|
|
3152372037 | ||
|
|
13cd8a7fe5 | ||
|
|
cdcdc0ca8e | ||
|
|
b03cc6a609 |
@@ -1,28 +0,0 @@
|
|||||||
/* eslint-env node */
|
|
||||||
module.exports = {
|
|
||||||
root: true,
|
|
||||||
extends: [
|
|
||||||
"eslint:recommended",
|
|
||||||
"plugin:@typescript-eslint/recommended",
|
|
||||||
"plugin:import/recommended",
|
|
||||||
"plugin:import/typescript",
|
|
||||||
],
|
|
||||||
parser: "@typescript-eslint/parser",
|
|
||||||
plugins: ["@typescript-eslint"],
|
|
||||||
settings: {
|
|
||||||
"import/resolver": {
|
|
||||||
typescript: true,
|
|
||||||
node: true,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
rules: {
|
|
||||||
// Handled by typescript compiler
|
|
||||||
"@typescript-eslint/no-unused-vars": "off",
|
|
||||||
"@typescript-eslint/ban-types": "off",
|
|
||||||
"@typescript-eslint/no-namespace": "off",
|
|
||||||
"@typescript-eslint/no-explicit-any": "off",
|
|
||||||
"import/no-named-as-default-member": "off",
|
|
||||||
|
|
||||||
"import/no-default-export": "error",
|
|
||||||
},
|
|
||||||
};
|
|
||||||
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1,3 +1,5 @@
|
|||||||
|
/.eslintcache
|
||||||
|
/.speakeasy/reports
|
||||||
/react-query
|
/react-query
|
||||||
/sdk/models/errors
|
/sdk/models/errors
|
||||||
/sdk/types
|
/sdk/types
|
||||||
|
|||||||
@@ -4,9 +4,10 @@
|
|||||||
!/REACT_QUERY.md
|
!/REACT_QUERY.md
|
||||||
!/**/*.ts
|
!/**/*.ts
|
||||||
!/**/*.js
|
!/**/*.js
|
||||||
|
!/**/*.json
|
||||||
!/**/*.map
|
!/**/*.map
|
||||||
|
|
||||||
/.eslintrc.js
|
/eslint.config.mjs
|
||||||
/cjs
|
/cjs
|
||||||
/.tshy
|
/.tshy
|
||||||
/.tshy-*
|
/.tshy-*
|
||||||
|
|||||||
1693
.speakeasy/gen.lock
1693
.speakeasy/gen.lock
File diff suppressed because one or more lines are too long
@@ -13,7 +13,7 @@ generation:
|
|||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
oAuth2PasswordEnabled: false
|
oAuth2PasswordEnabled: false
|
||||||
typescript:
|
typescript:
|
||||||
version: 0.32.0
|
version: 0.33.0
|
||||||
additionalDependencies:
|
additionalDependencies:
|
||||||
dependencies: {}
|
dependencies: {}
|
||||||
devDependencies: {}
|
devDependencies: {}
|
||||||
@@ -22,6 +22,7 @@ typescript:
|
|||||||
author: LukeHagar
|
author: LukeHagar
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
defaultErrorName: SDKError
|
defaultErrorName: SDKError
|
||||||
|
enableCustomCodeRegions: false
|
||||||
enableReactQuery: false
|
enableReactQuery: false
|
||||||
enumFormat: enum
|
enumFormat: enum
|
||||||
flattenGlobalSecurity: true
|
flattenGlobalSecurity: true
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
speakeasyVersion: 1.456.1
|
speakeasyVersion: 1.487.0
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
@@ -9,20 +9,20 @@ sources:
|
|||||||
- main
|
- main
|
||||||
plexapi:
|
plexapi:
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:ccba0c42f1644923e2209e28da7a78195a843e48da1aeaaedbf8759f1a8a0fe0
|
sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64
|
||||||
sourceBlobDigest: sha256:b362c110ef633288220a55ab50627374b996c64f2d9b8e020944e84ea2840332
|
sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- speakeasy-sdk-regen-1734710483
|
- speakeasy-sdk-regen-1738886999
|
||||||
- 0.0.3
|
- 0.0.3
|
||||||
targets:
|
targets:
|
||||||
plexjs:
|
plexjs:
|
||||||
source: plexapi
|
source: plexapi
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:ccba0c42f1644923e2209e28da7a78195a843e48da1aeaaedbf8759f1a8a0fe0
|
sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64
|
||||||
sourceBlobDigest: sha256:b362c110ef633288220a55ab50627374b996c64f2d9b8e020944e84ea2840332
|
sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8
|
||||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||||
codeSamplesRevisionDigest: sha256:f1245ceff6a26548b804c05954169ae215f024ea7b77438a4d6b86fdcd5a080c
|
codeSamplesRevisionDigest: sha256:cc0edeb64bf898493d4f7f9e628ac369bb39b63de609919e22052c030a54edec
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
|
|||||||
15
README.md
15
README.md
@@ -161,8 +161,11 @@ run();
|
|||||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||||
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||||
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||||
|
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
||||||
|
* [getCountriesLibrary](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
|
||||||
|
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
|
||||||
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||||
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
* [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
||||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||||
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||||
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||||
@@ -241,6 +244,10 @@ run();
|
|||||||
* [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
|
||||||
|
|
||||||
|
### [users](docs/sdks/users/README.md)
|
||||||
|
|
||||||
|
* [getUsers](docs/sdks/users/README.md#getusers) - Get list of all connected users
|
||||||
|
|
||||||
### [video](docs/sdks/video/README.md)
|
### [video](docs/sdks/video/README.md)
|
||||||
|
|
||||||
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
||||||
@@ -502,11 +509,14 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|||||||
- [`hubsGetLibraryHubs`](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
- [`hubsGetLibraryHubs`](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
||||||
- [`hubsGetRecentlyAdded`](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
|
- [`hubsGetRecentlyAdded`](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
|
||||||
- [`libraryDeleteLibrary`](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
- [`libraryDeleteLibrary`](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||||
|
- [`libraryGetActorsLibrary`](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
|
||||||
- [`libraryGetAllLibraries`](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
- [`libraryGetAllLibraries`](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
||||||
|
- [`libraryGetCountriesLibrary`](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
|
||||||
- [`libraryGetFileHash`](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
- [`libraryGetFileHash`](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||||
|
- [`libraryGetGenresLibrary`](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
||||||
- [`libraryGetLibraryDetails`](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
- [`libraryGetLibraryDetails`](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||||
- [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
- [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||||
- [`libraryGetMetaDataByRatingKey`](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
- [`libraryGetMediaMetaData`](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
||||||
- [`libraryGetMetadataChildren`](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
- [`libraryGetMetadataChildren`](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||||
- [`libraryGetOnDeck`](docs/sdks/library/README.md#getondeck) - Get On Deck
|
- [`libraryGetOnDeck`](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||||
- [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
|
- [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
|
||||||
@@ -560,6 +570,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|||||||
- [`updaterApplyUpdates`](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
- [`updaterApplyUpdates`](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
||||||
- [`updaterCheckForUpdates`](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
- [`updaterCheckForUpdates`](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
||||||
- [`updaterGetUpdateStatus`](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
|
- [`updaterGetUpdateStatus`](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
|
||||||
|
- [`usersGetUsers`](docs/sdks/users/README.md#getusers) - Get list of all connected users
|
||||||
- [`videoGetTimeline`](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
- [`videoGetTimeline`](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
||||||
- [`videoStartUniversalTranscode`](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
|
- [`videoStartUniversalTranscode`](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
|
||||||
- [`watchlistGetWatchList`](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
|
- [`watchlistGetWatchList`](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
|
||||||
|
|||||||
60
RELEASES.md
60
RELEASES.md
@@ -1159,3 +1159,63 @@ Based on:
|
|||||||
- [typescript v0.32.0] .
|
- [typescript v0.32.0] .
|
||||||
### Releases
|
### Releases
|
||||||
- [NPM v0.32.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.0 - .
|
- [NPM v0.32.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.0 - .
|
||||||
|
|
||||||
|
## 2024-12-22 00:10:48
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.459.2 (2.483.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.32.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.32.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.1 - .
|
||||||
|
|
||||||
|
## 2025-01-24 00:09:35
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.474.0 (2.495.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.32.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.32.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.2 - .
|
||||||
|
|
||||||
|
## 2025-01-27 00:09:48
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.476.1 (2.495.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.32.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.32.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.3 - .
|
||||||
|
|
||||||
|
## 2025-02-05 00:09:58
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.32.4] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.32.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.4 - .
|
||||||
|
|
||||||
|
## 2025-02-06 00:09:46
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.32.5] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.32.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.5 - .
|
||||||
|
|
||||||
|
## 2025-02-07 00:09:41
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.487.0 (2.506.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.33.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.33.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.33.0 - .
|
||||||
28
RUNTIMES.md
28
RUNTIMES.md
@@ -1,6 +1,6 @@
|
|||||||
# Supported JavaScript runtimes
|
# Supported JavaScript runtimes
|
||||||
|
|
||||||
This SDK is intended to be used in JavaScript runtimes that support the following features:
|
This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
|
||||||
|
|
||||||
* [Web Fetch API][web-fetch]
|
* [Web Fetch API][web-fetch]
|
||||||
* [Web Streams API][web-streams] and in particular `ReadableStream`
|
* [Web Streams API][web-streams] and in particular `ReadableStream`
|
||||||
@@ -20,3 +20,29 @@ Runtime environments that are explicitly supported are:
|
|||||||
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
|
- 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
|
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
|
||||||
|
|
||||||
|
## Recommended TypeScript compiler options
|
||||||
|
|
||||||
|
The following `tsconfig.json` options are recommended for projects using this
|
||||||
|
SDK in order to get static type support for features like async iterables,
|
||||||
|
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
|
||||||
|
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
|
||||||
|
so on):
|
||||||
|
|
||||||
|
[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
|
||||||
|
[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
|
||||||
|
[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
|
||||||
|
[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"target": "es2020", // or higher
|
||||||
|
"lib": ["es2020", "dom", "dom.iterable"],
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
While `target` can be set to older ECMAScript versions, it may result in extra,
|
||||||
|
unnecessary compatibility code being generated if you are not targeting old
|
||||||
|
runtimes.
|
||||||
154
codeSamples.yaml
154
codeSamples.yaml
@@ -422,7 +422,7 @@ actions:
|
|||||||
label: added
|
label: added
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { IncludeMeta, Type } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Type } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
@@ -433,9 +433,6 @@ actions:
|
|||||||
contentDirectoryID: 470161,
|
contentDirectoryID: 470161,
|
||||||
sectionID: 2,
|
sectionID: 2,
|
||||||
type: Type.TvShow,
|
type: Type.TvShow,
|
||||||
includeMeta: IncludeMeta.Enable,
|
|
||||||
xPlexContainerStart: 0,
|
|
||||||
xPlexContainerSize: 50,
|
|
||||||
});
|
});
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
@@ -456,7 +453,7 @@ actions:
|
|||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.search.performSearch("dylan", 5);
|
const result = await plexAPI.search.performSearch("dylan");
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
@@ -476,7 +473,7 @@ actions:
|
|||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.search.performVoiceSearch("dead+poop", 5);
|
const result = await plexAPI.search.performVoiceSearch("dead+poop");
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
@@ -566,7 +563,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: key
|
label: data
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -575,7 +572,22 @@ actions:
|
|||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.library.getMetaDataByRatingKey(9518);
|
const result = await plexAPI.library.getMediaMetaData({
|
||||||
|
ratingKey: 9518,
|
||||||
|
includeConcerts: true,
|
||||||
|
includeExtras: true,
|
||||||
|
includeOnDeck: true,
|
||||||
|
includePopularLeaves: true,
|
||||||
|
includePreferences: true,
|
||||||
|
includeReviews: true,
|
||||||
|
includeChapters: true,
|
||||||
|
includeStations: true,
|
||||||
|
includeExternalMedia: true,
|
||||||
|
asyncAugmentMetadata: true,
|
||||||
|
asyncCheckFiles: true,
|
||||||
|
asyncRefreshAnalysis: true,
|
||||||
|
asyncRefreshLocalMediaAgent: true,
|
||||||
|
});
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
@@ -622,7 +634,7 @@ actions:
|
|||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.library.getMetadataChildren(1539.15, "Stream");
|
const result = await plexAPI.library.getMetadataChildren(1539.14, "Stream");
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
@@ -683,7 +695,7 @@ actions:
|
|||||||
label: library
|
label: library
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { QueryParamIncludeMeta, QueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { QueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
@@ -708,9 +720,6 @@ actions:
|
|||||||
],
|
],
|
||||||
sectionID: 2,
|
sectionID: 2,
|
||||||
type: QueryParamType.TvShow,
|
type: QueryParamType.TvShow,
|
||||||
includeMeta: QueryParamIncludeMeta.Enable,
|
|
||||||
xPlexContainerStart: 0,
|
|
||||||
xPlexContainerSize: 50,
|
|
||||||
});
|
});
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
@@ -725,7 +734,7 @@ actions:
|
|||||||
label: libraries
|
label: libraries
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { QueryParamIncludeCollections, QueryParamIncludeExternalMedia, SearchTypes } from "@lukehagar/plexjs/sdk/models/operations";
|
import { SearchTypes } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
@@ -738,8 +747,6 @@ actions:
|
|||||||
searchTypes: [
|
searchTypes: [
|
||||||
SearchTypes.People,
|
SearchTypes.People,
|
||||||
],
|
],
|
||||||
includeCollections: QueryParamIncludeCollections.Enable,
|
|
||||||
includeExternalMedia: QueryParamIncludeExternalMedia.Enable,
|
|
||||||
});
|
});
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
@@ -783,8 +790,6 @@ actions:
|
|||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.watchlist.getWatchList({
|
const result = await plexAPI.watchlist.getWatchList({
|
||||||
filter: Filter.Available,
|
filter: Filter.Available,
|
||||||
xPlexContainerStart: 0,
|
|
||||||
xPlexContainerSize: 50,
|
|
||||||
xPlexToken: "CV5xoxjTpFKUzBTShsaf",
|
xPlexToken: "CV5xoxjTpFKUzBTShsaf",
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -832,6 +837,69 @@ actions:
|
|||||||
console.log(result);
|
console.log(result);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
- target: $["paths"]["/library/sections/{sectionKey}/actor"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: typescript
|
||||||
|
label: library
|
||||||
|
source: |-
|
||||||
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
import { GetActorsLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
const plexAPI = new PlexAPI({
|
||||||
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await plexAPI.library.getActorsLibrary(9518, GetActorsLibraryQueryParamType.TvShow);
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
- target: $["paths"]["/library/sections/{sectionKey}/country"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: typescript
|
||||||
|
label: library
|
||||||
|
source: |-
|
||||||
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
import { GetCountriesLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
const plexAPI = new PlexAPI({
|
||||||
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await plexAPI.library.getCountriesLibrary(9518, GetCountriesLibraryQueryParamType.TvShow);
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
- target: $["paths"]["/library/sections/{sectionKey}/genre"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: typescript
|
||||||
|
label: library
|
||||||
|
source: |-
|
||||||
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
import { GetGenresLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
const plexAPI = new PlexAPI({
|
||||||
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await plexAPI.library.getGenresLibrary(9518, GetGenresLibraryQueryParamType.TvShow);
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
run();
|
run();
|
||||||
- target: $["paths"]["/library/sections/{sectionKey}/refresh"]["get"]
|
- target: $["paths"]["/library/sections/{sectionKey}/refresh"]["get"]
|
||||||
update:
|
update:
|
||||||
@@ -882,12 +950,7 @@ actions:
|
|||||||
label: items
|
label: items
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import {
|
import { GetLibraryItemsQueryParamType, Tag } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
GetLibraryItemsQueryParamIncludeMeta,
|
|
||||||
GetLibraryItemsQueryParamType,
|
|
||||||
IncludeGuids,
|
|
||||||
Tag,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
@@ -896,12 +959,8 @@ actions:
|
|||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.library.getLibraryItems({
|
const result = await plexAPI.library.getLibraryItems({
|
||||||
tag: Tag.Edition,
|
tag: Tag.Edition,
|
||||||
includeGuids: IncludeGuids.Enable,
|
|
||||||
type: GetLibraryItemsQueryParamType.TvShow,
|
type: GetLibraryItemsQueryParamType.TvShow,
|
||||||
sectionKey: 9518,
|
sectionKey: 9518,
|
||||||
includeMeta: GetLibraryItemsQueryParamIncludeMeta.Enable,
|
|
||||||
xPlexContainerStart: 0,
|
|
||||||
xPlexContainerSize: 50,
|
|
||||||
});
|
});
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
@@ -1210,7 +1269,7 @@ actions:
|
|||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.playlists.updatePlaylist(3915.00);
|
const result = await plexAPI.playlists.updatePlaylist(3915);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
@@ -1271,7 +1330,7 @@ actions:
|
|||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.playlists.addPlaylistContents(8502.00, "server://12345/com.plexapp.plugins.library/library/metadata/1", 123);
|
const result = await plexAPI.playlists.addPlaylistContents(8502.01, "server://12345/com.plexapp.plugins.library/library/metadata/1", 123);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
@@ -1285,14 +1344,13 @@ actions:
|
|||||||
label: resources
|
label: resources
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { IncludeHttps, IncludeIPv6, IncludeRelay } from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.plex.getServerResources("3381b62b-9ab7-4e37-827b-203e9809eb58", IncludeHttps.Enable, IncludeRelay.Enable, IncludeIPv6.Enable);
|
const result = await plexAPI.plex.getServerResources("3381b62b-9ab7-4e37-827b-203e9809eb58");
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
@@ -1601,6 +1659,38 @@ actions:
|
|||||||
console.log(result);
|
console.log(result);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
- target: $["paths"]["/users"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: typescript
|
||||||
|
label: users
|
||||||
|
source: |-
|
||||||
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
const plexAPI = new PlexAPI();
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await plexAPI.users.getUsers({
|
||||||
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
|
deviceName: "Chrome",
|
||||||
|
deviceScreenResolution: "1487x1165,2560x1440",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
clientFeatures: "external-media,indirect-media,hub-style-list",
|
||||||
|
model: "4200X",
|
||||||
|
xPlexSessionId: "97e136ef-4ddd-4ff3-89a7-a5820c96c2ca",
|
||||||
|
xPlexLanguage: "en",
|
||||||
|
platformVersion: "4.3 build 1057",
|
||||||
|
xPlexToken: "CV5xoxjTpFKUzBTShsaf",
|
||||||
|
});
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
run();
|
run();
|
||||||
- target: $["paths"]["/users/signin"]["post"]
|
- target: $["paths"]["/users/signin"]["post"]
|
||||||
update:
|
update:
|
||||||
|
|||||||
18
docs/sdk/models/errors/getactorslibrarybadrequest.md
Normal file
18
docs/sdk/models/errors/getactorslibrarybadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetActorsLibraryBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetActorsLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetActorsLibraryErrors](../../../sdk/models/errors/getactorslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetMetaDataByRatingKeyErrors
|
# GetActorsLibraryErrors
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetMetaDataByRatingKeyErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetActorsLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetMetaDataByRatingKeyErrors = {
|
let value: GetActorsLibraryErrors = {
|
||||||
code: 1000,
|
code: 1000,
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 400,
|
status: 400,
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetMetaDataByRatingKeyLibraryErrors
|
# GetActorsLibraryLibraryErrors
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetMetaDataByRatingKeyLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetActorsLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetMetaDataByRatingKeyLibraryErrors = {
|
let value: GetActorsLibraryLibraryErrors = {
|
||||||
code: 1001,
|
code: 1001,
|
||||||
message: "User could not be authenticated",
|
message: "User could not be authenticated",
|
||||||
status: 401,
|
status: 401,
|
||||||
18
docs/sdk/models/errors/getactorslibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getactorslibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetActorsLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetActorsLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetActorsLibraryLibraryErrors](../../../sdk/models/errors/getactorslibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
18
docs/sdk/models/errors/getcountrieslibrarybadrequest.md
Normal file
18
docs/sdk/models/errors/getcountrieslibrarybadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetCountriesLibraryBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetCountriesLibraryErrors](../../../sdk/models/errors/getcountrieslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
21
docs/sdk/models/errors/getcountrieslibraryerrors.md
Normal file
21
docs/sdk/models/errors/getcountrieslibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetCountriesLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetCountriesLibraryErrors = {
|
||||||
|
code: 1000,
|
||||||
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
|
status: 400,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/getcountrieslibrarylibraryerrors.md
Normal file
21
docs/sdk/models/errors/getcountrieslibrarylibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetCountriesLibraryLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetCountriesLibraryLibraryErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/getcountrieslibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getcountrieslibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetCountriesLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetCountriesLibraryLibraryErrors](../../../sdk/models/errors/getcountrieslibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
18
docs/sdk/models/errors/getgenreslibrarybadrequest.md
Normal file
18
docs/sdk/models/errors/getgenreslibrarybadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetGenresLibraryBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetGenresLibraryErrors](../../../sdk/models/errors/getgenreslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
21
docs/sdk/models/errors/getgenreslibraryerrors.md
Normal file
21
docs/sdk/models/errors/getgenreslibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetGenresLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetGenresLibraryErrors = {
|
||||||
|
code: 1000,
|
||||||
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
|
status: 400,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/getgenreslibrarylibraryerrors.md
Normal file
21
docs/sdk/models/errors/getgenreslibrarylibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetGenresLibraryLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetGenresLibraryLibraryErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/getgenreslibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getgenreslibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetGenresLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetGenresLibraryLibraryErrors](../../../sdk/models/errors/getgenreslibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
18
docs/sdk/models/errors/getmediametadatabadrequest.md
Normal file
18
docs/sdk/models/errors/getmediametadatabadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetMediaMetaDataBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetMediaMetaDataBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetMediaMetaDataErrors](../../../sdk/models/errors/getmediametadataerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
21
docs/sdk/models/errors/getmediametadataerrors.md
Normal file
21
docs/sdk/models/errors/getmediametadataerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetMediaMetaDataErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetMediaMetaDataErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetMediaMetaDataErrors = {
|
||||||
|
code: 1000,
|
||||||
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
|
status: 400,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/getmediametadatalibraryerrors.md
Normal file
21
docs/sdk/models/errors/getmediametadatalibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetMediaMetaDataLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetMediaMetaDataLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetMediaMetaDataLibraryErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/getmediametadataunauthorized.md
Normal file
18
docs/sdk/models/errors/getmediametadataunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetMediaMetaDataUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetMediaMetaDataUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetMediaMetaDataLibraryErrors](../../../sdk/models/errors/getmediametadatalibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# GetMetaDataByRatingKeyBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetMetaDataByRatingKeyBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetMetaDataByRatingKeyErrors](../../../sdk/models/errors/getmetadatabyratingkeyerrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# GetMetaDataByRatingKeyUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetMetaDataByRatingKeyUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetMetaDataByRatingKeyLibraryErrors](../../../sdk/models/errors/getmetadatabyratingkeylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
18
docs/sdk/models/errors/getusersbadrequest.md
Normal file
18
docs/sdk/models/errors/getusersbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetUsersBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetUsersBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetUsersErrors](../../../sdk/models/errors/getuserserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
21
docs/sdk/models/errors/getuserserrors.md
Normal file
21
docs/sdk/models/errors/getuserserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetUsersErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetUsersErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetUsersErrors = {
|
||||||
|
code: 1000,
|
||||||
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
|
status: 400,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
18
docs/sdk/models/errors/getusersunauthorized.md
Normal file
18
docs/sdk/models/errors/getusersunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetUsersUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetUsersUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetUsersUsersErrors](../../../sdk/models/errors/getusersuserserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
21
docs/sdk/models/errors/getusersuserserrors.md
Normal file
21
docs/sdk/models/errors/getusersuserserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetUsersUsersErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetUsersUsersErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetUsersUsersErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -6,7 +6,7 @@
|
|||||||
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: AddPlaylistContentsRequest = {
|
let value: AddPlaylistContentsRequest = {
|
||||||
playlistID: 6289.82,
|
playlistID: 6874.88,
|
||||||
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
||||||
playQueueID: 123,
|
playQueueID: 123,
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { AddPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operat
|
|||||||
|
|
||||||
let value: AddPlaylistContentsResponse = {
|
let value: AddPlaylistContentsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 503,
|
statusCode: 226,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
18
docs/sdk/models/operations/alllibraries.md
Normal file
18
docs/sdk/models/operations/alllibraries.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# AllLibraries
|
||||||
|
|
||||||
|
Indicates if the user has access to all libraries.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AllLibraries } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: AllLibraries = AllLibraries.Enable;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
18
docs/sdk/models/operations/allowcameraupload.md
Normal file
18
docs/sdk/models/operations/allowcameraupload.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# AllowCameraUpload
|
||||||
|
|
||||||
|
Indicates if the user is allowed to upload from a camera.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AllowCameraUpload } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: AllowCameraUpload = AllowCameraUpload.Enable;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
18
docs/sdk/models/operations/allowchannels.md
Normal file
18
docs/sdk/models/operations/allowchannels.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# AllowChannels
|
||||||
|
|
||||||
|
Indicates if the user has access to channels.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AllowChannels } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: AllowChannels = AllowChannels.Enable;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
18
docs/sdk/models/operations/allowsubtitleadmin.md
Normal file
18
docs/sdk/models/operations/allowsubtitleadmin.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# AllowSubtitleAdmin
|
||||||
|
|
||||||
|
Indicates if the user can manage subtitles.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AllowSubtitleAdmin } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: AllowSubtitleAdmin = AllowSubtitleAdmin.Enable;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
18
docs/sdk/models/operations/allowsync.md
Normal file
18
docs/sdk/models/operations/allowsync.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# AllowSync
|
||||||
|
|
||||||
|
Indicates if the user is allowed to sync media.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AllowSync } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: AllowSync = AllowSync.Enable;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
18
docs/sdk/models/operations/allowtuners.md
Normal file
18
docs/sdk/models/operations/allowtuners.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# AllowTuners
|
||||||
|
|
||||||
|
Indicates if the user is allowed to use tuners.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AllowTuners } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: AllowTuners = AllowTuners.Enable;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
@@ -7,7 +7,7 @@ import { ApplyUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: ApplyUpdatesResponse = {
|
let value: ApplyUpdatesResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 103,
|
statusCode: 101,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { Billing } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: Billing = {
|
let value: Billing = {
|
||||||
internalPaymentMethod: {},
|
internalPaymentMethod: {},
|
||||||
paymentMethodId: 374170,
|
paymentMethodId: 517379,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { CheckForUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations
|
|||||||
|
|
||||||
let value: CheckForUpdatesResponse = {
|
let value: CheckForUpdatesResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 201,
|
statusCode: 205,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: ClearPlaylistContentsRequest = {
|
let value: ClearPlaylistContentsRequest = {
|
||||||
playlistID: 3834.64,
|
playlistID: 7980.47,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { ClearPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/oper
|
|||||||
|
|
||||||
let value: ClearPlaylistContentsResponse = {
|
let value: ClearPlaylistContentsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 307,
|
statusCode: 103,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,9 +7,9 @@ import { CreatePlaylistQueryParamType, CreatePlaylistRequest, Smart } from "@luk
|
|||||||
|
|
||||||
let value: CreatePlaylistRequest = {
|
let value: CreatePlaylistRequest = {
|
||||||
title: "<value>",
|
title: "<value>",
|
||||||
type: CreatePlaylistQueryParamType.Photo,
|
type: CreatePlaylistQueryParamType.Video,
|
||||||
smart: Smart.One,
|
smart: Smart.Zero,
|
||||||
uri: "https://enchanted-disclosure.com/",
|
uri: "https://humble-confusion.com",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { CreatePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
|||||||
|
|
||||||
let value: CreatePlaylistResponse = {
|
let value: CreatePlaylistResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 302,
|
statusCode: 102,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: DeletePlaylistRequest = {
|
let value: DeletePlaylistRequest = {
|
||||||
playlistID: 5365.79,
|
playlistID: 206.51,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { DeletePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
|||||||
|
|
||||||
let value: DeletePlaylistResponse = {
|
let value: DeletePlaylistResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 511,
|
statusCode: 409,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
19
docs/sdk/models/operations/enablecreditsmarkergeneration.md
Normal file
19
docs/sdk/models/operations/enablecreditsmarkergeneration.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# EnableCreditsMarkerGeneration
|
||||||
|
|
||||||
|
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { EnableCreditsMarkerGeneration } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: EnableCreditsMarkerGeneration =
|
||||||
|
EnableCreditsMarkerGeneration.LibraryDefault;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------- | ---------------- |
|
||||||
|
| `LibraryDefault` | -1 |
|
||||||
|
| `Disabled` | 0 |
|
||||||
@@ -7,7 +7,7 @@ import { EnablePaperTrailResponse } from "@lukehagar/plexjs/sdk/models/operation
|
|||||||
|
|
||||||
let value: EnablePaperTrailResponse = {
|
let value: EnablePaperTrailResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 203,
|
statusCode: 302,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
19
docs/sdk/models/operations/episodesort.md
Normal file
19
docs/sdk/models/operations/episodesort.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# EpisodeSort
|
||||||
|
|
||||||
|
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { EpisodeSort } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: EpisodeSort = EpisodeSort.OldestFirst;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------- | ---------------- |
|
||||||
|
| `LibraryDefault` | -1 |
|
||||||
|
| `OldestFirst` | 0 |
|
||||||
|
| `NewestFirst` | 1 |
|
||||||
@@ -1,16 +1,19 @@
|
|||||||
# FlattenSeasons
|
# FlattenSeasons
|
||||||
|
|
||||||
|
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { FlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
|
import { FlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: FlattenSeasons = FlattenSeasons.True;
|
let value: FlattenSeasons = FlattenSeasons.Show;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| ------- | ------- |
|
| ---------------- | ---------------- |
|
||||||
| `False` | 0 |
|
| `LibraryDefault` | -1 |
|
||||||
| `True` | 1 |
|
| `Hide` | 0 |
|
||||||
|
| `Show` | 1 |
|
||||||
@@ -10,13 +10,8 @@ let value: Friend = {
|
|||||||
friendlyName: "exampleUser",
|
friendlyName: "exampleUser",
|
||||||
home: true,
|
home: true,
|
||||||
id: 0,
|
id: 0,
|
||||||
restricted: false,
|
sharedServers: [],
|
||||||
sharedServers: [
|
sharedSources: [],
|
||||||
{},
|
|
||||||
],
|
|
||||||
sharedSources: [
|
|
||||||
{},
|
|
||||||
],
|
|
||||||
status: Status.Accepted,
|
status: Status.Accepted,
|
||||||
thumb: "https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578",
|
thumb: "https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578",
|
||||||
title: "username123",
|
title: "username123",
|
||||||
|
|||||||
@@ -12,11 +12,8 @@ let value: GeoData = {
|
|||||||
continentCode: "NA",
|
continentCode: "NA",
|
||||||
country: "United States Virgin Islands",
|
country: "United States Virgin Islands",
|
||||||
city: "Amsterdam",
|
city: "Amsterdam",
|
||||||
europeanUnionMember: true,
|
|
||||||
timeZone: "America/St_Thomas",
|
timeZone: "America/St_Thomas",
|
||||||
postalCode: "802",
|
postalCode: "802",
|
||||||
inPrivacyRestrictedCountry: true,
|
|
||||||
inPrivacyRestrictedRegion: true,
|
|
||||||
subdivisions: "Saint Thomas",
|
subdivisions: "Saint Thomas",
|
||||||
coordinates: "18.3381, -64.8941",
|
coordinates: "18.3381, -64.8941",
|
||||||
};
|
};
|
||||||
|
|||||||
24
docs/sdk/models/operations/getactorslibrarydirectory.md
Normal file
24
docs/sdk/models/operations/getactorslibrarydirectory.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# GetActorsLibraryDirectory
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetActorsLibraryDirectory } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetActorsLibraryDirectory = {
|
||||||
|
fastKey: "/library/sections/2/all?actor=134671",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
|
||||||
|
key: "134671",
|
||||||
|
title: "Aaron Paul",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
|
| `fastKey` | *string* | :heavy_check_mark: | A fast lookup key for the actor relative url. | /library/sections/2/all?actor=134671 |
|
||||||
|
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the actor. | https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | A unique key representing the actor. | 134671 |
|
||||||
|
| `title` | *string* | :heavy_check_mark: | The name of the actor. | Aaron Paul |
|
||||||
49
docs/sdk/models/operations/getactorslibrarymediacontainer.md
Normal file
49
docs/sdk/models/operations/getactorslibrarymediacontainer.md
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
# GetActorsLibraryMediaContainer
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetActorsLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetActorsLibraryMediaContainer = {
|
||||||
|
size: 50,
|
||||||
|
allowSync: false,
|
||||||
|
art: "/:/resources/show-fanart.jpg",
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
|
mediaTagVersion: 1734362201,
|
||||||
|
nocache: true,
|
||||||
|
thumb: "/:/resources/show.png",
|
||||||
|
title1: "TV Series",
|
||||||
|
title2: "By Starring Actor",
|
||||||
|
viewGroup: "secondary",
|
||||||
|
viewMode: "131131",
|
||||||
|
directory: [
|
||||||
|
{
|
||||||
|
fastKey: "/library/sections/2/all?actor=134671",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
|
||||||
|
key: "134671",
|
||||||
|
title: "Aaron Paul",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
|
||||||
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
|
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
|
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
|
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
|
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
|
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||||
|
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
|
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
|
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||||
|
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||||
|
| `viewMode` | *string* | :heavy_check_mark: | Identifier for the view mode. | 131131 |
|
||||||
|
| `directory` | [operations.GetActorsLibraryDirectory](../../../sdk/models/operations/getactorslibrarydirectory.md)[] | :heavy_minus_sign: | An array of actor entries for media items. | |
|
||||||
30
docs/sdk/models/operations/getactorslibraryqueryparamtype.md
Normal file
30
docs/sdk/models/operations/getactorslibraryqueryparamtype.md
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
# GetActorsLibraryQueryParamType
|
||||||
|
|
||||||
|
The type of media to retrieve or filter by.
|
||||||
|
1 = movie
|
||||||
|
2 = show
|
||||||
|
3 = season
|
||||||
|
4 = episode
|
||||||
|
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||||
|
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetActorsLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetActorsLibraryQueryParamType =
|
||||||
|
GetActorsLibraryQueryParamType.TvShow;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Movie` | 1 |
|
||||||
|
| `TvShow` | 2 |
|
||||||
|
| `Season` | 3 |
|
||||||
|
| `Episode` | 4 |
|
||||||
|
| `Audio` | 8 |
|
||||||
|
| `Album` | 9 |
|
||||||
|
| `Track` | 10 |
|
||||||
19
docs/sdk/models/operations/getactorslibraryrequest.md
Normal file
19
docs/sdk/models/operations/getactorslibraryrequest.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# GetActorsLibraryRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetActorsLibraryQueryParamType, GetActorsLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetActorsLibraryRequest = {
|
||||||
|
sectionKey: 9518,
|
||||||
|
type: GetActorsLibraryQueryParamType.TvShow,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
|
| `type` | [operations.GetActorsLibraryQueryParamType](../../../sdk/models/operations/getactorslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||||
49
docs/sdk/models/operations/getactorslibraryresponse.md
Normal file
49
docs/sdk/models/operations/getactorslibraryresponse.md
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
# GetActorsLibraryResponse
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetActorsLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetActorsLibraryResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 413,
|
||||||
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
}),
|
||||||
|
object: {
|
||||||
|
mediaContainer: {
|
||||||
|
size: 50,
|
||||||
|
allowSync: false,
|
||||||
|
art: "/:/resources/show-fanart.jpg",
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
|
mediaTagVersion: 1734362201,
|
||||||
|
nocache: true,
|
||||||
|
thumb: "/:/resources/show.png",
|
||||||
|
title1: "TV Series",
|
||||||
|
title2: "By Starring Actor",
|
||||||
|
viewGroup: "secondary",
|
||||||
|
viewMode: "131131",
|
||||||
|
directory: [
|
||||||
|
{
|
||||||
|
fastKey: "/library/sections/2/all?actor=134671",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
|
||||||
|
key: "134671",
|
||||||
|
title: "Aaron Paul",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [operations.GetActorsLibraryResponseBody](../../../sdk/models/operations/getactorslibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||||
41
docs/sdk/models/operations/getactorslibraryresponsebody.md
Normal file
41
docs/sdk/models/operations/getactorslibraryresponsebody.md
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
# GetActorsLibraryResponseBody
|
||||||
|
|
||||||
|
Successful response containing media container data.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetActorsLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetActorsLibraryResponseBody = {
|
||||||
|
mediaContainer: {
|
||||||
|
size: 50,
|
||||||
|
allowSync: false,
|
||||||
|
art: "/:/resources/show-fanart.jpg",
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
|
mediaTagVersion: 1734362201,
|
||||||
|
nocache: true,
|
||||||
|
thumb: "/:/resources/show.png",
|
||||||
|
title1: "TV Series",
|
||||||
|
title2: "By Starring Actor",
|
||||||
|
viewGroup: "secondary",
|
||||||
|
viewMode: "131131",
|
||||||
|
directory: [
|
||||||
|
{
|
||||||
|
fastKey: "/library/sections/2/all?actor=134671",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
|
||||||
|
key: "134671",
|
||||||
|
title: "Aaron Paul",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `mediaContainer` | [operations.GetActorsLibraryMediaContainer](../../../sdk/models/operations/getactorslibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -7,7 +7,7 @@ import { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs/sdk/models/ope
|
|||||||
|
|
||||||
let value: GetBandwidthStatisticsResponse = {
|
let value: GetBandwidthStatisticsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 101,
|
statusCode: 500,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
21
docs/sdk/models/operations/getcountrieslibrarydirectory.md
Normal file
21
docs/sdk/models/operations/getcountrieslibrarydirectory.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetCountriesLibraryDirectory
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryDirectory } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetCountriesLibraryDirectory = {
|
||||||
|
fastKey: "/library/sections/2/all?country=15491",
|
||||||
|
key: "15491",
|
||||||
|
title: "Japan",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
|
||||||
|
| `fastKey` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?country=15491 |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | N/A | 15491 |
|
||||||
|
| `title` | *string* | :heavy_check_mark: | N/A | Japan |
|
||||||
@@ -1,55 +1,28 @@
|
|||||||
# GetMetaDataByRatingKeyPart
|
# GetCountriesLibraryMediaContainer
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetMetaDataByRatingKeyPart } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetCountriesLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetMetaDataByRatingKeyPart = {
|
let value: GetCountriesLibraryMediaContainer = {
|
||||||
id: 15,
|
size: 50,
|
||||||
key: "/library/parts/15/1705637151/file.mp4",
|
identifier: "com.plexapp.plugins.library",
|
||||||
duration: 141417,
|
allowSync: false,
|
||||||
file: "/movies/Serenity (2005)/Serenity (2005).mp4",
|
art: "/:/resources/show-fanart.jpg",
|
||||||
size: 40271948,
|
content: "secondary",
|
||||||
audioProfile: "lc",
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
container: "mp4",
|
mediaTagVersion: 1734362201,
|
||||||
has64bitOffsets: false,
|
nocache: true,
|
||||||
optimizedForStreaming: false,
|
thumb: "/:/resources/show.png",
|
||||||
videoProfile: "high",
|
title1: "TV Series",
|
||||||
stream: [
|
title2: "By Country",
|
||||||
|
viewGroup: "secondary",
|
||||||
|
directory: [
|
||||||
{
|
{
|
||||||
id: 29,
|
fastKey: "/library/sections/2/all?country=15491",
|
||||||
streamType: 2,
|
key: "15491",
|
||||||
default: true,
|
title: "Japan",
|
||||||
codec: "aac",
|
|
||||||
index: 0,
|
|
||||||
bitrate: 128,
|
|
||||||
bitDepth: 8,
|
|
||||||
chromaLocation: "left",
|
|
||||||
chromaSubsampling: "14520",
|
|
||||||
codedHeight: 816,
|
|
||||||
codedWidth: 1920,
|
|
||||||
colorPrimaries: "bt709",
|
|
||||||
colorRange: "tv",
|
|
||||||
colorSpace: "bt709",
|
|
||||||
colorTrc: "bt709",
|
|
||||||
frameRate: 24,
|
|
||||||
hasScalingMatrix: false,
|
|
||||||
height: 814,
|
|
||||||
level: 40,
|
|
||||||
profile: "lc",
|
|
||||||
refFrames: 4,
|
|
||||||
scanType: "progressive",
|
|
||||||
streamIdentifier: "1",
|
|
||||||
width: 1920,
|
|
||||||
displayTitle: "English (AAC Stereo)",
|
|
||||||
extendedDisplayTitle: "English (AAC Stereo)",
|
|
||||||
selected: true,
|
|
||||||
channels: 2,
|
|
||||||
language: "English",
|
|
||||||
languageTag: "en",
|
|
||||||
languageCode: "eng",
|
|
||||||
samplingRate: 44100,
|
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
};
|
};
|
||||||
@@ -59,14 +32,18 @@ let value: GetMetaDataByRatingKeyPart = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *number* | :heavy_minus_sign: | N/A | 15 |
|
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
|
||||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 |
|
| `offset` | *number* | :heavy_minus_sign: | N/A | |
|
||||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 141417 |
|
| `totalSize` | *number* | :heavy_minus_sign: | N/A | |
|
||||||
| `file` | *string* | :heavy_minus_sign: | N/A | /movies/Serenity (2005)/Serenity (2005).mp4 |
|
| `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
||||||
| `size` | *number* | :heavy_minus_sign: | N/A | 40271948 |
|
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
|
||||||
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
|
| `content` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
| `mediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
||||||
| `optimizedForStreaming` | *boolean* | :heavy_minus_sign: | N/A | false |
|
| `mediaTagVersion` | *number* | :heavy_check_mark: | N/A | 1734362201 |
|
||||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
|
| `nocache` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||||
| `stream` | [operations.GetMetaDataByRatingKeyStream](../../../sdk/models/operations/getmetadatabyratingkeystream.md)[] | :heavy_minus_sign: | N/A | |
|
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/show.png |
|
||||||
|
| `title1` | *string* | :heavy_check_mark: | N/A | TV Series |
|
||||||
|
| `title2` | *string* | :heavy_check_mark: | N/A | By Country |
|
||||||
|
| `viewGroup` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||||
|
| `directory` | [operations.GetCountriesLibraryDirectory](../../../sdk/models/operations/getcountrieslibrarydirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
# GetCountriesLibraryQueryParamType
|
||||||
|
|
||||||
|
The type of media to retrieve or filter by.
|
||||||
|
1 = movie
|
||||||
|
2 = show
|
||||||
|
3 = season
|
||||||
|
4 = episode
|
||||||
|
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||||
|
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetCountriesLibraryQueryParamType =
|
||||||
|
GetCountriesLibraryQueryParamType.TvShow;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Movie` | 1 |
|
||||||
|
| `TvShow` | 2 |
|
||||||
|
| `Season` | 3 |
|
||||||
|
| `Episode` | 4 |
|
||||||
|
| `Audio` | 8 |
|
||||||
|
| `Album` | 9 |
|
||||||
|
| `Track` | 10 |
|
||||||
19
docs/sdk/models/operations/getcountrieslibraryrequest.md
Normal file
19
docs/sdk/models/operations/getcountrieslibraryrequest.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# GetCountriesLibraryRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryQueryParamType, GetCountriesLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetCountriesLibraryRequest = {
|
||||||
|
sectionKey: 9518,
|
||||||
|
type: GetCountriesLibraryQueryParamType.TvShow,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
|
| `type` | [operations.GetCountriesLibraryQueryParamType](../../../sdk/models/operations/getcountrieslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||||
47
docs/sdk/models/operations/getcountrieslibraryresponse.md
Normal file
47
docs/sdk/models/operations/getcountrieslibraryresponse.md
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
# GetCountriesLibraryResponse
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetCountriesLibraryResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 300,
|
||||||
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
}),
|
||||||
|
object: {
|
||||||
|
mediaContainer: {
|
||||||
|
size: 50,
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
allowSync: false,
|
||||||
|
art: "/:/resources/show-fanart.jpg",
|
||||||
|
content: "secondary",
|
||||||
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
|
mediaTagVersion: 1734362201,
|
||||||
|
nocache: true,
|
||||||
|
thumb: "/:/resources/show.png",
|
||||||
|
title1: "TV Series",
|
||||||
|
title2: "By Country",
|
||||||
|
viewGroup: "secondary",
|
||||||
|
directory: [
|
||||||
|
{
|
||||||
|
fastKey: "/library/sections/2/all?country=15491",
|
||||||
|
key: "15491",
|
||||||
|
title: "Japan",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [operations.GetCountriesLibraryResponseBody](../../../sdk/models/operations/getcountrieslibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
# GetCountriesLibraryResponseBody
|
||||||
|
|
||||||
|
Successful response containing media container data.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetCountriesLibraryResponseBody = {
|
||||||
|
mediaContainer: {
|
||||||
|
size: 50,
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
allowSync: false,
|
||||||
|
art: "/:/resources/show-fanart.jpg",
|
||||||
|
content: "secondary",
|
||||||
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
|
mediaTagVersion: 1734362201,
|
||||||
|
nocache: true,
|
||||||
|
thumb: "/:/resources/show.png",
|
||||||
|
title1: "TV Series",
|
||||||
|
title2: "By Country",
|
||||||
|
viewGroup: "secondary",
|
||||||
|
directory: [
|
||||||
|
{
|
||||||
|
fastKey: "/library/sections/2/all?country=15491",
|
||||||
|
key: "15491",
|
||||||
|
title: "Japan",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `mediaContainer` | [operations.GetCountriesLibraryMediaContainer](../../../sdk/models/operations/getcountrieslibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
23
docs/sdk/models/operations/getgenreslibrarydirectory.md
Normal file
23
docs/sdk/models/operations/getgenreslibrarydirectory.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# GetGenresLibraryDirectory
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryDirectory } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetGenresLibraryDirectory = {
|
||||||
|
fastKey: "/library/sections/10/all?genre=89",
|
||||||
|
key: "89",
|
||||||
|
title: "Action",
|
||||||
|
type: "genre",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
|
||||||
|
| `fastKey` | *string* | :heavy_check_mark: | N/A | /library/sections/10/all?genre=89 |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | N/A | 89 |
|
||||||
|
| `title` | *string* | :heavy_check_mark: | N/A | Action |
|
||||||
|
| `type` | *string* | :heavy_check_mark: | N/A | genre |
|
||||||
50
docs/sdk/models/operations/getgenreslibrarymediacontainer.md
Normal file
50
docs/sdk/models/operations/getgenreslibrarymediacontainer.md
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
# GetGenresLibraryMediaContainer
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetGenresLibraryMediaContainer = {
|
||||||
|
size: 50,
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
allowSync: false,
|
||||||
|
art: "/:/resources/show-fanart.jpg",
|
||||||
|
content: "secondary",
|
||||||
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
|
mediaTagVersion: 1734362201,
|
||||||
|
nocache: true,
|
||||||
|
thumb: "/:/resources/show.png",
|
||||||
|
title1: "TV Shows (Reality)",
|
||||||
|
title2: "By Genre",
|
||||||
|
viewGroup: "secondary",
|
||||||
|
directory: [
|
||||||
|
{
|
||||||
|
fastKey: "/library/sections/10/all?genre=89",
|
||||||
|
key: "89",
|
||||||
|
title: "Action",
|
||||||
|
type: "genre",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
|
||||||
|
| `offset` | *number* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `totalSize` | *number* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
||||||
|
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||||
|
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
|
||||||
|
| `content` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||||
|
| `mediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
||||||
|
| `mediaTagVersion` | *number* | :heavy_check_mark: | N/A | 1734362201 |
|
||||||
|
| `nocache` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||||
|
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/show.png |
|
||||||
|
| `title1` | *string* | :heavy_check_mark: | N/A | TV Shows (Reality) |
|
||||||
|
| `title2` | *string* | :heavy_check_mark: | N/A | By Genre |
|
||||||
|
| `viewGroup` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||||
|
| `directory` | [operations.GetGenresLibraryDirectory](../../../sdk/models/operations/getgenreslibrarydirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
30
docs/sdk/models/operations/getgenreslibraryqueryparamtype.md
Normal file
30
docs/sdk/models/operations/getgenreslibraryqueryparamtype.md
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
# GetGenresLibraryQueryParamType
|
||||||
|
|
||||||
|
The type of media to retrieve or filter by.
|
||||||
|
1 = movie
|
||||||
|
2 = show
|
||||||
|
3 = season
|
||||||
|
4 = episode
|
||||||
|
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||||
|
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetGenresLibraryQueryParamType =
|
||||||
|
GetGenresLibraryQueryParamType.TvShow;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Movie` | 1 |
|
||||||
|
| `TvShow` | 2 |
|
||||||
|
| `Season` | 3 |
|
||||||
|
| `Episode` | 4 |
|
||||||
|
| `Audio` | 8 |
|
||||||
|
| `Album` | 9 |
|
||||||
|
| `Track` | 10 |
|
||||||
19
docs/sdk/models/operations/getgenreslibraryrequest.md
Normal file
19
docs/sdk/models/operations/getgenreslibraryrequest.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# GetGenresLibraryRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryQueryParamType, GetGenresLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetGenresLibraryRequest = {
|
||||||
|
sectionKey: 9518,
|
||||||
|
type: GetGenresLibraryQueryParamType.TvShow,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
|
| `type` | [operations.GetGenresLibraryQueryParamType](../../../sdk/models/operations/getgenreslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||||
48
docs/sdk/models/operations/getgenreslibraryresponse.md
Normal file
48
docs/sdk/models/operations/getgenreslibraryresponse.md
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
# GetGenresLibraryResponse
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetGenresLibraryResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 506,
|
||||||
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
}),
|
||||||
|
object: {
|
||||||
|
mediaContainer: {
|
||||||
|
size: 50,
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
allowSync: false,
|
||||||
|
art: "/:/resources/show-fanart.jpg",
|
||||||
|
content: "secondary",
|
||||||
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
|
mediaTagVersion: 1734362201,
|
||||||
|
nocache: true,
|
||||||
|
thumb: "/:/resources/show.png",
|
||||||
|
title1: "TV Shows (Reality)",
|
||||||
|
title2: "By Genre",
|
||||||
|
viewGroup: "secondary",
|
||||||
|
directory: [
|
||||||
|
{
|
||||||
|
fastKey: "/library/sections/10/all?genre=89",
|
||||||
|
key: "89",
|
||||||
|
title: "Action",
|
||||||
|
type: "genre",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [operations.GetGenresLibraryResponseBody](../../../sdk/models/operations/getgenreslibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||||
40
docs/sdk/models/operations/getgenreslibraryresponsebody.md
Normal file
40
docs/sdk/models/operations/getgenreslibraryresponsebody.md
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
# GetGenresLibraryResponseBody
|
||||||
|
|
||||||
|
Successful response containing media container data.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetGenresLibraryResponseBody = {
|
||||||
|
mediaContainer: {
|
||||||
|
size: 50,
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
allowSync: false,
|
||||||
|
art: "/:/resources/show-fanart.jpg",
|
||||||
|
content: "secondary",
|
||||||
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
|
mediaTagVersion: 1734362201,
|
||||||
|
nocache: true,
|
||||||
|
thumb: "/:/resources/show.png",
|
||||||
|
title1: "TV Shows (Reality)",
|
||||||
|
title2: "By Genre",
|
||||||
|
viewGroup: "secondary",
|
||||||
|
directory: [
|
||||||
|
{
|
||||||
|
fastKey: "/library/sections/10/all?genre=89",
|
||||||
|
key: "89",
|
||||||
|
title: "Action",
|
||||||
|
type: "genre",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `mediaContainer` | [operations.GetGenresLibraryMediaContainer](../../../sdk/models/operations/getgenreslibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -12,11 +12,8 @@ let value: GetGeoDataGeoData = {
|
|||||||
continentCode: "NA",
|
continentCode: "NA",
|
||||||
country: "United States Virgin Islands",
|
country: "United States Virgin Islands",
|
||||||
city: "Amsterdam",
|
city: "Amsterdam",
|
||||||
europeanUnionMember: true,
|
|
||||||
timeZone: "America/St_Thomas",
|
timeZone: "America/St_Thomas",
|
||||||
postalCode: "802",
|
postalCode: "802",
|
||||||
inPrivacyRestrictedCountry: true,
|
|
||||||
inPrivacyRestrictedRegion: true,
|
|
||||||
subdivisions: "Saint Thomas",
|
subdivisions: "Saint Thomas",
|
||||||
coordinates: "18.3381, -64.8941",
|
coordinates: "18.3381, -64.8941",
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -16,11 +16,8 @@ let value: GetGeoDataResponse = {
|
|||||||
continentCode: "NA",
|
continentCode: "NA",
|
||||||
country: "United States Virgin Islands",
|
country: "United States Virgin Islands",
|
||||||
city: "Amsterdam",
|
city: "Amsterdam",
|
||||||
europeanUnionMember: true,
|
|
||||||
timeZone: "America/St_Thomas",
|
timeZone: "America/St_Thomas",
|
||||||
postalCode: "802",
|
postalCode: "802",
|
||||||
inPrivacyRestrictedCountry: true,
|
|
||||||
inPrivacyRestrictedRegion: true,
|
|
||||||
subdivisions: "Saint Thomas",
|
subdivisions: "Saint Thomas",
|
||||||
coordinates: "18.3381, -64.8941",
|
coordinates: "18.3381, -64.8941",
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -0,0 +1,19 @@
|
|||||||
|
# GetLibraryItemsEnableCreditsMarkerGeneration
|
||||||
|
|
||||||
|
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsEnableCreditsMarkerGeneration } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsEnableCreditsMarkerGeneration =
|
||||||
|
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------- | ---------------- |
|
||||||
|
| `LibraryDefault` | -1 |
|
||||||
|
| `Disabled` | 0 |
|
||||||
19
docs/sdk/models/operations/getlibraryitemsepisodesort.md
Normal file
19
docs/sdk/models/operations/getlibraryitemsepisodesort.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# GetLibraryItemsEpisodeSort
|
||||||
|
|
||||||
|
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsEpisodeSort } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsEpisodeSort = GetLibraryItemsEpisodeSort.OldestFirst;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------- | ---------------- |
|
||||||
|
| `LibraryDefault` | -1 |
|
||||||
|
| `OldestFirst` | 0 |
|
||||||
|
| `NewestFirst` | 1 |
|
||||||
@@ -1,16 +1,19 @@
|
|||||||
# GetLibraryItemsFlattenSeasons
|
# GetLibraryItemsFlattenSeasons
|
||||||
|
|
||||||
|
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsFlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsFlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsFlattenSeasons = GetLibraryItemsFlattenSeasons.True;
|
let value: GetLibraryItemsFlattenSeasons = GetLibraryItemsFlattenSeasons.Show;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| ------- | ------- |
|
| ---------------- | ---------------- |
|
||||||
| `False` | 0 |
|
| `LibraryDefault` | -1 |
|
||||||
| `True` | 1 |
|
| `Hide` | 0 |
|
||||||
|
| `Show` | 1 |
|
||||||
@@ -3,11 +3,7 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import { GetLibraryItemsLibraryResponseType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
GetLibraryItemsLibraryActiveDirection,
|
|
||||||
GetLibraryItemsLibraryDefaultDirection,
|
|
||||||
GetLibraryItemsLibraryResponseType,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsLibraryResponseType = {
|
let value: GetLibraryItemsLibraryResponseType = {
|
||||||
key: "/library/sections/2/all?type=2",
|
key: "/library/sections/2/all?type=2",
|
||||||
@@ -27,8 +23,6 @@ let value: GetLibraryItemsLibraryResponseType = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
|
|
||||||
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
@@ -3,17 +3,11 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import { GetLibraryItemsLibrarySort } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
GetLibraryItemsLibraryActiveDirection,
|
|
||||||
GetLibraryItemsLibraryDefaultDirection,
|
|
||||||
GetLibraryItemsLibrarySort,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsLibrarySort = {
|
let value: GetLibraryItemsLibrarySort = {
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
|
|
||||||
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
@@ -3,11 +3,7 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import { GetLibraryItemsMedia } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
GetLibraryItemsHasThumbnail,
|
|
||||||
GetLibraryItemsMedia,
|
|
||||||
GetLibraryItemsOptimizedForStreaming,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsMedia = {
|
let value: GetLibraryItemsMedia = {
|
||||||
id: 119534,
|
id: 119534,
|
||||||
@@ -25,7 +21,6 @@ let value: GetLibraryItemsMedia = {
|
|||||||
videoFrameRate: "24p",
|
videoFrameRate: "24p",
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
hasVoiceActivity: false,
|
hasVoiceActivity: false,
|
||||||
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
|
||||||
has64bitOffsets: false,
|
has64bitOffsets: false,
|
||||||
part: [
|
part: [
|
||||||
{
|
{
|
||||||
@@ -41,7 +36,6 @@ let value: GetLibraryItemsMedia = {
|
|||||||
optimizedForStreaming: false,
|
optimizedForStreaming: false,
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
indexes: "sd",
|
indexes: "sd",
|
||||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
|
||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 272796,
|
id: 272796,
|
||||||
|
|||||||
@@ -7,16 +7,12 @@ The Meta object is only included in the response if the `includeMeta` parameter
|
|||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import {
|
||||||
GetLibraryItemsActiveDirection,
|
GetLibraryItemsEnableCreditsMarkerGeneration,
|
||||||
GetLibraryItemsDefaultDirection,
|
GetLibraryItemsEpisodeSort,
|
||||||
GetLibraryItemsFlattenSeasons,
|
GetLibraryItemsFlattenSeasons,
|
||||||
GetLibraryItemsHasThumbnail,
|
|
||||||
GetLibraryItemsLibraryActiveDirection,
|
|
||||||
GetLibraryItemsLibraryDefaultDirection,
|
|
||||||
GetLibraryItemsLibraryResponse200Type,
|
GetLibraryItemsLibraryResponse200Type,
|
||||||
GetLibraryItemsLibraryType,
|
GetLibraryItemsLibraryType,
|
||||||
GetLibraryItemsMediaContainer,
|
GetLibraryItemsMediaContainer,
|
||||||
GetLibraryItemsOptimizedForStreaming,
|
|
||||||
GetLibraryItemsShowOrdering,
|
GetLibraryItemsShowOrdering,
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||||
@@ -41,8 +37,6 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsActiveDirection.Ascending,
|
|
||||||
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
@@ -110,8 +104,11 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
year: 2022,
|
year: 2022,
|
||||||
seasonCount: 2022,
|
seasonCount: 2022,
|
||||||
tagline: "Return to Pandora.",
|
tagline: "Return to Pandora.",
|
||||||
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
|
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
|
||||||
showOrdering: GetLibraryItemsShowOrdering.TvdbDvd,
|
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
|
||||||
|
enableCreditsMarkerGeneration:
|
||||||
|
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
|
||||||
|
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
|
||||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||||
art: "/library/metadata/58683/art/1703239236",
|
art: "/library/metadata/58683/art/1703239236",
|
||||||
banner: "/library/metadata/58683/banner/1703239236",
|
banner: "/library/metadata/58683/banner/1703239236",
|
||||||
@@ -149,7 +146,6 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
videoFrameRate: "24p",
|
videoFrameRate: "24p",
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
hasVoiceActivity: false,
|
hasVoiceActivity: false,
|
||||||
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
|
||||||
has64bitOffsets: false,
|
has64bitOffsets: false,
|
||||||
part: [
|
part: [
|
||||||
{
|
{
|
||||||
@@ -165,7 +161,6 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
optimizedForStreaming: false,
|
optimizedForStreaming: false,
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
indexes: "sd",
|
indexes: "sd",
|
||||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
|
||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 272796,
|
id: 272796,
|
||||||
@@ -322,8 +317,6 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
|
|
||||||
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
@@ -6,11 +6,7 @@ The Meta object is only included in the response if the `includeMeta` parameter
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import { GetLibraryItemsMeta } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
GetLibraryItemsLibraryActiveDirection,
|
|
||||||
GetLibraryItemsLibraryDefaultDirection,
|
|
||||||
GetLibraryItemsMeta,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsMeta = {
|
let value: GetLibraryItemsMeta = {
|
||||||
type: [
|
type: [
|
||||||
@@ -32,8 +28,6 @@ let value: GetLibraryItemsMeta = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
|
|
||||||
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
@@ -4,12 +4,12 @@
|
|||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import {
|
||||||
|
GetLibraryItemsEnableCreditsMarkerGeneration,
|
||||||
|
GetLibraryItemsEpisodeSort,
|
||||||
GetLibraryItemsFlattenSeasons,
|
GetLibraryItemsFlattenSeasons,
|
||||||
GetLibraryItemsHasThumbnail,
|
|
||||||
GetLibraryItemsLibraryResponse200Type,
|
GetLibraryItemsLibraryResponse200Type,
|
||||||
GetLibraryItemsLibraryType,
|
GetLibraryItemsLibraryType,
|
||||||
GetLibraryItemsMetadata,
|
GetLibraryItemsMetadata,
|
||||||
GetLibraryItemsOptimizedForStreaming,
|
|
||||||
GetLibraryItemsShowOrdering,
|
GetLibraryItemsShowOrdering,
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||||
@@ -34,8 +34,11 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
year: 2022,
|
year: 2022,
|
||||||
seasonCount: 2022,
|
seasonCount: 2022,
|
||||||
tagline: "Return to Pandora.",
|
tagline: "Return to Pandora.",
|
||||||
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
|
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
|
||||||
showOrdering: GetLibraryItemsShowOrdering.TvdbDvd,
|
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
|
||||||
|
enableCreditsMarkerGeneration:
|
||||||
|
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
|
||||||
|
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
|
||||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||||
art: "/library/metadata/58683/art/1703239236",
|
art: "/library/metadata/58683/art/1703239236",
|
||||||
banner: "/library/metadata/58683/banner/1703239236",
|
banner: "/library/metadata/58683/banner/1703239236",
|
||||||
@@ -73,7 +76,6 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
videoFrameRate: "24p",
|
videoFrameRate: "24p",
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
hasVoiceActivity: false,
|
hasVoiceActivity: false,
|
||||||
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
|
||||||
has64bitOffsets: false,
|
has64bitOffsets: false,
|
||||||
part: [
|
part: [
|
||||||
{
|
{
|
||||||
@@ -89,7 +91,6 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
optimizedForStreaming: false,
|
optimizedForStreaming: false,
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
indexes: "sd",
|
indexes: "sd",
|
||||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
|
||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 272796,
|
id: 272796,
|
||||||
@@ -249,8 +250,10 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
| `year` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
| `year` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
||||||
| `seasonCount` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
| `seasonCount` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
||||||
| `tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
| `tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||||
| `flattenSeasons` | [operations.GetLibraryItemsFlattenSeasons](../../../sdk/models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
|
| `flattenSeasons` | [operations.GetLibraryItemsFlattenSeasons](../../../sdk/models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
|
||||||
| `showOrdering` | [operations.GetLibraryItemsShowOrdering](../../../sdk/models/operations/getlibraryitemsshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>tvdbAiring = TheTVDB (Aired),<br/>tvdbDvd = TheTVDB (DVD),<br/>tvdbAbsolute = TheTVDB (Absolute)).<br/> | tvdbDvd |
|
| `episodeSort` | [operations.GetLibraryItemsEpisodeSort](../../../sdk/models/operations/getlibraryitemsepisodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
|
||||||
|
| `enableCreditsMarkerGeneration` | [operations.GetLibraryItemsEnableCreditsMarkerGeneration](../../../sdk/models/operations/getlibraryitemsenablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
||||||
|
| `showOrdering` | [operations.GetLibraryItemsShowOrdering](../../../sdk/models/operations/getlibraryitemsshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
|
||||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||||
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||||
| `banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
| `banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsHasThumbnail, GetLibraryItemsPart } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsPart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsPart = {
|
let value: GetLibraryItemsPart = {
|
||||||
id: 119542,
|
id: 119542,
|
||||||
@@ -18,7 +18,6 @@ let value: GetLibraryItemsPart = {
|
|||||||
optimizedForStreaming: false,
|
optimizedForStreaming: false,
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
indexes: "sd",
|
indexes: "sd",
|
||||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
|
||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 272796,
|
id: 272796,
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# GetLibraryItemsQueryParamType
|
# GetLibraryItemsQueryParamType
|
||||||
|
|
||||||
The type of media to retrieve.
|
The type of media to retrieve or filter by.
|
||||||
1 = movie
|
1 = movie
|
||||||
2 = show
|
2 = show
|
||||||
3 = season
|
3 = season
|
||||||
|
|||||||
@@ -3,32 +3,22 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import { GetLibraryItemsQueryParamType, GetLibraryItemsRequest, Tag } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
GetLibraryItemsQueryParamIncludeMeta,
|
|
||||||
GetLibraryItemsQueryParamType,
|
|
||||||
GetLibraryItemsRequest,
|
|
||||||
IncludeGuids,
|
|
||||||
Tag,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsRequest = {
|
let value: GetLibraryItemsRequest = {
|
||||||
tag: Tag.Folder,
|
tag: Tag.Folder,
|
||||||
includeGuids: IncludeGuids.Enable,
|
|
||||||
type: GetLibraryItemsQueryParamType.TvShow,
|
type: GetLibraryItemsQueryParamType.TvShow,
|
||||||
sectionKey: 9518,
|
sectionKey: 9518,
|
||||||
includeMeta: GetLibraryItemsQueryParamIncludeMeta.Enable,
|
|
||||||
xPlexContainerStart: 0,
|
|
||||||
xPlexContainerSize: 50,
|
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `tag` | [operations.Tag](../../../sdk/models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
| `tag` | [operations.Tag](../../../sdk/models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||||
| `includeGuids` | [operations.IncludeGuids](../../../sdk/models/operations/includeguids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
| `includeGuids` | [operations.IncludeGuids](../../../sdk/models/operations/includeguids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||||
| `type` | [operations.GetLibraryItemsQueryParamType](../../../sdk/models/operations/getlibraryitemsqueryparamtype.md) | :heavy_minus_sign: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
| `type` | [operations.GetLibraryItemsQueryParamType](../../../sdk/models/operations/getlibraryitemsqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||||
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
| `includeMeta` | [operations.GetLibraryItemsQueryParamIncludeMeta](../../../sdk/models/operations/getlibraryitemsqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
| `includeMeta` | [operations.GetLibraryItemsQueryParamIncludeMeta](../../../sdk/models/operations/getlibraryitemsqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||||
| `xPlexContainerStart` | *number* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
| `xPlexContainerStart` | *number* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
||||||
|
|||||||
@@ -4,15 +4,11 @@
|
|||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import {
|
||||||
GetLibraryItemsActiveDirection,
|
GetLibraryItemsEnableCreditsMarkerGeneration,
|
||||||
GetLibraryItemsDefaultDirection,
|
GetLibraryItemsEpisodeSort,
|
||||||
GetLibraryItemsFlattenSeasons,
|
GetLibraryItemsFlattenSeasons,
|
||||||
GetLibraryItemsHasThumbnail,
|
|
||||||
GetLibraryItemsLibraryActiveDirection,
|
|
||||||
GetLibraryItemsLibraryDefaultDirection,
|
|
||||||
GetLibraryItemsLibraryResponse200Type,
|
GetLibraryItemsLibraryResponse200Type,
|
||||||
GetLibraryItemsLibraryType,
|
GetLibraryItemsLibraryType,
|
||||||
GetLibraryItemsOptimizedForStreaming,
|
|
||||||
GetLibraryItemsResponse,
|
GetLibraryItemsResponse,
|
||||||
GetLibraryItemsShowOrdering,
|
GetLibraryItemsShowOrdering,
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -45,8 +41,6 @@ let value: GetLibraryItemsResponse = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsActiveDirection.Ascending,
|
|
||||||
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
@@ -114,8 +108,11 @@ let value: GetLibraryItemsResponse = {
|
|||||||
year: 2022,
|
year: 2022,
|
||||||
seasonCount: 2022,
|
seasonCount: 2022,
|
||||||
tagline: "Return to Pandora.",
|
tagline: "Return to Pandora.",
|
||||||
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
|
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
|
||||||
showOrdering: GetLibraryItemsShowOrdering.TvdbDvd,
|
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
|
||||||
|
enableCreditsMarkerGeneration:
|
||||||
|
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
|
||||||
|
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
|
||||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||||
art: "/library/metadata/58683/art/1703239236",
|
art: "/library/metadata/58683/art/1703239236",
|
||||||
banner: "/library/metadata/58683/banner/1703239236",
|
banner: "/library/metadata/58683/banner/1703239236",
|
||||||
@@ -153,8 +150,6 @@ let value: GetLibraryItemsResponse = {
|
|||||||
videoFrameRate: "24p",
|
videoFrameRate: "24p",
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
hasVoiceActivity: false,
|
hasVoiceActivity: false,
|
||||||
optimizedForStreaming:
|
|
||||||
GetLibraryItemsOptimizedForStreaming.Enable,
|
|
||||||
has64bitOffsets: false,
|
has64bitOffsets: false,
|
||||||
part: [
|
part: [
|
||||||
{
|
{
|
||||||
@@ -170,7 +165,6 @@ let value: GetLibraryItemsResponse = {
|
|||||||
optimizedForStreaming: false,
|
optimizedForStreaming: false,
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
indexes: "sd",
|
indexes: "sd",
|
||||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
|
||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 272796,
|
id: 272796,
|
||||||
@@ -327,10 +321,6 @@ let value: GetLibraryItemsResponse = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection:
|
|
||||||
GetLibraryItemsLibraryActiveDirection.Ascending,
|
|
||||||
defaultDirection:
|
|
||||||
GetLibraryItemsLibraryDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
@@ -6,15 +6,11 @@ The contents of the library by section and tag
|
|||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import {
|
||||||
GetLibraryItemsActiveDirection,
|
GetLibraryItemsEnableCreditsMarkerGeneration,
|
||||||
GetLibraryItemsDefaultDirection,
|
GetLibraryItemsEpisodeSort,
|
||||||
GetLibraryItemsFlattenSeasons,
|
GetLibraryItemsFlattenSeasons,
|
||||||
GetLibraryItemsHasThumbnail,
|
|
||||||
GetLibraryItemsLibraryActiveDirection,
|
|
||||||
GetLibraryItemsLibraryDefaultDirection,
|
|
||||||
GetLibraryItemsLibraryResponse200Type,
|
GetLibraryItemsLibraryResponse200Type,
|
||||||
GetLibraryItemsLibraryType,
|
GetLibraryItemsLibraryType,
|
||||||
GetLibraryItemsOptimizedForStreaming,
|
|
||||||
GetLibraryItemsResponseBody,
|
GetLibraryItemsResponseBody,
|
||||||
GetLibraryItemsShowOrdering,
|
GetLibraryItemsShowOrdering,
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -41,8 +37,6 @@ let value: GetLibraryItemsResponseBody = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsActiveDirection.Ascending,
|
|
||||||
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
@@ -110,8 +104,11 @@ let value: GetLibraryItemsResponseBody = {
|
|||||||
year: 2022,
|
year: 2022,
|
||||||
seasonCount: 2022,
|
seasonCount: 2022,
|
||||||
tagline: "Return to Pandora.",
|
tagline: "Return to Pandora.",
|
||||||
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
|
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
|
||||||
showOrdering: GetLibraryItemsShowOrdering.TvdbDvd,
|
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
|
||||||
|
enableCreditsMarkerGeneration:
|
||||||
|
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
|
||||||
|
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
|
||||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||||
art: "/library/metadata/58683/art/1703239236",
|
art: "/library/metadata/58683/art/1703239236",
|
||||||
banner: "/library/metadata/58683/banner/1703239236",
|
banner: "/library/metadata/58683/banner/1703239236",
|
||||||
@@ -149,7 +146,6 @@ let value: GetLibraryItemsResponseBody = {
|
|||||||
videoFrameRate: "24p",
|
videoFrameRate: "24p",
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
hasVoiceActivity: false,
|
hasVoiceActivity: false,
|
||||||
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
|
||||||
has64bitOffsets: false,
|
has64bitOffsets: false,
|
||||||
part: [
|
part: [
|
||||||
{
|
{
|
||||||
@@ -165,7 +161,6 @@ let value: GetLibraryItemsResponseBody = {
|
|||||||
optimizedForStreaming: false,
|
optimizedForStreaming: false,
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
indexes: "sd",
|
indexes: "sd",
|
||||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
|
||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 272796,
|
id: 272796,
|
||||||
@@ -322,9 +317,6 @@ let value: GetLibraryItemsResponseBody = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
|
|
||||||
defaultDirection:
|
|
||||||
GetLibraryItemsLibraryDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetLibraryItemsShowOrdering
|
# GetLibraryItemsShowOrdering
|
||||||
|
|
||||||
Setting that indicates the episode ordering for the show
|
Setting that indicates the episode ordering for the show.
|
||||||
None = Library default,
|
None = Library default,
|
||||||
tmdbAiring = The Movie Database (Aired),
|
tmdbAiring = The Movie Database (Aired),
|
||||||
tvdbAiring = TheTVDB (Aired),
|
aired = TheTVDB (Aired),
|
||||||
tvdbDvd = TheTVDB (DVD),
|
dvd = TheTVDB (DVD),
|
||||||
tvdbAbsolute = TheTVDB (Absolute)).
|
absolute = TheTVDB (Absolute)).
|
||||||
|
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
@@ -13,7 +13,8 @@ tvdbAbsolute = TheTVDB (Absolute)).
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsShowOrdering } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsShowOrdering } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsShowOrdering = GetLibraryItemsShowOrdering.TvdbDvd;
|
let value: GetLibraryItemsShowOrdering =
|
||||||
|
GetLibraryItemsShowOrdering.TvdbAbsolute;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
@@ -22,6 +23,6 @@ let value: GetLibraryItemsShowOrdering = GetLibraryItemsShowOrdering.TvdbDvd;
|
|||||||
| -------------- | -------------- |
|
| -------------- | -------------- |
|
||||||
| `None` | None |
|
| `None` | None |
|
||||||
| `TmdbAiring` | tmdbAiring |
|
| `TmdbAiring` | tmdbAiring |
|
||||||
| `TvdbAiring` | tvdbAiring |
|
| `TvdbAired` | aired |
|
||||||
| `TvdbDvd` | tvdbDvd |
|
| `TvdbDvd` | dvd |
|
||||||
| `TvdbAbsolute` | tvdbAbsolute |
|
| `TvdbAbsolute` | absolute |
|
||||||
@@ -3,17 +3,11 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import { GetLibraryItemsSort } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
GetLibraryItemsActiveDirection,
|
|
||||||
GetLibraryItemsDefaultDirection,
|
|
||||||
GetLibraryItemsSort,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsSort = {
|
let value: GetLibraryItemsSort = {
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsActiveDirection.Ascending,
|
|
||||||
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
@@ -3,11 +3,7 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import { GetLibraryItemsType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
GetLibraryItemsActiveDirection,
|
|
||||||
GetLibraryItemsDefaultDirection,
|
|
||||||
GetLibraryItemsType,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsType = {
|
let value: GetLibraryItemsType = {
|
||||||
key: "/library/sections/2/all?type=2",
|
key: "/library/sections/2/all?type=2",
|
||||||
@@ -27,8 +23,6 @@ let value: GetLibraryItemsType = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsActiveDirection.Ascending,
|
|
||||||
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
21
docs/sdk/models/operations/getmediametadatacountry.md
Normal file
21
docs/sdk/models/operations/getmediametadatacountry.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetMediaMetaDataCountry
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetMediaMetaDataCountry } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetMediaMetaDataCountry = {
|
||||||
|
id: 58591,
|
||||||
|
filter: "country=58591",
|
||||||
|
tag: "United States of America",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | The unique country identifier. | 58591 |
|
||||||
|
| `filter` | *string* | :heavy_check_mark: | The filter string for the country. | country=58591 |
|
||||||
|
| `tag` | *string* | :heavy_check_mark: | The country name. | United States of America |
|
||||||
@@ -1,18 +1,18 @@
|
|||||||
# GetMetaDataByRatingKeyRole
|
# GetMediaMetaDataDirector
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetMetaDataByRatingKeyRole } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetMediaMetaDataDirector } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetMetaDataByRatingKeyRole = {
|
let value: GetMediaMetaDataDirector = {
|
||||||
id: 220,
|
id: 109501,
|
||||||
filter: "actor=220",
|
filter: "actor=109501",
|
||||||
tag: "Dennis Keiffer",
|
tag: "Bob Odenkirk",
|
||||||
tagKey: "5d77683554f42c001f8c4708",
|
tagKey: "5d77683254f42c001f8c3f69",
|
||||||
role: "Bar Guy (uncredited)",
|
role: "Jimmy McGill",
|
||||||
thumb:
|
thumb:
|
||||||
"https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg",
|
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -20,9 +20,9 @@ let value: GetMetaDataByRatingKeyRole = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
| `id` | *number* | :heavy_minus_sign: | N/A | 220 |
|
| `id` | *number* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||||
| `filter` | *string* | :heavy_minus_sign: | N/A | actor=220 |
|
| `filter` | *string* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Dennis Keiffer |
|
| `tag` | *string* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||||
| `tagKey` | *string* | :heavy_minus_sign: | N/A | 5d77683554f42c001f8c4708 |
|
| `tagKey` | *string* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||||
| `role` | *string* | :heavy_minus_sign: | N/A | Bar Guy (uncredited) |
|
| `role` | *string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg |
|
| `thumb` | *string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||||
21
docs/sdk/models/operations/getmediametadatagenre.md
Normal file
21
docs/sdk/models/operations/getmediametadatagenre.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetMediaMetaDataGenre
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetMediaMetaDataGenre } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetMediaMetaDataGenre = {
|
||||||
|
id: 1057,
|
||||||
|
filter: "genre=1057",
|
||||||
|
tag: "Crime",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | The unique genre identifier. | 1057 |
|
||||||
|
| `filter` | *string* | :heavy_check_mark: | The filter string for the genre. | genre=1057 |
|
||||||
|
| `tag` | *string* | :heavy_check_mark: | The genre name. | Crime |
|
||||||
21
docs/sdk/models/operations/getmediametadataimage.md
Normal file
21
docs/sdk/models/operations/getmediametadataimage.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetMediaMetaDataImage
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetMediaMetaDataImage } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetMediaMetaDataImage = {
|
||||||
|
alt: "Better Call Saul",
|
||||||
|
type: "coverPoster",
|
||||||
|
url: "/library/metadata/44288/thumb/1736487993",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||||
|
| `alt` | *string* | :heavy_check_mark: | Alternate text for the image. | Better Call Saul |
|
||||||
|
| `type` | *string* | :heavy_check_mark: | The type of image (e.g., coverPoster, background, clearLogo). | coverPoster |
|
||||||
|
| `url` | *string* | :heavy_check_mark: | The URL of the image. | /library/metadata/44288/thumb/1736487993 |
|
||||||
17
docs/sdk/models/operations/getmediametadatalocation.md
Normal file
17
docs/sdk/models/operations/getmediametadatalocation.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetMediaMetaDataLocation
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetMediaMetaDataLocation } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetMediaMetaDataLocation = {
|
||||||
|
path: "/TV Shows/Better Call Saul",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `path` | *string* | :heavy_check_mark: | The file path for the location. | /TV Shows/Better Call Saul |
|
||||||
108
docs/sdk/models/operations/getmediametadatamedia.md
Normal file
108
docs/sdk/models/operations/getmediametadatamedia.md
Normal file
@@ -0,0 +1,108 @@
|
|||||||
|
# GetMediaMetaDataMedia
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetMediaMetaDataMedia } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetMediaMetaDataMedia = {
|
||||||
|
id: 387322,
|
||||||
|
duration: 9610350,
|
||||||
|
bitrate: 25512,
|
||||||
|
width: 3840,
|
||||||
|
height: 1602,
|
||||||
|
aspectRatio: 2.35,
|
||||||
|
audioChannels: 6,
|
||||||
|
audioCodec: "eac3",
|
||||||
|
videoCodec: "hevc",
|
||||||
|
videoResolution: "4k",
|
||||||
|
container: "mkv",
|
||||||
|
videoFrameRate: "24p",
|
||||||
|
videoProfile: "main 10",
|
||||||
|
hasVoiceActivity: false,
|
||||||
|
part: [
|
||||||
|
{
|
||||||
|
accessible: true,
|
||||||
|
exists: true,
|
||||||
|
id: 418385,
|
||||||
|
key: "/library/parts/418385/1735864239/file.mkv",
|
||||||
|
indexes: "sd",
|
||||||
|
duration: 9610350,
|
||||||
|
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||||
|
size: 30649952104,
|
||||||
|
container: "mkv",
|
||||||
|
videoProfile: "main 10",
|
||||||
|
stream: [
|
||||||
|
{
|
||||||
|
id: 1002625,
|
||||||
|
streamType: 1,
|
||||||
|
default: true,
|
||||||
|
codec: "hevc",
|
||||||
|
index: 0,
|
||||||
|
bitrate: 24743,
|
||||||
|
language: "English",
|
||||||
|
languageTag: "en",
|
||||||
|
languageCode: "eng",
|
||||||
|
doviblCompatID: 1,
|
||||||
|
doviblPresent: true,
|
||||||
|
dovielPresent: false,
|
||||||
|
doviLevel: 6,
|
||||||
|
doviPresent: true,
|
||||||
|
doviProfile: 8,
|
||||||
|
dovirpuPresent: true,
|
||||||
|
doviVersion: "1.0",
|
||||||
|
bitDepth: 10,
|
||||||
|
chromaLocation: "topleft",
|
||||||
|
chromaSubsampling: "4:2:0",
|
||||||
|
codedHeight: 1608,
|
||||||
|
codedWidth: 3840,
|
||||||
|
colorPrimaries: "bt2020",
|
||||||
|
colorRange: "tv",
|
||||||
|
colorSpace: "bt2020nc",
|
||||||
|
colorTrc: "smpte2084",
|
||||||
|
frameRate: 23.976,
|
||||||
|
height: 1602,
|
||||||
|
level: 150,
|
||||||
|
original: true,
|
||||||
|
hasScalingMatrix: false,
|
||||||
|
profile: "main 10",
|
||||||
|
scanType: "progressive",
|
||||||
|
refFrames: 1,
|
||||||
|
width: 3840,
|
||||||
|
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||||
|
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||||
|
selected: true,
|
||||||
|
forced: true,
|
||||||
|
channels: 6,
|
||||||
|
audioChannelLayout: "5.1(side)",
|
||||||
|
samplingRate: 48000,
|
||||||
|
canAutoSync: false,
|
||||||
|
hearingImpaired: true,
|
||||||
|
dub: true,
|
||||||
|
title: "SDH",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||||
|
| `duration` | *number* | :heavy_check_mark: | Duration of the media in milliseconds. | 9610350 |
|
||||||
|
| `bitrate` | *number* | :heavy_check_mark: | Bitrate in bits per second. | 25512 |
|
||||||
|
| `width` | *number* | :heavy_check_mark: | Video width in pixels. | 3840 |
|
||||||
|
| `height` | *number* | :heavy_check_mark: | Video height in pixels. | 1602 |
|
||||||
|
| `aspectRatio` | *number* | :heavy_check_mark: | Aspect ratio of the video. | 2.35 |
|
||||||
|
| `audioChannels` | *number* | :heavy_check_mark: | Number of audio channels. | 6 |
|
||||||
|
| `audioCodec` | *string* | :heavy_check_mark: | Audio codec used. | eac3 |
|
||||||
|
| `videoCodec` | *string* | :heavy_check_mark: | Video codec used. | hevc |
|
||||||
|
| `videoResolution` | *string* | :heavy_check_mark: | Video resolution (e.g., 4k). | 4k |
|
||||||
|
| `container` | *string* | :heavy_check_mark: | File container type. | mkv |
|
||||||
|
| `videoFrameRate` | *string* | :heavy_check_mark: | Frame rate of the video (e.g., 24p). | 24p |
|
||||||
|
| `videoProfile` | *string* | :heavy_check_mark: | Video profile (e.g., main 10). | main 10 |
|
||||||
|
| `hasVoiceActivity` | *boolean* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
|
||||||
|
| `part` | [operations.GetMediaMetaDataPart](../../../sdk/models/operations/getmediametadatapart.md)[] | :heavy_check_mark: | An array of parts for this media item. | |
|
||||||
261
docs/sdk/models/operations/getmediametadatamediacontainer.md
Normal file
261
docs/sdk/models/operations/getmediametadatamediacontainer.md
Normal file
@@ -0,0 +1,261 @@
|
|||||||
|
# GetMediaMetaDataMediaContainer
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetMediaMetaDataMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||||
|
|
||||||
|
let value: GetMediaMetaDataMediaContainer = {
|
||||||
|
size: 50,
|
||||||
|
allowSync: false,
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
librarySectionID: 2,
|
||||||
|
librarySectionTitle: "TV Series",
|
||||||
|
librarySectionUUID: "e69655a2-ef48-4aba-bb19-0cc34d1e7d36",
|
||||||
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
|
mediaTagVersion: 1734362201,
|
||||||
|
metadata: [
|
||||||
|
{
|
||||||
|
ratingKey: "44288",
|
||||||
|
parentRatingKey: "48047",
|
||||||
|
grandparentRatingKey: "45520",
|
||||||
|
parentGuid: "plex://season/618b89208dde18df707ad15c",
|
||||||
|
grandparentGuid: "plex://show/5e16253691c20300412003a8",
|
||||||
|
grandparentSlug: "alice-in-borderland-2020",
|
||||||
|
grandparentKey: "/library/metadata/45520",
|
||||||
|
parentKey: "/library/metadata/48047",
|
||||||
|
key: "/library/metadata/44288/children",
|
||||||
|
guid: "plex://show/5d9c08254eefaa001f5d6dcb",
|
||||||
|
slug: "better-call-saul",
|
||||||
|
studio: "Sony Pictures Television",
|
||||||
|
type: "show",
|
||||||
|
title: "Better Call Saul",
|
||||||
|
originalTitle: "Wicked: Part I",
|
||||||
|
librarySectionTitle: "TV Series ",
|
||||||
|
librarySectionID: 2,
|
||||||
|
librarySectionKey: "/library/sections/2",
|
||||||
|
contentRating: "TV-MA",
|
||||||
|
summary:
|
||||||
|
"Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to \"Breaking Bad\" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman.",
|
||||||
|
index: 1,
|
||||||
|
grandparentTitle: "Alice in Borderland",
|
||||||
|
parentTitle: "Season 2",
|
||||||
|
audienceRating: 8.7,
|
||||||
|
viewCount: 4,
|
||||||
|
skipCount: 1,
|
||||||
|
lastViewedAt: 1625764795,
|
||||||
|
year: 2015,
|
||||||
|
tagline: "Make the call",
|
||||||
|
chapterSource: "media",
|
||||||
|
primaryExtraKey: "/library/metadata/134704",
|
||||||
|
thumb: "/library/metadata/44288/thumb/1736487993",
|
||||||
|
art: "/library/metadata/44288/art/1736487993",
|
||||||
|
theme: "/library/metadata/44288/theme/1736487993",
|
||||||
|
duration: 2700000,
|
||||||
|
originallyAvailableAt: new RFCDate("2015-02-08"),
|
||||||
|
leafCount: 63,
|
||||||
|
viewedLeafCount: 4,
|
||||||
|
childCount: 6,
|
||||||
|
addedAt: 1625505101,
|
||||||
|
updatedAt: 1736487993,
|
||||||
|
audienceRatingImage: "themoviedb://image.rating",
|
||||||
|
parentIndex: 2,
|
||||||
|
parentThumb: "/library/metadata/48047/thumb/1671800243",
|
||||||
|
grandparentThumb: "/library/metadata/45520/thumb/1736488003",
|
||||||
|
grandparentArt: "/library/metadata/45520/art/1736488003",
|
||||||
|
media: [
|
||||||
|
{
|
||||||
|
id: 387322,
|
||||||
|
duration: 9610350,
|
||||||
|
bitrate: 25512,
|
||||||
|
width: 3840,
|
||||||
|
height: 1602,
|
||||||
|
aspectRatio: 2.35,
|
||||||
|
audioChannels: 6,
|
||||||
|
audioCodec: "eac3",
|
||||||
|
videoCodec: "hevc",
|
||||||
|
videoResolution: "4k",
|
||||||
|
container: "mkv",
|
||||||
|
videoFrameRate: "24p",
|
||||||
|
videoProfile: "main 10",
|
||||||
|
hasVoiceActivity: false,
|
||||||
|
part: [
|
||||||
|
{
|
||||||
|
accessible: true,
|
||||||
|
exists: true,
|
||||||
|
id: 418385,
|
||||||
|
key: "/library/parts/418385/1735864239/file.mkv",
|
||||||
|
indexes: "sd",
|
||||||
|
duration: 9610350,
|
||||||
|
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||||
|
size: 30649952104,
|
||||||
|
container: "mkv",
|
||||||
|
videoProfile: "main 10",
|
||||||
|
stream: [
|
||||||
|
{
|
||||||
|
id: 1002625,
|
||||||
|
streamType: 1,
|
||||||
|
default: true,
|
||||||
|
codec: "hevc",
|
||||||
|
index: 0,
|
||||||
|
bitrate: 24743,
|
||||||
|
language: "English",
|
||||||
|
languageTag: "en",
|
||||||
|
languageCode: "eng",
|
||||||
|
doviblCompatID: 1,
|
||||||
|
doviblPresent: true,
|
||||||
|
dovielPresent: false,
|
||||||
|
doviLevel: 6,
|
||||||
|
doviPresent: true,
|
||||||
|
doviProfile: 8,
|
||||||
|
dovirpuPresent: true,
|
||||||
|
doviVersion: "1.0",
|
||||||
|
bitDepth: 10,
|
||||||
|
chromaLocation: "topleft",
|
||||||
|
chromaSubsampling: "4:2:0",
|
||||||
|
codedHeight: 1608,
|
||||||
|
codedWidth: 3840,
|
||||||
|
colorPrimaries: "bt2020",
|
||||||
|
colorRange: "tv",
|
||||||
|
colorSpace: "bt2020nc",
|
||||||
|
colorTrc: "smpte2084",
|
||||||
|
frameRate: 23.976,
|
||||||
|
height: 1602,
|
||||||
|
level: 150,
|
||||||
|
original: true,
|
||||||
|
hasScalingMatrix: false,
|
||||||
|
profile: "main 10",
|
||||||
|
scanType: "progressive",
|
||||||
|
refFrames: 1,
|
||||||
|
width: 3840,
|
||||||
|
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||||
|
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||||
|
selected: true,
|
||||||
|
forced: true,
|
||||||
|
channels: 6,
|
||||||
|
audioChannelLayout: "5.1(side)",
|
||||||
|
samplingRate: 48000,
|
||||||
|
canAutoSync: false,
|
||||||
|
hearingImpaired: true,
|
||||||
|
dub: true,
|
||||||
|
title: "SDH",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
image: [
|
||||||
|
{
|
||||||
|
alt: "Better Call Saul",
|
||||||
|
type: "coverPoster",
|
||||||
|
url: "/library/metadata/44288/thumb/1736487993",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
ultraBlurColors: {
|
||||||
|
topLeft: "11333a",
|
||||||
|
topRight: "1d2721",
|
||||||
|
bottomRight: "5c451d",
|
||||||
|
bottomLeft: "372c10",
|
||||||
|
},
|
||||||
|
genre: [
|
||||||
|
{
|
||||||
|
id: 1057,
|
||||||
|
filter: "genre=1057",
|
||||||
|
tag: "Crime",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
country: [
|
||||||
|
{
|
||||||
|
id: 58591,
|
||||||
|
filter: "country=58591",
|
||||||
|
tag: "United States of America",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
guids: [
|
||||||
|
{
|
||||||
|
id: "imdb://tt3032476",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
rating: [
|
||||||
|
{
|
||||||
|
image: "imdb://image.rating",
|
||||||
|
value: 9,
|
||||||
|
type: "audience",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
role: [
|
||||||
|
{
|
||||||
|
id: 109501,
|
||||||
|
filter: "actor=109501",
|
||||||
|
tag: "Bob Odenkirk",
|
||||||
|
tagKey: "5d77683254f42c001f8c3f69",
|
||||||
|
role: "Jimmy McGill",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
director: [
|
||||||
|
{
|
||||||
|
id: 109501,
|
||||||
|
filter: "actor=109501",
|
||||||
|
tag: "Bob Odenkirk",
|
||||||
|
tagKey: "5d77683254f42c001f8c3f69",
|
||||||
|
role: "Jimmy McGill",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
writer: [
|
||||||
|
{
|
||||||
|
id: 109501,
|
||||||
|
filter: "actor=109501",
|
||||||
|
tag: "Bob Odenkirk",
|
||||||
|
tagKey: "5d77683254f42c001f8c3f69",
|
||||||
|
role: "Jimmy McGill",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
producer: [
|
||||||
|
{
|
||||||
|
id: 109501,
|
||||||
|
filter: "actor=109501",
|
||||||
|
tag: "Bob Odenkirk",
|
||||||
|
tagKey: "5d77683254f42c001f8c3f69",
|
||||||
|
role: "Jimmy McGill",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
similar: [
|
||||||
|
{
|
||||||
|
id: 26,
|
||||||
|
filter: "similar=26",
|
||||||
|
tag: "Breaking Bad",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
location: [
|
||||||
|
{
|
||||||
|
path: "/TV Shows/Better Call Saul",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
|
||||||
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
|
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
|
| `librarySectionID` | *number* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
||||||
|
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
|
||||||
|
| `librarySectionUUID` | *string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||||
|
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
|
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
|
| `metadata` | [operations.GetMediaMetaDataMetadata](../../../sdk/models/operations/getmediametadatametadata.md)[] | :heavy_check_mark: | An array of metadata items. | |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user