mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
18b64727c3 | ||
|
|
3152372037 | ||
|
|
13cd8a7fe5 | ||
|
|
cdcdc0ca8e |
@@ -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
|
||||
/sdk/models/errors
|
||||
/sdk/types
|
||||
|
||||
@@ -4,9 +4,10 @@
|
||||
!/REACT_QUERY.md
|
||||
!/**/*.ts
|
||||
!/**/*.js
|
||||
!/**/*.json
|
||||
!/**/*.map
|
||||
|
||||
/.eslintrc.js
|
||||
/eslint.config.mjs
|
||||
/cjs
|
||||
/.tshy
|
||||
/.tshy-*
|
||||
|
||||
1588
.speakeasy/gen.lock
1588
.speakeasy/gen.lock
File diff suppressed because one or more lines are too long
@@ -13,7 +13,7 @@ generation:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
oAuth2PasswordEnabled: false
|
||||
typescript:
|
||||
version: 0.32.1
|
||||
version: 0.32.5
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies: {}
|
||||
@@ -22,6 +22,7 @@ typescript:
|
||||
author: LukeHagar
|
||||
clientServerStatusCodesAsErrors: true
|
||||
defaultErrorName: SDKError
|
||||
enableCustomCodeRegions: false
|
||||
enableReactQuery: false
|
||||
enumFormat: enum
|
||||
flattenGlobalSecurity: true
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.459.2
|
||||
speakeasyVersion: 1.484.1
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
@@ -9,20 +9,20 @@ sources:
|
||||
- main
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:28e2213b78ff9c789846a4a0b7ab9fb219079a1699d44b22d28474efc4f48eac
|
||||
sourceBlobDigest: sha256:fa76c39de0ff801844dd56a76c26ab6ca88695fc9b42bb9ff9a8aab5b2b21277
|
||||
sourceRevisionDigest: sha256:e6ab335dd91a4165f4510e4a3af8a55819c6310b7e66251266d2384376f3ccae
|
||||
sourceBlobDigest: sha256:89d1b1133e400c89f0d06efe5e5168f5ba25a413e1ab8380d442d6b233e2e5a9
|
||||
tags:
|
||||
- latest
|
||||
- speakeasy-sdk-regen-1734826254
|
||||
- speakeasy-sdk-regen-1738800605
|
||||
- 0.0.3
|
||||
targets:
|
||||
plexjs:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:28e2213b78ff9c789846a4a0b7ab9fb219079a1699d44b22d28474efc4f48eac
|
||||
sourceBlobDigest: sha256:fa76c39de0ff801844dd56a76c26ab6ca88695fc9b42bb9ff9a8aab5b2b21277
|
||||
sourceRevisionDigest: sha256:e6ab335dd91a4165f4510e4a3af8a55819c6310b7e66251266d2384376f3ccae
|
||||
sourceBlobDigest: sha256:89d1b1133e400c89f0d06efe5e5168f5ba25a413e1ab8380d442d6b233e2e5a9
|
||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||
codeSamplesRevisionDigest: sha256:7d4fa9b8b7f828000504117f5d5075b647941dd02857cd0c4dded2aafa917a83
|
||||
codeSamplesRevisionDigest: sha256:214b9a57e050598b3c15f0f8504a591973e8399cad8b8be2917772c3f75861a9
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
|
||||
@@ -161,6 +161,8 @@ run();
|
||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The 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
|
||||
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||
@@ -241,6 +243,10 @@ run();
|
||||
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for 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)
|
||||
|
||||
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
||||
@@ -503,7 +509,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
- [`hubsGetRecentlyAdded`](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
|
||||
- [`libraryDeleteLibrary`](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||
- [`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
|
||||
- [`libraryGetGenresLibrary`](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
||||
- [`libraryGetLibraryDetails`](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||
- [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||
- [`libraryGetMetaDataByRatingKey`](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
||||
@@ -560,6 +568,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
- [`updaterApplyUpdates`](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
||||
- [`updaterCheckForUpdates`](docs/sdks/updater/README.md#checkforupdates) - Checking for 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
|
||||
- [`videoStartUniversalTranscode`](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
|
||||
- [`watchlistGetWatchList`](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
|
||||
|
||||
42
RELEASES.md
42
RELEASES.md
@@ -1168,4 +1168,44 @@ Based on:
|
||||
### Generated
|
||||
- [typescript v0.32.1] .
|
||||
### Releases
|
||||
- [NPM v0.32.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.1 - .
|
||||
- [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 - .
|
||||
26
RUNTIMES.md
26
RUNTIMES.md
@@ -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])
|
||||
|
||||
[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.
|
||||
112
codeSamples.yaml
112
codeSamples.yaml
@@ -422,7 +422,7 @@ actions:
|
||||
label: added
|
||||
source: |-
|
||||
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({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
@@ -433,9 +433,6 @@ actions:
|
||||
contentDirectoryID: 470161,
|
||||
sectionID: 2,
|
||||
type: Type.TvShow,
|
||||
includeMeta: IncludeMeta.Enable,
|
||||
xPlexContainerStart: 0,
|
||||
xPlexContainerSize: 50,
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
@@ -456,7 +453,7 @@ actions:
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.search.performSearch("dylan", 5);
|
||||
const result = await plexAPI.search.performSearch("dylan");
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
@@ -476,7 +473,7 @@ actions:
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.search.performVoiceSearch("dead+poop", 5);
|
||||
const result = await plexAPI.search.performVoiceSearch("dead+poop");
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
@@ -622,7 +619,7 @@ actions:
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getMetadataChildren(1539.15, "Stream");
|
||||
const result = await plexAPI.library.getMetadataChildren(1539.14, "Stream");
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
@@ -683,7 +680,7 @@ actions:
|
||||
label: library
|
||||
source: |-
|
||||
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({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
@@ -708,9 +705,6 @@ actions:
|
||||
],
|
||||
sectionID: 2,
|
||||
type: QueryParamType.TvShow,
|
||||
includeMeta: QueryParamIncludeMeta.Enable,
|
||||
xPlexContainerStart: 0,
|
||||
xPlexContainerSize: 50,
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
@@ -725,7 +719,7 @@ actions:
|
||||
label: libraries
|
||||
source: |-
|
||||
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({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
@@ -738,8 +732,6 @@ actions:
|
||||
searchTypes: [
|
||||
SearchTypes.People,
|
||||
],
|
||||
includeCollections: QueryParamIncludeCollections.Enable,
|
||||
includeExternalMedia: QueryParamIncludeExternalMedia.Enable,
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
@@ -783,8 +775,6 @@ actions:
|
||||
async function run() {
|
||||
const result = await plexAPI.watchlist.getWatchList({
|
||||
filter: Filter.Available,
|
||||
xPlexContainerStart: 0,
|
||||
xPlexContainerSize: 50,
|
||||
xPlexToken: "CV5xoxjTpFKUzBTShsaf",
|
||||
});
|
||||
|
||||
@@ -832,6 +822,46 @@ actions:
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/country"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: library
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getCountriesLibrary(9518);
|
||||
|
||||
// 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";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getGenresLibrary(9518);
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/refresh"]["get"]
|
||||
update:
|
||||
@@ -882,12 +912,7 @@ actions:
|
||||
label: items
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import {
|
||||
GetLibraryItemsQueryParamIncludeMeta,
|
||||
GetLibraryItemsQueryParamType,
|
||||
IncludeGuids,
|
||||
Tag,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetLibraryItemsQueryParamType, Tag } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
@@ -896,12 +921,8 @@ actions:
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getLibraryItems({
|
||||
tag: Tag.Edition,
|
||||
includeGuids: IncludeGuids.Enable,
|
||||
type: GetLibraryItemsQueryParamType.TvShow,
|
||||
sectionKey: 9518,
|
||||
includeMeta: GetLibraryItemsQueryParamIncludeMeta.Enable,
|
||||
xPlexContainerStart: 0,
|
||||
xPlexContainerSize: 50,
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
@@ -1210,7 +1231,7 @@ actions:
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.playlists.updatePlaylist(3915.00);
|
||||
const result = await plexAPI.playlists.updatePlaylist(3915);
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
@@ -1271,7 +1292,7 @@ actions:
|
||||
});
|
||||
|
||||
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
|
||||
console.log(result);
|
||||
@@ -1285,14 +1306,13 @@ actions:
|
||||
label: resources
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { IncludeHttps, IncludeIPv6, IncludeRelay } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
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
|
||||
console.log(result);
|
||||
@@ -1601,6 +1621,38 @@ actions:
|
||||
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();
|
||||
- target: $["paths"]["/users/signin"]["post"]
|
||||
update:
|
||||
|
||||
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/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";
|
||||
|
||||
let value: AddPlaylistContentsRequest = {
|
||||
playlistID: 6289.82,
|
||||
playlistID: 1856.36,
|
||||
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
||||
playQueueID: 123,
|
||||
};
|
||||
|
||||
@@ -7,7 +7,7 @@ import { AddPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operat
|
||||
|
||||
let value: AddPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 503,
|
||||
statusCode: 507,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
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 = {
|
||||
contentType: "<value>",
|
||||
statusCode: 103,
|
||||
statusCode: 205,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { Billing } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Billing = {
|
||||
internalPaymentMethod: {},
|
||||
paymentMethodId: 374170,
|
||||
paymentMethodId: 863856,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { CheckForUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations
|
||||
|
||||
let value: CheckForUpdatesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 201,
|
||||
statusCode: 424,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ClearPlaylistContentsRequest = {
|
||||
playlistID: 3834.64,
|
||||
playlistID: 8726.51,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { ClearPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/oper
|
||||
|
||||
let value: ClearPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 307,
|
||||
statusCode: 207,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ type of playlist to create
|
||||
```typescript
|
||||
import { CreatePlaylistQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Audio;
|
||||
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Video;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -7,9 +7,9 @@ import { CreatePlaylistQueryParamType, CreatePlaylistRequest, Smart } from "@luk
|
||||
|
||||
let value: CreatePlaylistRequest = {
|
||||
title: "<value>",
|
||||
type: CreatePlaylistQueryParamType.Photo,
|
||||
smart: Smart.One,
|
||||
uri: "https://enchanted-disclosure.com/",
|
||||
type: CreatePlaylistQueryParamType.Audio,
|
||||
smart: Smart.Zero,
|
||||
uri: "https://general-possession.info/",
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { CreatePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
||||
|
||||
let value: CreatePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 302,
|
||||
statusCode: 100,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: DeletePlaylistRequest = {
|
||||
playlistID: 5365.79,
|
||||
playlistID: 6630.78,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { DeletePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
||||
|
||||
let value: DeletePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 511,
|
||||
statusCode: 200,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
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 = {
|
||||
contentType: "<value>",
|
||||
statusCode: 203,
|
||||
statusCode: 508,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
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 |
|
||||
@@ -7,7 +7,7 @@ Filter
|
||||
```typescript
|
||||
import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Filter = Filter.Available;
|
||||
let value: Filter = Filter.All;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -1,16 +1,19 @@
|
||||
# FlattenSeasons
|
||||
|
||||
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { FlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: FlattenSeasons = FlattenSeasons.True;
|
||||
let value: FlattenSeasons = FlattenSeasons.Show;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `False` | 0 |
|
||||
| `True` | 1 |
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Hide` | 0 |
|
||||
| `Show` | 1 |
|
||||
@@ -10,13 +10,8 @@ let value: Friend = {
|
||||
friendlyName: "exampleUser",
|
||||
home: true,
|
||||
id: 0,
|
||||
restricted: false,
|
||||
sharedServers: [
|
||||
{},
|
||||
],
|
||||
sharedSources: [
|
||||
{},
|
||||
],
|
||||
sharedServers: [],
|
||||
sharedSources: [],
|
||||
status: Status.Accepted,
|
||||
thumb: "https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578",
|
||||
title: "username123",
|
||||
|
||||
@@ -12,11 +12,8 @@ let value: GeoData = {
|
||||
continentCode: "NA",
|
||||
country: "United States Virgin Islands",
|
||||
city: "Amsterdam",
|
||||
europeanUnionMember: true,
|
||||
timeZone: "America/St_Thomas",
|
||||
postalCode: "802",
|
||||
inPrivacyRestrictedCountry: true,
|
||||
inPrivacyRestrictedRegion: true,
|
||||
subdivisions: "Saint Thomas",
|
||||
coordinates: "18.3381, -64.8941",
|
||||
};
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs/sdk/models/ope
|
||||
|
||||
let value: GetBandwidthStatisticsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 101,
|
||||
statusCode: 423,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
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 |
|
||||
@@ -0,0 +1,49 @@
|
||||
# GetCountriesLibraryMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetCountriesLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetCountriesLibraryMediaContainer = {
|
||||
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 | 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 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 | |
|
||||
17
docs/sdk/models/operations/getcountrieslibraryrequest.md
Normal file
17
docs/sdk/models/operations/getcountrieslibraryrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetCountriesLibraryRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetCountriesLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetCountriesLibraryRequest = {
|
||||
sectionKey: 9518,
|
||||
};
|
||||
```
|
||||
|
||||
## 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 |
|
||||
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 | |
|
||||
17
docs/sdk/models/operations/getgenreslibraryrequest.md
Normal file
17
docs/sdk/models/operations/getgenreslibraryrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetGenresLibraryRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGenresLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetGenresLibraryRequest = {
|
||||
sectionKey: 9518,
|
||||
};
|
||||
```
|
||||
|
||||
## 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 |
|
||||
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",
|
||||
country: "United States Virgin Islands",
|
||||
city: "Amsterdam",
|
||||
europeanUnionMember: true,
|
||||
timeZone: "America/St_Thomas",
|
||||
postalCode: "802",
|
||||
inPrivacyRestrictedCountry: true,
|
||||
inPrivacyRestrictedRegion: true,
|
||||
subdivisions: "Saint Thomas",
|
||||
coordinates: "18.3381, -64.8941",
|
||||
};
|
||||
|
||||
@@ -16,11 +16,8 @@ let value: GetGeoDataResponse = {
|
||||
continentCode: "NA",
|
||||
country: "United States Virgin Islands",
|
||||
city: "Amsterdam",
|
||||
europeanUnionMember: true,
|
||||
timeZone: "America/St_Thomas",
|
||||
postalCode: "802",
|
||||
inPrivacyRestrictedCountry: true,
|
||||
inPrivacyRestrictedRegion: true,
|
||||
subdivisions: "Saint Thomas",
|
||||
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
|
||||
|
||||
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryItemsFlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsFlattenSeasons = GetLibraryItemsFlattenSeasons.True;
|
||||
let value: GetLibraryItemsFlattenSeasons = GetLibraryItemsFlattenSeasons.Show;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `False` | 0 |
|
||||
| `True` | 1 |
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Hide` | 0 |
|
||||
| `Show` | 1 |
|
||||
@@ -3,11 +3,7 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetLibraryItemsLibraryActiveDirection,
|
||||
GetLibraryItemsLibraryDefaultDirection,
|
||||
GetLibraryItemsLibraryResponseType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetLibraryItemsLibraryResponseType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsLibraryResponseType = {
|
||||
key: "/library/sections/2/all?type=2",
|
||||
@@ -27,8 +23,6 @@ let value: GetLibraryItemsLibraryResponseType = {
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
|
||||
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
|
||||
@@ -3,17 +3,11 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetLibraryItemsLibraryActiveDirection,
|
||||
GetLibraryItemsLibraryDefaultDirection,
|
||||
GetLibraryItemsLibrarySort,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetLibraryItemsLibrarySort } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsLibrarySort = {
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
|
||||
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
|
||||
@@ -3,11 +3,7 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetLibraryItemsHasThumbnail,
|
||||
GetLibraryItemsMedia,
|
||||
GetLibraryItemsOptimizedForStreaming,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetLibraryItemsMedia } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsMedia = {
|
||||
id: 119534,
|
||||
@@ -25,7 +21,6 @@ let value: GetLibraryItemsMedia = {
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
@@ -41,7 +36,6 @@ let value: GetLibraryItemsMedia = {
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
||||
stream: [
|
||||
{
|
||||
id: 272796,
|
||||
|
||||
@@ -7,16 +7,12 @@ The Meta object is only included in the response if the `includeMeta` parameter
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetLibraryItemsActiveDirection,
|
||||
GetLibraryItemsDefaultDirection,
|
||||
GetLibraryItemsEnableCreditsMarkerGeneration,
|
||||
GetLibraryItemsEpisodeSort,
|
||||
GetLibraryItemsFlattenSeasons,
|
||||
GetLibraryItemsHasThumbnail,
|
||||
GetLibraryItemsLibraryActiveDirection,
|
||||
GetLibraryItemsLibraryDefaultDirection,
|
||||
GetLibraryItemsLibraryResponse200Type,
|
||||
GetLibraryItemsLibraryType,
|
||||
GetLibraryItemsMediaContainer,
|
||||
GetLibraryItemsOptimizedForStreaming,
|
||||
GetLibraryItemsShowOrdering,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
@@ -41,8 +37,6 @@ let value: GetLibraryItemsMediaContainer = {
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: GetLibraryItemsActiveDirection.Ascending,
|
||||
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
@@ -110,8 +104,11 @@ let value: GetLibraryItemsMediaContainer = {
|
||||
year: 2022,
|
||||
seasonCount: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
|
||||
showOrdering: GetLibraryItemsShowOrdering.TvdbDvd,
|
||||
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
|
||||
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
|
||||
enableCreditsMarkerGeneration:
|
||||
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
|
||||
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
banner: "/library/metadata/58683/banner/1703239236",
|
||||
@@ -149,7 +146,6 @@ let value: GetLibraryItemsMediaContainer = {
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
@@ -165,7 +161,6 @@ let value: GetLibraryItemsMediaContainer = {
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
||||
stream: [
|
||||
{
|
||||
id: 272796,
|
||||
@@ -322,8 +317,6 @@ let value: GetLibraryItemsMediaContainer = {
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
|
||||
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
|
||||
@@ -6,11 +6,7 @@ The Meta object is only included in the response if the `includeMeta` parameter
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetLibraryItemsLibraryActiveDirection,
|
||||
GetLibraryItemsLibraryDefaultDirection,
|
||||
GetLibraryItemsMeta,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetLibraryItemsMeta } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsMeta = {
|
||||
type: [
|
||||
@@ -32,8 +28,6 @@ let value: GetLibraryItemsMeta = {
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
|
||||
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
|
||||
@@ -4,12 +4,12 @@
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetLibraryItemsEnableCreditsMarkerGeneration,
|
||||
GetLibraryItemsEpisodeSort,
|
||||
GetLibraryItemsFlattenSeasons,
|
||||
GetLibraryItemsHasThumbnail,
|
||||
GetLibraryItemsLibraryResponse200Type,
|
||||
GetLibraryItemsLibraryType,
|
||||
GetLibraryItemsMetadata,
|
||||
GetLibraryItemsOptimizedForStreaming,
|
||||
GetLibraryItemsShowOrdering,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
@@ -34,8 +34,11 @@ let value: GetLibraryItemsMetadata = {
|
||||
year: 2022,
|
||||
seasonCount: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
|
||||
showOrdering: GetLibraryItemsShowOrdering.TvdbDvd,
|
||||
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
|
||||
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
|
||||
enableCreditsMarkerGeneration:
|
||||
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
|
||||
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
banner: "/library/metadata/58683/banner/1703239236",
|
||||
@@ -73,7 +76,6 @@ let value: GetLibraryItemsMetadata = {
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
@@ -89,7 +91,6 @@ let value: GetLibraryItemsMetadata = {
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
||||
stream: [
|
||||
{
|
||||
id: 272796,
|
||||
@@ -249,8 +250,10 @@ let value: GetLibraryItemsMetadata = {
|
||||
| `year` | *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. |
|
||||
| `flattenSeasons` | [operations.GetLibraryItemsFlattenSeasons](../../../sdk/models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | N/A | 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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryItemsHasThumbnail, GetLibraryItemsPart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetLibraryItemsPart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsPart = {
|
||||
id: 119542,
|
||||
@@ -18,7 +18,6 @@ let value: GetLibraryItemsPart = {
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
||||
stream: [
|
||||
{
|
||||
id: 272796,
|
||||
|
||||
@@ -3,22 +3,12 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetLibraryItemsQueryParamIncludeMeta,
|
||||
GetLibraryItemsQueryParamType,
|
||||
GetLibraryItemsRequest,
|
||||
IncludeGuids,
|
||||
Tag,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetLibraryItemsQueryParamType, GetLibraryItemsRequest, Tag } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsRequest = {
|
||||
tag: Tag.Folder,
|
||||
includeGuids: IncludeGuids.Enable,
|
||||
type: GetLibraryItemsQueryParamType.TvShow,
|
||||
sectionKey: 9518,
|
||||
includeMeta: GetLibraryItemsQueryParamIncludeMeta.Enable,
|
||||
xPlexContainerStart: 0,
|
||||
xPlexContainerSize: 50,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -4,15 +4,11 @@
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetLibraryItemsActiveDirection,
|
||||
GetLibraryItemsDefaultDirection,
|
||||
GetLibraryItemsEnableCreditsMarkerGeneration,
|
||||
GetLibraryItemsEpisodeSort,
|
||||
GetLibraryItemsFlattenSeasons,
|
||||
GetLibraryItemsHasThumbnail,
|
||||
GetLibraryItemsLibraryActiveDirection,
|
||||
GetLibraryItemsLibraryDefaultDirection,
|
||||
GetLibraryItemsLibraryResponse200Type,
|
||||
GetLibraryItemsLibraryType,
|
||||
GetLibraryItemsOptimizedForStreaming,
|
||||
GetLibraryItemsResponse,
|
||||
GetLibraryItemsShowOrdering,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -45,8 +41,6 @@ let value: GetLibraryItemsResponse = {
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: GetLibraryItemsActiveDirection.Ascending,
|
||||
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
@@ -114,8 +108,11 @@ let value: GetLibraryItemsResponse = {
|
||||
year: 2022,
|
||||
seasonCount: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
|
||||
showOrdering: GetLibraryItemsShowOrdering.TvdbDvd,
|
||||
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
|
||||
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
|
||||
enableCreditsMarkerGeneration:
|
||||
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
|
||||
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
banner: "/library/metadata/58683/banner/1703239236",
|
||||
@@ -153,8 +150,6 @@ let value: GetLibraryItemsResponse = {
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
optimizedForStreaming:
|
||||
GetLibraryItemsOptimizedForStreaming.Enable,
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
@@ -170,7 +165,6 @@ let value: GetLibraryItemsResponse = {
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
||||
stream: [
|
||||
{
|
||||
id: 272796,
|
||||
@@ -327,10 +321,6 @@ let value: GetLibraryItemsResponse = {
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection:
|
||||
GetLibraryItemsLibraryActiveDirection.Ascending,
|
||||
defaultDirection:
|
||||
GetLibraryItemsLibraryDefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
|
||||
@@ -6,15 +6,11 @@ The contents of the library by section and tag
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetLibraryItemsActiveDirection,
|
||||
GetLibraryItemsDefaultDirection,
|
||||
GetLibraryItemsEnableCreditsMarkerGeneration,
|
||||
GetLibraryItemsEpisodeSort,
|
||||
GetLibraryItemsFlattenSeasons,
|
||||
GetLibraryItemsHasThumbnail,
|
||||
GetLibraryItemsLibraryActiveDirection,
|
||||
GetLibraryItemsLibraryDefaultDirection,
|
||||
GetLibraryItemsLibraryResponse200Type,
|
||||
GetLibraryItemsLibraryType,
|
||||
GetLibraryItemsOptimizedForStreaming,
|
||||
GetLibraryItemsResponseBody,
|
||||
GetLibraryItemsShowOrdering,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -41,8 +37,6 @@ let value: GetLibraryItemsResponseBody = {
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: GetLibraryItemsActiveDirection.Ascending,
|
||||
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
@@ -110,8 +104,11 @@ let value: GetLibraryItemsResponseBody = {
|
||||
year: 2022,
|
||||
seasonCount: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
|
||||
showOrdering: GetLibraryItemsShowOrdering.TvdbDvd,
|
||||
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
|
||||
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
|
||||
enableCreditsMarkerGeneration:
|
||||
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
|
||||
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
banner: "/library/metadata/58683/banner/1703239236",
|
||||
@@ -149,7 +146,6 @@ let value: GetLibraryItemsResponseBody = {
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
@@ -165,7 +161,6 @@ let value: GetLibraryItemsResponseBody = {
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
||||
stream: [
|
||||
{
|
||||
id: 272796,
|
||||
@@ -322,9 +317,6 @@ let value: GetLibraryItemsResponseBody = {
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
|
||||
defaultDirection:
|
||||
GetLibraryItemsLibraryDefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetLibraryItemsShowOrdering
|
||||
|
||||
Setting that indicates the episode ordering for the show
|
||||
Setting that indicates the episode ordering for the show.
|
||||
None = Library default,
|
||||
tmdbAiring = The Movie Database (Aired),
|
||||
tvdbAiring = TheTVDB (Aired),
|
||||
tvdbDvd = TheTVDB (DVD),
|
||||
tvdbAbsolute = TheTVDB (Absolute)).
|
||||
aired = TheTVDB (Aired),
|
||||
dvd = TheTVDB (DVD),
|
||||
absolute = TheTVDB (Absolute)).
|
||||
|
||||
|
||||
## Example Usage
|
||||
@@ -13,7 +13,8 @@ tvdbAbsolute = TheTVDB (Absolute)).
|
||||
```typescript
|
||||
import { GetLibraryItemsShowOrdering } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsShowOrdering = GetLibraryItemsShowOrdering.TvdbDvd;
|
||||
let value: GetLibraryItemsShowOrdering =
|
||||
GetLibraryItemsShowOrdering.TvdbAbsolute;
|
||||
```
|
||||
|
||||
## Values
|
||||
@@ -22,6 +23,6 @@ let value: GetLibraryItemsShowOrdering = GetLibraryItemsShowOrdering.TvdbDvd;
|
||||
| -------------- | -------------- |
|
||||
| `None` | None |
|
||||
| `TmdbAiring` | tmdbAiring |
|
||||
| `TvdbAiring` | tvdbAiring |
|
||||
| `TvdbDvd` | tvdbDvd |
|
||||
| `TvdbAbsolute` | tvdbAbsolute |
|
||||
| `TvdbAired` | aired |
|
||||
| `TvdbDvd` | dvd |
|
||||
| `TvdbAbsolute` | absolute |
|
||||
@@ -3,17 +3,11 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetLibraryItemsActiveDirection,
|
||||
GetLibraryItemsDefaultDirection,
|
||||
GetLibraryItemsSort,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetLibraryItemsSort } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsSort = {
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: GetLibraryItemsActiveDirection.Ascending,
|
||||
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
|
||||
@@ -3,11 +3,7 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetLibraryItemsActiveDirection,
|
||||
GetLibraryItemsDefaultDirection,
|
||||
GetLibraryItemsType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetLibraryItemsType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsType = {
|
||||
key: "/library/sections/2/all?type=2",
|
||||
@@ -27,8 +23,6 @@ let value: GetLibraryItemsType = {
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: GetLibraryItemsActiveDirection.Ascending,
|
||||
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
|
||||
@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetMetaDataByRatingKeyResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 207,
|
||||
statusCode: 100,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetMetadataChildrenRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMetadataChildrenRequest = {
|
||||
ratingKey: 1716.30,
|
||||
ratingKey: 185.21,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetMetadataChildrenResponse } from "@lukehagar/plexjs/sdk/models/operat
|
||||
|
||||
let value: GetMetadataChildrenResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 300,
|
||||
statusCode: 406,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetOnDeckResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetOnDeckResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 406,
|
||||
statusCode: 400,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -11,7 +11,6 @@ let value: GetPinAuthPinContainer = {
|
||||
id: 308667304,
|
||||
code: "7RQZ",
|
||||
product: "0",
|
||||
trusted: false,
|
||||
qr: "https://plex.tv/api/v2/pins/qr/7RQZ",
|
||||
clientIdentifier: "string",
|
||||
location: {
|
||||
@@ -19,15 +18,11 @@ let value: GetPinAuthPinContainer = {
|
||||
continentCode: "NA",
|
||||
country: "United States Virgin Islands",
|
||||
city: "Amsterdam",
|
||||
europeanUnionMember: true,
|
||||
timeZone: "America/St_Thomas",
|
||||
postalCode: "802",
|
||||
inPrivacyRestrictedCountry: true,
|
||||
inPrivacyRestrictedRegion: true,
|
||||
subdivisions: "Saint Thomas",
|
||||
coordinates: "18.3381, -64.8941",
|
||||
},
|
||||
expiresIn: 876,
|
||||
createdAt: new Date("2024-07-16T17:03:05Z"),
|
||||
expiresAt: new Date("2024-07-16T17:18:05Z"),
|
||||
authToken: null,
|
||||
|
||||
@@ -15,7 +15,6 @@ let value: GetPinResponse = {
|
||||
id: 308667304,
|
||||
code: "7RQZ",
|
||||
product: "0",
|
||||
trusted: false,
|
||||
qr: "https://plex.tv/api/v2/pins/qr/7RQZ",
|
||||
clientIdentifier: "string",
|
||||
location: {
|
||||
@@ -23,15 +22,11 @@ let value: GetPinResponse = {
|
||||
continentCode: "NA",
|
||||
country: "United States Virgin Islands",
|
||||
city: "Amsterdam",
|
||||
europeanUnionMember: true,
|
||||
timeZone: "America/St_Thomas",
|
||||
postalCode: "802",
|
||||
inPrivacyRestrictedCountry: true,
|
||||
inPrivacyRestrictedRegion: true,
|
||||
subdivisions: "Saint Thomas",
|
||||
coordinates: "18.3381, -64.8941",
|
||||
},
|
||||
expiresIn: 876,
|
||||
createdAt: new Date("2024-07-16T17:03:05Z"),
|
||||
expiresAt: new Date("2024-07-16T17:18:05Z"),
|
||||
authToken: null,
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetPlaylistContentsQueryParamType, GetPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistContentsRequest = {
|
||||
playlistID: 206.51,
|
||||
playlistID: 5883.17,
|
||||
type: GetPlaylistContentsQueryParamType.TvShow,
|
||||
};
|
||||
```
|
||||
|
||||
@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 409,
|
||||
statusCode: 506,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetPlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistRequest = {
|
||||
playlistID: 672.50,
|
||||
playlistID: 8966.72,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetPlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 413,
|
||||
statusCode: 502,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetPlaylistsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 100,
|
||||
statusCode: 304,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@ The Meta object is only included in the response if the `includeMeta` parameter
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ActiveDirection, DefaultDirection, GetRecentlyAddedLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetRecentlyAddedLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetRecentlyAddedLibraryMediaContainer = {
|
||||
type: [
|
||||
@@ -28,8 +28,6 @@ let value: GetRecentlyAddedLibraryMediaContainer = {
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: ActiveDirection.Ascending,
|
||||
defaultDirection: DefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetRecentlyAddedLibraryRequest, QueryParamIncludeMeta, QueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetRecentlyAddedLibraryRequest, QueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetRecentlyAddedLibraryRequest = {
|
||||
contentDirectoryID: 2,
|
||||
@@ -23,9 +23,6 @@ let value: GetRecentlyAddedLibraryRequest = {
|
||||
],
|
||||
sectionID: 2,
|
||||
type: QueryParamType.TvShow,
|
||||
includeMeta: QueryParamIncludeMeta.Enable,
|
||||
xPlexContainerStart: 0,
|
||||
xPlexContainerSize: 50,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ActiveDirection, DefaultDirection, GetRecentlyAddedLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetRecentlyAddedLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetRecentlyAddedLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
@@ -32,8 +32,6 @@ let value: GetRecentlyAddedLibraryResponse = {
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: ActiveDirection.Ascending,
|
||||
defaultDirection: DefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
|
||||
@@ -5,7 +5,7 @@ The recently added content
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ActiveDirection, DefaultDirection, GetRecentlyAddedLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetRecentlyAddedLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetRecentlyAddedLibraryResponseBody = {
|
||||
mediaContainer: {
|
||||
@@ -28,8 +28,6 @@ let value: GetRecentlyAddedLibraryResponseBody = {
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: ActiveDirection.Ascending,
|
||||
defaultDirection: DefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ActiveDirection, DefaultDirection, GetRecentlyAddedLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetRecentlyAddedLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetRecentlyAddedLibraryType = {
|
||||
key: "/library/sections/2/all?type=2",
|
||||
@@ -23,8 +23,6 @@ let value: GetRecentlyAddedLibraryType = {
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: ActiveDirection.Ascending,
|
||||
defaultDirection: DefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
|
||||
@@ -4,14 +4,12 @@
|
||||
|
||||
```typescript
|
||||
import {
|
||||
EnableCreditsMarkerGeneration,
|
||||
EpisodeSort,
|
||||
FlattenSeasons,
|
||||
GetRecentlyAddedActiveDirection,
|
||||
GetRecentlyAddedDefaultDirection,
|
||||
GetRecentlyAddedHubsResponseType,
|
||||
GetRecentlyAddedHubsType,
|
||||
GetRecentlyAddedMediaContainer,
|
||||
HasThumbnail,
|
||||
OptimizedForStreaming,
|
||||
ShowOrdering,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
@@ -19,6 +17,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
let value: GetRecentlyAddedMediaContainer = {
|
||||
size: 50,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
allowSync: false,
|
||||
meta: {
|
||||
type: [
|
||||
{
|
||||
@@ -39,8 +38,6 @@ let value: GetRecentlyAddedMediaContainer = {
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: GetRecentlyAddedActiveDirection.Ascending,
|
||||
defaultDirection: GetRecentlyAddedDefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
@@ -90,8 +87,11 @@ let value: GetRecentlyAddedMediaContainer = {
|
||||
year: 2022,
|
||||
seasonCount: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
flattenSeasons: FlattenSeasons.True,
|
||||
showOrdering: ShowOrdering.TvdbDvd,
|
||||
flattenSeasons: FlattenSeasons.Show,
|
||||
episodeSort: EpisodeSort.OldestFirst,
|
||||
enableCreditsMarkerGeneration:
|
||||
EnableCreditsMarkerGeneration.LibraryDefault,
|
||||
showOrdering: ShowOrdering.TvdbAbsolute,
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
banner: "/library/metadata/58683/banner/1703239236",
|
||||
@@ -129,7 +129,6 @@ let value: GetRecentlyAddedMediaContainer = {
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
optimizedForStreaming: OptimizedForStreaming.Enable,
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
@@ -145,7 +144,6 @@ let value: GetRecentlyAddedMediaContainer = {
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
hasThumbnail: HasThumbnail.True,
|
||||
stream: [
|
||||
{
|
||||
id: 272796,
|
||||
@@ -293,6 +291,6 @@ let value: GetRecentlyAddedMediaContainer = {
|
||||
| `offset` | *number* | :heavy_minus_sign: | N/A | |
|
||||
| `totalSize` | *number* | :heavy_minus_sign: | N/A | |
|
||||
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `meta` | [operations.Meta](../../../sdk/models/operations/meta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||
| `metadata` | [operations.GetRecentlyAddedMetadata](../../../sdk/models/operations/getrecentlyaddedmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -4,12 +4,12 @@
|
||||
|
||||
```typescript
|
||||
import {
|
||||
EnableCreditsMarkerGeneration,
|
||||
EpisodeSort,
|
||||
FlattenSeasons,
|
||||
GetRecentlyAddedHubsResponseType,
|
||||
GetRecentlyAddedHubsType,
|
||||
GetRecentlyAddedMetadata,
|
||||
HasThumbnail,
|
||||
OptimizedForStreaming,
|
||||
ShowOrdering,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
@@ -34,8 +34,10 @@ let value: GetRecentlyAddedMetadata = {
|
||||
year: 2022,
|
||||
seasonCount: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
flattenSeasons: FlattenSeasons.True,
|
||||
showOrdering: ShowOrdering.TvdbDvd,
|
||||
flattenSeasons: FlattenSeasons.Show,
|
||||
episodeSort: EpisodeSort.OldestFirst,
|
||||
enableCreditsMarkerGeneration: EnableCreditsMarkerGeneration.LibraryDefault,
|
||||
showOrdering: ShowOrdering.TvdbAbsolute,
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
banner: "/library/metadata/58683/banner/1703239236",
|
||||
@@ -73,7 +75,6 @@ let value: GetRecentlyAddedMetadata = {
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
optimizedForStreaming: OptimizedForStreaming.Enable,
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
@@ -89,7 +90,6 @@ let value: GetRecentlyAddedMetadata = {
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
hasThumbnail: HasThumbnail.True,
|
||||
stream: [
|
||||
{
|
||||
id: 272796,
|
||||
@@ -249,8 +249,10 @@ let value: GetRecentlyAddedMetadata = {
|
||||
| `year` | *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. |
|
||||
| `flattenSeasons` | [operations.FlattenSeasons](../../../sdk/models/operations/flattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `showOrdering` | [operations.ShowOrdering](../../../sdk/models/operations/showordering.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 |
|
||||
| `flattenSeasons` | [operations.FlattenSeasons](../../../sdk/models/operations/flattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
|
||||
| `episodeSort` | [operations.EpisodeSort](../../../sdk/models/operations/episodesort.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.EnableCreditsMarkerGeneration](../../../sdk/models/operations/enablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
||||
| `showOrdering` | [operations.ShowOrdering](../../../sdk/models/operations/showordering.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 |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||
|
||||
@@ -3,15 +3,12 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetRecentlyAddedRequest, IncludeMeta, Type } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetRecentlyAddedRequest, Type } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetRecentlyAddedRequest = {
|
||||
contentDirectoryID: 501324,
|
||||
sectionID: 2,
|
||||
type: Type.TvShow,
|
||||
includeMeta: IncludeMeta.Enable,
|
||||
xPlexContainerStart: 0,
|
||||
xPlexContainerSize: 50,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -4,14 +4,12 @@
|
||||
|
||||
```typescript
|
||||
import {
|
||||
EnableCreditsMarkerGeneration,
|
||||
EpisodeSort,
|
||||
FlattenSeasons,
|
||||
GetRecentlyAddedActiveDirection,
|
||||
GetRecentlyAddedDefaultDirection,
|
||||
GetRecentlyAddedHubsResponseType,
|
||||
GetRecentlyAddedHubsType,
|
||||
GetRecentlyAddedResponse,
|
||||
HasThumbnail,
|
||||
OptimizedForStreaming,
|
||||
ShowOrdering,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
@@ -26,6 +24,7 @@ let value: GetRecentlyAddedResponse = {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
allowSync: false,
|
||||
meta: {
|
||||
type: [
|
||||
{
|
||||
@@ -46,8 +45,6 @@ let value: GetRecentlyAddedResponse = {
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: GetRecentlyAddedActiveDirection.Ascending,
|
||||
defaultDirection: GetRecentlyAddedDefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
@@ -97,8 +94,11 @@ let value: GetRecentlyAddedResponse = {
|
||||
year: 2022,
|
||||
seasonCount: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
flattenSeasons: FlattenSeasons.True,
|
||||
showOrdering: ShowOrdering.TvdbDvd,
|
||||
flattenSeasons: FlattenSeasons.Show,
|
||||
episodeSort: EpisodeSort.OldestFirst,
|
||||
enableCreditsMarkerGeneration:
|
||||
EnableCreditsMarkerGeneration.LibraryDefault,
|
||||
showOrdering: ShowOrdering.TvdbAbsolute,
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
banner: "/library/metadata/58683/banner/1703239236",
|
||||
@@ -136,7 +136,6 @@ let value: GetRecentlyAddedResponse = {
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
optimizedForStreaming: OptimizedForStreaming.Enable,
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
@@ -152,7 +151,6 @@ let value: GetRecentlyAddedResponse = {
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
hasThumbnail: HasThumbnail.True,
|
||||
stream: [
|
||||
{
|
||||
id: 272796,
|
||||
|
||||
@@ -6,14 +6,12 @@ A successful response with recently added content.
|
||||
|
||||
```typescript
|
||||
import {
|
||||
EnableCreditsMarkerGeneration,
|
||||
EpisodeSort,
|
||||
FlattenSeasons,
|
||||
GetRecentlyAddedActiveDirection,
|
||||
GetRecentlyAddedDefaultDirection,
|
||||
GetRecentlyAddedHubsResponseType,
|
||||
GetRecentlyAddedHubsType,
|
||||
GetRecentlyAddedResponseBody,
|
||||
HasThumbnail,
|
||||
OptimizedForStreaming,
|
||||
ShowOrdering,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
@@ -22,6 +20,7 @@ let value: GetRecentlyAddedResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
allowSync: false,
|
||||
meta: {
|
||||
type: [
|
||||
{
|
||||
@@ -42,8 +41,6 @@ let value: GetRecentlyAddedResponseBody = {
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: GetRecentlyAddedActiveDirection.Ascending,
|
||||
defaultDirection: GetRecentlyAddedDefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
@@ -93,8 +90,11 @@ let value: GetRecentlyAddedResponseBody = {
|
||||
year: 2022,
|
||||
seasonCount: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
flattenSeasons: FlattenSeasons.True,
|
||||
showOrdering: ShowOrdering.TvdbDvd,
|
||||
flattenSeasons: FlattenSeasons.Show,
|
||||
episodeSort: EpisodeSort.OldestFirst,
|
||||
enableCreditsMarkerGeneration:
|
||||
EnableCreditsMarkerGeneration.LibraryDefault,
|
||||
showOrdering: ShowOrdering.TvdbAbsolute,
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
banner: "/library/metadata/58683/banner/1703239236",
|
||||
@@ -132,7 +132,6 @@ let value: GetRecentlyAddedResponseBody = {
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
optimizedForStreaming: OptimizedForStreaming.Enable,
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
@@ -148,7 +147,6 @@ let value: GetRecentlyAddedResponseBody = {
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
hasThumbnail: HasThumbnail.True,
|
||||
stream: [
|
||||
{
|
||||
id: 272796,
|
||||
|
||||
@@ -3,17 +3,11 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetRecentlyAddedActiveDirection,
|
||||
GetRecentlyAddedDefaultDirection,
|
||||
GetRecentlyAddedSort,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetRecentlyAddedSort } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetRecentlyAddedSort = {
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: GetRecentlyAddedActiveDirection.Ascending,
|
||||
defaultDirection: GetRecentlyAddedDefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
|
||||
@@ -3,11 +3,7 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetRecentlyAddedActiveDirection,
|
||||
GetRecentlyAddedDefaultDirection,
|
||||
GetRecentlyAddedType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetRecentlyAddedType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetRecentlyAddedType = {
|
||||
key: "/library/sections/2/all?type=2",
|
||||
@@ -27,8 +23,6 @@ let value: GetRecentlyAddedType = {
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
activeDirection: GetRecentlyAddedActiveDirection.Ascending,
|
||||
defaultDirection: GetRecentlyAddedDefaultDirection.Ascending,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetResourcesStatisticsResponse } from "@lukehagar/plexjs/sdk/models/ope
|
||||
|
||||
let value: GetResourcesStatisticsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 301,
|
||||
statusCode: 226,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user