mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 20:47:46 +00:00
Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1cfbd17f28 | ||
|
|
2492807c65 | ||
|
|
ead0a8773c | ||
|
|
e254f82e06 | ||
|
|
a4369c999a | ||
|
|
c50b85f29a | ||
|
|
496ebda695 | ||
|
|
d436fc3452 |
File diff suppressed because one or more lines are too long
@@ -12,7 +12,7 @@ generation:
|
|||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
typescript:
|
typescript:
|
||||||
version: 0.23.2
|
version: 0.24.2
|
||||||
additionalDependencies:
|
additionalDependencies:
|
||||||
dependencies: {}
|
dependencies: {}
|
||||||
devDependencies: {}
|
devDependencies: {}
|
||||||
|
|||||||
@@ -1,35 +1,42 @@
|
|||||||
speakeasyVersion: 1.396.9
|
speakeasyVersion: 1.405.6
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
sourceRevisionDigest: sha256:6b8ecb85ac3892ce1c244c57469baf7d67f0cd87ca24a33ab403fb7863b00fe4
|
sourceRevisionDigest: sha256:1b8840d540c66b58d1009ec2581fb18464158ec9aa00464eac05ba737f31207e
|
||||||
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- main
|
- main
|
||||||
|
plexapi:
|
||||||
|
sourceNamespace: plexapi
|
||||||
|
sourceRevisionDigest: sha256:b1e231bd781f352738612b0158382ba51cfac32e97c23d9e4913aab5501e9529
|
||||||
|
sourceBlobDigest: sha256:8ce05d5965182eb3fe9376715c269b9e1c7f3e2d90273c175a4181735f41daa0
|
||||||
|
tags:
|
||||||
|
- latest
|
||||||
|
- main
|
||||||
targets:
|
targets:
|
||||||
plexjs:
|
plexjs:
|
||||||
source: my-source
|
source: plexapi
|
||||||
sourceNamespace: my-source
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:6b8ecb85ac3892ce1c244c57469baf7d67f0cd87ca24a33ab403fb7863b00fe4
|
sourceRevisionDigest: sha256:b1e231bd781f352738612b0158382ba51cfac32e97c23d9e4913aab5501e9529
|
||||||
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
sourceBlobDigest: sha256:8ce05d5965182eb3fe9376715c269b9e1c7f3e2d90273c175a4181735f41daa0
|
||||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||||
codeSamplesRevisionDigest: sha256:0c82ded636bcd505d908a4476e714e61d5dad67440751aa4d5e3f08be1d1beff
|
codeSamplesRevisionDigest: sha256:ca55aa5571fbfbfc191350456c0d8c4e08f1ceb5444f96b41617536651323250
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
plexapi:
|
||||||
inputs:
|
inputs:
|
||||||
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main
|
- location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main
|
||||||
targets:
|
targets:
|
||||||
plexjs:
|
plexjs:
|
||||||
target: typescript
|
target: typescript
|
||||||
source: my-source
|
source: plexapi
|
||||||
publish:
|
publish:
|
||||||
npm:
|
npm:
|
||||||
token: $npm_token
|
token: $npm_token
|
||||||
codeSamples:
|
codeSamples:
|
||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-typescript-plexjs
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||||
|
|||||||
@@ -1,17 +1,17 @@
|
|||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
plexapi:
|
||||||
inputs:
|
inputs:
|
||||||
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main
|
- location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main
|
||||||
targets:
|
targets:
|
||||||
plexjs:
|
plexjs:
|
||||||
target: typescript
|
target: typescript
|
||||||
source: my-source
|
source: plexapi
|
||||||
publish:
|
publish:
|
||||||
npm:
|
npm:
|
||||||
token: $npm_token
|
token: $npm_token
|
||||||
codeSamples:
|
codeSamples:
|
||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-typescript-plexjs
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||||
|
|||||||
@@ -27,7 +27,11 @@ import { SDKValidationError } from "@lukehagar/plexjs/sdk/models/errors/sdkvalid
|
|||||||
// You can create one instance of it to use across an application.
|
// You can create one instance of it to use across an application.
|
||||||
const plexAPI = new PlexAPICore({
|
const plexAPI = new PlexAPICore({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
@@ -53,7 +57,7 @@ async function run() {
|
|||||||
const { value: result } = res;
|
const { value: result } = res;
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result);
|
||||||
}
|
}
|
||||||
|
|
||||||
run();
|
run();
|
||||||
|
|||||||
157
README.md
157
README.md
@@ -11,6 +11,31 @@
|
|||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
||||||
|
|
||||||
|
# Plex Media Server OpenAPI Specification
|
||||||
|
|
||||||
|
An Open Source OpenAPI Specification for Plex Media Server
|
||||||
|
|
||||||
|
Automation and SDKs provided by [Speakeasy](https://speakeasyapi.dev/)
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
[API Documentation](https://plexapi.dev)
|
||||||
|
|
||||||
|
## SDKs
|
||||||
|
|
||||||
|
The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the [main specification Repository](https://github.com/LukeHagar/plex-api-spec).
|
||||||
|
|
||||||
|
| Language | Repository | Releases | Other |
|
||||||
|
| --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
|
||||||
|
| Python | [GitHub](https://github.com/LukeHagar/plexpy) | [PyPI](https://pypi.org/project/plex-api-client/) | - |
|
||||||
|
| JavaScript/TypeScript | [GitHub](https://github.com/LukeHagar/plexjs) | [NPM](https://www.npmjs.com/package/@lukehagar/plexjs) \ [JSR](https://jsr.io/@lukehagar/plexjs) | - |
|
||||||
|
| Go | [GitHub](https://github.com/LukeHagar/plexgo) | [Releases](https://github.com/LukeHagar/plexgo/releases) | [GoDoc](https://pkg.go.dev/github.com/LukeHagar/plexgo) |
|
||||||
|
| Ruby | [GitHub](https://github.com/LukeHagar/plexruby) | [Releases](https://github.com/LukeHagar/plexruby/releases) | - |
|
||||||
|
| Swift | [GitHub](https://github.com/LukeHagar/plexswift) | [Releases](https://github.com/LukeHagar/plexswift/releases) | - |
|
||||||
|
| PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - |
|
||||||
|
| Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - |
|
||||||
|
| C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -
|
||||||
<!-- End Summary [summary] -->
|
<!-- End Summary [summary] -->
|
||||||
|
|
||||||
<!-- Start Table of Contents [toc] -->
|
<!-- Start Table of Contents [toc] -->
|
||||||
@@ -21,7 +46,6 @@ Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
|||||||
* [SDK Example Usage](#sdk-example-usage)
|
* [SDK Example Usage](#sdk-example-usage)
|
||||||
* [Available Resources and Operations](#available-resources-and-operations)
|
* [Available Resources and Operations](#available-resources-and-operations)
|
||||||
* [Standalone functions](#standalone-functions)
|
* [Standalone functions](#standalone-functions)
|
||||||
* [Global Parameters](#global-parameters)
|
|
||||||
* [Retries](#retries)
|
* [Retries](#retries)
|
||||||
* [Error Handling](#error-handling)
|
* [Error Handling](#error-handling)
|
||||||
* [Server Selection](#server-selection)
|
* [Server Selection](#server-selection)
|
||||||
@@ -73,7 +97,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
|||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
@@ -117,12 +145,13 @@ run();
|
|||||||
### [hubs](docs/sdks/hubs/README.md)
|
### [hubs](docs/sdks/hubs/README.md)
|
||||||
|
|
||||||
* [getGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
|
* [getGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
|
||||||
|
* [getRecentlyAdded](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
|
||||||
* [getLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
* [getLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
||||||
|
|
||||||
### [library](docs/sdks/library/README.md)
|
### [library](docs/sdks/library/README.md)
|
||||||
|
|
||||||
* [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
* [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||||
* [getRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded) - Get Recently Added
|
* [getRecentlyAddedLibrary](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
|
||||||
* [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
* [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
||||||
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||||
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||||
@@ -223,16 +252,25 @@ run();
|
|||||||
<!-- Start Error Handling [errors] -->
|
<!-- Start Error Handling [errors] -->
|
||||||
## Error Handling
|
## Error Handling
|
||||||
|
|
||||||
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
|
All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`.
|
||||||
|
|
||||||
| Error Object | Status Code | Content Type |
|
If a HTTP request fails, an operation my also throw an error from the `sdk/models/errors/httpclienterrors.ts` module:
|
||||||
|
|
||||||
|
| HTTP Client Error | Description |
|
||||||
|
| ---------------------------------------------------- | ---------------------------------------------------- |
|
||||||
|
| RequestAbortedError | HTTP request was aborted by the client |
|
||||||
|
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
|
||||||
|
| ConnectionError | HTTP client was unable to make a request to a server |
|
||||||
|
| InvalidRequestError | Any input used to create a request is invalid |
|
||||||
|
| UnexpectedClientError | Unrecognised or unexpected error |
|
||||||
|
|
||||||
|
In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `getServerCapabilities` method may throw the following errors:
|
||||||
|
|
||||||
|
| Error Type | Status Code | Content Type |
|
||||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||||
| errors.GetServerCapabilitiesBadRequest | 400 | application/json |
|
| errors.GetServerCapabilitiesBadRequest | 400 | application/json |
|
||||||
| errors.GetServerCapabilitiesUnauthorized | 401 | application/json |
|
| errors.GetServerCapabilitiesUnauthorized | 401 | application/json |
|
||||||
| errors.SDKError | 4xx-5xx | */* |
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
||||||
|
|
||||||
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
|
|
||||||
|
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
@@ -244,7 +282,11 @@ import {
|
|||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
@@ -283,6 +325,8 @@ async function run() {
|
|||||||
run();
|
run();
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
|
||||||
<!-- End Error Handling [errors] -->
|
<!-- End Error Handling [errors] -->
|
||||||
|
|
||||||
<!-- Start Server Selection [server] -->
|
<!-- Start Server Selection [server] -->
|
||||||
@@ -302,7 +346,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
|||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
serverIdx: 0,
|
serverIdx: 0,
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
@@ -333,7 +381,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
|||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
serverURL: "{protocol}://{ip}:{port}",
|
serverURL: "{protocol}://{ip}:{port}",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
@@ -355,12 +407,16 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
|||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.plex.getCompanionsData({
|
const result = await plexAPI.plex.getCompanionsData({
|
||||||
serverURL: "https://plex.tv/api/v2/",
|
serverURL: "https://plex.tv/api/v2",
|
||||||
});
|
});
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
@@ -438,7 +494,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
|||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
@@ -487,6 +547,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|||||||
- [butlerStopTask](docs/sdks/butler/README.md#stoptask)
|
- [butlerStopTask](docs/sdks/butler/README.md#stoptask)
|
||||||
- [hubsGetGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs)
|
- [hubsGetGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs)
|
||||||
- [hubsGetLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs)
|
- [hubsGetLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs)
|
||||||
|
- [hubsGetRecentlyAdded](docs/sdks/hubs/README.md#getrecentlyadded)
|
||||||
- [libraryDeleteLibrary](docs/sdks/library/README.md#deletelibrary)
|
- [libraryDeleteLibrary](docs/sdks/library/README.md#deletelibrary)
|
||||||
- [libraryGetAllLibraries](docs/sdks/library/README.md#getalllibraries)
|
- [libraryGetAllLibraries](docs/sdks/library/README.md#getalllibraries)
|
||||||
- [libraryGetFileHash](docs/sdks/library/README.md#getfilehash)
|
- [libraryGetFileHash](docs/sdks/library/README.md#getfilehash)
|
||||||
@@ -495,7 +556,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|||||||
- [libraryGetMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey)
|
- [libraryGetMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey)
|
||||||
- [libraryGetMetadataChildren](docs/sdks/library/README.md#getmetadatachildren)
|
- [libraryGetMetadataChildren](docs/sdks/library/README.md#getmetadatachildren)
|
||||||
- [libraryGetOnDeck](docs/sdks/library/README.md#getondeck)
|
- [libraryGetOnDeck](docs/sdks/library/README.md#getondeck)
|
||||||
- [libraryGetRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded)
|
- [libraryGetRecentlyAddedLibrary](docs/sdks/library/README.md#getrecentlyaddedlibrary)
|
||||||
- [libraryGetRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata)
|
- [libraryGetRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata)
|
||||||
- [libraryGetSearchLibrary](docs/sdks/library/README.md#getsearchlibrary)
|
- [libraryGetSearchLibrary](docs/sdks/library/README.md#getsearchlibrary)
|
||||||
- [libraryGetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent)
|
- [libraryGetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent)
|
||||||
@@ -553,58 +614,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|||||||
</details>
|
</details>
|
||||||
<!-- End Standalone functions [standalone-funcs] -->
|
<!-- End Standalone functions [standalone-funcs] -->
|
||||||
|
|
||||||
<!-- Start Global Parameters [global-parameters] -->
|
|
||||||
## Global Parameters
|
|
||||||
|
|
||||||
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
|
|
||||||
|
|
||||||
For example, you can set `X-Plex-Client-Identifier` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getServerResources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
|
||||||
|
|
||||||
|
|
||||||
### Available Globals
|
|
||||||
|
|
||||||
The following global parameter is available.
|
|
||||||
|
|
||||||
| Name | Type | Required | Description |
|
|
||||||
| ---- | ---- |:--------:| ----------- |
|
|
||||||
| xPlexClientIdentifier | string | | The unique identifier for the client application
|
|
||||||
This is used to track the client application and its usage
|
|
||||||
(UUID, serial number, or other number unique per device)
|
|
||||||
|
|
|
||||||
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
|
||||||
import {
|
|
||||||
IncludeHttps,
|
|
||||||
IncludeIPv6,
|
|
||||||
IncludeRelay,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
|
||||||
});
|
|
||||||
|
|
||||||
async function run() {
|
|
||||||
const result = await plexAPI.plex.getServerResources(
|
|
||||||
"gcgzw5rz2xovp84b4vha3a40",
|
|
||||||
IncludeHttps.One,
|
|
||||||
IncludeRelay.One,
|
|
||||||
IncludeIPv6.One,
|
|
||||||
);
|
|
||||||
|
|
||||||
// Handle the result
|
|
||||||
console.log(result);
|
|
||||||
}
|
|
||||||
|
|
||||||
run();
|
|
||||||
|
|
||||||
```
|
|
||||||
<!-- End Global Parameters [global-parameters] -->
|
|
||||||
|
|
||||||
<!-- Start Retries [retries] -->
|
<!-- Start Retries [retries] -->
|
||||||
## Retries
|
## Retries
|
||||||
|
|
||||||
@@ -616,7 +625,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
|||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
@@ -657,7 +670,11 @@ const plexAPI = new PlexAPI({
|
|||||||
retryConnectionErrors: false,
|
retryConnectionErrors: false,
|
||||||
},
|
},
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
|
|||||||
60
RELEASES.md
60
RELEASES.md
@@ -1039,3 +1039,63 @@ Based on:
|
|||||||
- [typescript v0.23.2] .
|
- [typescript v0.23.2] .
|
||||||
### Releases
|
### Releases
|
||||||
- [NPM v0.23.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.2 - .
|
- [NPM v0.23.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.2 - .
|
||||||
|
|
||||||
|
## 2024-09-16 00:09:42
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.396.9 (2.415.7) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.23.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.23.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.3 - .
|
||||||
|
|
||||||
|
## 2024-09-16 17:59:12
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.397.2 (2.415.8) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.23.4] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.23.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.4 - .
|
||||||
|
|
||||||
|
## 2024-09-17 00:08:25
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.398.0 (2.415.8) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.23.5] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.23.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.5 - .
|
||||||
|
|
||||||
|
## 2024-10-01 00:10:47
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.24.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.24.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.0 - .
|
||||||
|
|
||||||
|
## 2024-10-01 15:35:33
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.24.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.24.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.1 - .
|
||||||
|
|
||||||
|
## 2024-10-02 02:28:25
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.24.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.24.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.2 - .
|
||||||
6
USAGE.md
6
USAGE.md
@@ -4,7 +4,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
|||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
|
|||||||
1706
codeSamples.yaml
1706
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
@@ -1,18 +0,0 @@
|
|||||||
# GetRecentlyAddedBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetRecentlyAddedBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetRecentlyAddedErrors](../../../sdk/models/errors/getrecentlyaddederrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
# GetRecentlyAddedErrors
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetRecentlyAddedErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
let value: GetRecentlyAddedErrors = {
|
|
||||||
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 |
|
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetRecentlyAddedUnauthorized
|
# GetRecentlyAddedLibraryBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetRecentlyAddedUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetRecentlyAddedLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
// No examples available for this model
|
// No examples available for this model
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { GetRecentlyAddedLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetRecentlyAddedLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetRecentlyAddedLibraryErrors = {
|
let value: GetRecentlyAddedLibraryErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
# GetRecentlyAddedLibraryLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetRecentlyAddedLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetRecentlyAddedLibraryLibraryErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
# GetRecentlyAddedLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetRecentlyAddedLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetRecentlyAddedLibraryLibraryErrors](../../../sdk/models/errors/getrecentlyaddedlibrarylibraryerrors.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 |
|
||||||
19
docs/sdk/models/operations/action.md
Normal file
19
docs/sdk/models/operations/action.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# Action
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Action } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: Action = {
|
||||||
|
id: "addToContinueWatching",
|
||||||
|
key: "/actions/addToContinueWatching",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||||
|
| `id` | *string* | :heavy_check_mark: | N/A | addToContinueWatching |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | N/A | /actions/addToContinueWatching |
|
||||||
19
docs/sdk/models/operations/activedirection.md
Normal file
19
docs/sdk/models/operations/activedirection.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# ActiveDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ActiveDirection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: ActiveDirection = ActiveDirection.Ascending;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
@@ -6,7 +6,7 @@
|
|||||||
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: AddPlaylistContentsRequest = {
|
let value: AddPlaylistContentsRequest = {
|
||||||
playlistID: 8209.94,
|
playlistID: 8966.71,
|
||||||
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
||||||
playQueueID: 123,
|
playQueueID: 123,
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { AddPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operat
|
|||||||
|
|
||||||
let value: AddPlaylistContentsResponse = {
|
let value: AddPlaylistContentsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 13571,
|
statusCode: 502,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { ApplyUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: ApplyUpdatesResponse = {
|
let value: ApplyUpdatesResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 667411,
|
statusCode: 102,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,12 +7,12 @@ The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign aud
|
|||||||
```typescript
|
```typescript
|
||||||
import { AutoSelectSubtitle } from "@lukehagar/plexjs/sdk/models/operations";
|
import { AutoSelectSubtitle } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: AutoSelectSubtitle = AutoSelectSubtitle.One;
|
let value: AutoSelectSubtitle = AutoSelectSubtitle.Enable;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| ------ | ------ |
|
| --------- | --------- |
|
||||||
| `Zero` | 0 |
|
| `Disable` | 0 |
|
||||||
| `One` | 1 |
|
| `Enable` | 1 |
|
||||||
@@ -7,7 +7,7 @@ import { Billing } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: Billing = {
|
let value: Billing = {
|
||||||
internalPaymentMethod: {},
|
internalPaymentMethod: {},
|
||||||
paymentMethodId: 414263,
|
paymentMethodId: 730856,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { CancelServerActivitiesResponse } from "@lukehagar/plexjs/sdk/models/ope
|
|||||||
|
|
||||||
let value: CancelServerActivitiesResponse = {
|
let value: CancelServerActivitiesResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 812169,
|
statusCode: 417,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { CheckForUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations
|
|||||||
|
|
||||||
let value: CheckForUpdatesResponse = {
|
let value: CheckForUpdatesResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 9356,
|
statusCode: 429,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: ClearPlaylistContentsRequest = {
|
let value: ClearPlaylistContentsRequest = {
|
||||||
playlistID: 3687.25,
|
playlistID: 6793.93,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { ClearPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/oper
|
|||||||
|
|
||||||
let value: ClearPlaylistContentsResponse = {
|
let value: ClearPlaylistContentsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 662527,
|
statusCode: 304,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
17
docs/sdk/models/operations/collection.md
Normal file
17
docs/sdk/models/operations/collection.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# Collection
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Collection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: Collection = {
|
||||||
|
tag: "Working NL Subs",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `tag` | *string* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||||
@@ -3,13 +3,13 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { Connections } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Connections, Protocol } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: Connections = {
|
let value: Connections = {
|
||||||
protocol: "<value>",
|
protocol: Protocol.Http,
|
||||||
address: "718 Wolff Light",
|
address: "21611 Schuster Cliffs",
|
||||||
port: 7991.59,
|
port: 54915,
|
||||||
uri: "https://jumbo-lobotomy.net",
|
uri: "https://wobbly-instance.org/",
|
||||||
local: false,
|
local: false,
|
||||||
relay: false,
|
relay: false,
|
||||||
iPv6: false,
|
iPv6: false,
|
||||||
@@ -18,12 +18,12 @@ let value: Connections = {
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||||
| `protocol` | *string* | :heavy_check_mark: | N/A |
|
| `protocol` | [operations.Protocol](../../../sdk/models/operations/protocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) | http |
|
||||||
| `address` | *string* | :heavy_check_mark: | N/A |
|
| `address` | *string* | :heavy_check_mark: | The (ip) address or domain name used for the connection | |
|
||||||
| `port` | *number* | :heavy_check_mark: | N/A |
|
| `port` | *number* | :heavy_check_mark: | The port used for the connection | |
|
||||||
| `uri` | *string* | :heavy_check_mark: | N/A |
|
| `uri` | *string* | :heavy_check_mark: | The full URI of the connection | |
|
||||||
| `local` | *boolean* | :heavy_check_mark: | N/A |
|
| `local` | *boolean* | :heavy_check_mark: | If the connection is local address | |
|
||||||
| `relay` | *boolean* | :heavy_check_mark: | N/A |
|
| `relay` | *boolean* | :heavy_check_mark: | If the connection is relayed through plex.direct | |
|
||||||
| `iPv6` | *boolean* | :heavy_check_mark: | N/A |
|
| `iPv6` | *boolean* | :heavy_check_mark: | If the connection is using IPv6 | |
|
||||||
@@ -8,8 +8,8 @@ import { CreatePlaylistQueryParamType, CreatePlaylistRequest, Smart } from "@luk
|
|||||||
let value: CreatePlaylistRequest = {
|
let value: CreatePlaylistRequest = {
|
||||||
title: "<value>",
|
title: "<value>",
|
||||||
type: CreatePlaylistQueryParamType.Video,
|
type: CreatePlaylistQueryParamType.Video,
|
||||||
smart: Smart.One,
|
smart: Smart.Zero,
|
||||||
uri: "http://immediate-instructor.info",
|
uri: "https://pleased-lox.name",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { CreatePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
|||||||
|
|
||||||
let value: CreatePlaylistResponse = {
|
let value: CreatePlaylistResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 244425,
|
statusCode: 409,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
19
docs/sdk/models/operations/defaultdirection.md
Normal file
19
docs/sdk/models/operations/defaultdirection.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# DefaultDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DefaultDirection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: DefaultDirection = DefaultDirection.Ascending;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
@@ -1,18 +1,18 @@
|
|||||||
# DefaultSubtitleAccessibility
|
# DefaultSubtitleAccessibility
|
||||||
|
|
||||||
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles)
|
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only show non-SDH subtitles)
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { DefaultSubtitleAccessibility } from "@lukehagar/plexjs/sdk/models/operations";
|
import { DefaultSubtitleAccessibility } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: DefaultSubtitleAccessibility = DefaultSubtitleAccessibility.One;
|
let value: DefaultSubtitleAccessibility = DefaultSubtitleAccessibility.Enable;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| ------ | ------ |
|
| --------- | --------- |
|
||||||
| `Zero` | 0 |
|
| `Disable` | 0 |
|
||||||
| `One` | 1 |
|
| `Enable` | 1 |
|
||||||
@@ -7,12 +7,12 @@ The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer
|
|||||||
```typescript
|
```typescript
|
||||||
import { DefaultSubtitleForced } from "@lukehagar/plexjs/sdk/models/operations";
|
import { DefaultSubtitleForced } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: DefaultSubtitleForced = DefaultSubtitleForced.Zero;
|
let value: DefaultSubtitleForced = DefaultSubtitleForced.Enable;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| ------ | ------ |
|
| --------- | --------- |
|
||||||
| `Zero` | 0 |
|
| `Disable` | 0 |
|
||||||
| `One` | 1 |
|
| `Enable` | 1 |
|
||||||
@@ -7,7 +7,7 @@ import { DeleteLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: DeleteLibraryResponse = {
|
let value: DeleteLibraryResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 99280,
|
statusCode: 507,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: DeletePlaylistRequest = {
|
let value: DeletePlaylistRequest = {
|
||||||
playlistID: 6563.3,
|
playlistID: 2543.56,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { DeletePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
|||||||
|
|
||||||
let value: DeletePlaylistResponse = {
|
let value: DeletePlaylistResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 317202,
|
statusCode: 101,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
import { Director } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Director } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: Director = {
|
let value: Director = {
|
||||||
tag: "Peyton Reed",
|
tag: "James Cameron",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -14,4 +14,4 @@ let value: Director = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Peyton Reed |
|
| `tag` | *string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||||
@@ -7,7 +7,7 @@ import { EnablePaperTrailResponse } from "@lukehagar/plexjs/sdk/models/operation
|
|||||||
|
|
||||||
let value: EnablePaperTrailResponse = {
|
let value: EnablePaperTrailResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 635059,
|
statusCode: 400,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -5,13 +5,28 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { Feature } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Feature } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: Feature = {};
|
let value: Feature = {
|
||||||
|
type: "<value>",
|
||||||
|
flavor: "global",
|
||||||
|
scrobbleKey: "/:/scrobble/new",
|
||||||
|
unscrobbleKey: "/:/unscrobble/new",
|
||||||
|
action: [
|
||||||
|
{
|
||||||
|
id: "addToContinueWatching",
|
||||||
|
key: "/actions/addToContinueWatching",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||||
| `key` | *string* | :heavy_minus_sign: | N/A |
|
| `key` | *string* | :heavy_minus_sign: | N/A | |
|
||||||
| `type` | *string* | :heavy_minus_sign: | N/A |
|
| `type` | *string* | :heavy_check_mark: | N/A | |
|
||||||
| `directory` | [operations.GetMediaProvidersDirectory](../../../sdk/models/operations/getmediaprovidersdirectory.md)[] | :heavy_minus_sign: | N/A |
|
| `flavor` | *string* | :heavy_minus_sign: | N/A | global |
|
||||||
|
| `scrobbleKey` | *string* | :heavy_minus_sign: | N/A | /:/scrobble/new |
|
||||||
|
| `unscrobbleKey` | *string* | :heavy_minus_sign: | N/A | /:/unscrobble/new |
|
||||||
|
| `directory` | [operations.GetMediaProvidersDirectory](../../../sdk/models/operations/getmediaprovidersdirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `action` | [operations.Action](../../../sdk/models/operations/action.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
@@ -5,11 +5,13 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { Features } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Features } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: Features = Features.LiveTvSupportIncompleteSegments;
|
let value: Features = Features.Trailers;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
|
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------------------------------------- | --------------------------------------- |
|
| --------------------------------------- | --------------------------------------- |
|
||||||
| `AndroidDolbyVision` | Android - Dolby Vision |
|
| `AndroidDolbyVision` | Android - Dolby Vision |
|
||||||
@@ -19,28 +21,43 @@ let value: Features = Features.LiveTvSupportIncompleteSegments;
|
|||||||
| `TREBLEShowFeatures` | TREBLE-show-features |
|
| `TREBLEShowFeatures` | TREBLE-show-features |
|
||||||
| `AdCountdownTimer` | ad-countdown-timer |
|
| `AdCountdownTimer` | ad-countdown-timer |
|
||||||
| `AdaptiveBitrate` | adaptive_bitrate |
|
| `AdaptiveBitrate` | adaptive_bitrate |
|
||||||
|
| `AlbumTypes` | album-types |
|
||||||
|
| `AllowDvr` | allow_dvr |
|
||||||
| `AmazonLoopDebug` | amazon-loop-debug |
|
| `AmazonLoopDebug` | amazon-loop-debug |
|
||||||
| `AvodAdAnalysis` | avod-ad-analysis |
|
| `AvodAdAnalysis` | avod-ad-analysis |
|
||||||
| `AvodNewMedia` | avod-new-media |
|
| `AvodNewMedia` | avod-new-media |
|
||||||
| `BlacklistGetSignin` | blacklist_get_signin |
|
| `BlacklistGetSignin` | blacklist_get_signin |
|
||||||
|
| `BoostVoices` | boost-voices |
|
||||||
|
| `CameraUpload` | camera_upload |
|
||||||
| `ClientRadioStations` | client-radio-stations |
|
| `ClientRadioStations` | client-radio-stations |
|
||||||
| `CloudflareTurnstileRequired` | cloudflare-turnstile-required |
|
| `CloudflareTurnstileRequired` | cloudflare-turnstile-required |
|
||||||
|
| `Cloudsync` | cloudsync |
|
||||||
| `Collections` | collections |
|
| `Collections` | collections |
|
||||||
| `CommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications |
|
| `CommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications |
|
||||||
| `CommunityAccessPlexTv` | community_access_plex_tv |
|
| `CommunityAccessPlexTv` | community_access_plex_tv |
|
||||||
| `CompanionsSonos` | companions_sonos |
|
| `CompanionsSonos` | companions_sonos |
|
||||||
|
| `ContentFilter` | content_filter |
|
||||||
| `CustomHomeRemoval` | custom-home-removal |
|
| `CustomHomeRemoval` | custom-home-removal |
|
||||||
| `DisableHomeUserFriendships` | disable_home_user_friendships |
|
| `DisableHomeUserFriendships` | disable_home_user_friendships |
|
||||||
| `DisableSharingFriendships` | disable_sharing_friendships |
|
| `DisableSharingFriendships` | disable_sharing_friendships |
|
||||||
|
| `DownloadsGating` | downloads-gating |
|
||||||
| `DrmSupport` | drm_support |
|
| `DrmSupport` | drm_support |
|
||||||
|
| `Dvr` | dvr |
|
||||||
|
| `DvrBlockUnsupportedCountries` | dvr-block-unsupported-countries |
|
||||||
|
| `EpgRecentChannels` | epg-recent-channels |
|
||||||
| `ExcludeRestrictions` | exclude restrictions |
|
| `ExcludeRestrictions` | exclude restrictions |
|
||||||
| `FederatedAuth` | federated-auth |
|
| `FederatedAuth` | federated-auth |
|
||||||
| `FriendRequestPushNotifications` | friend_request_push_notifications |
|
| `FriendRequestPushNotifications` | friend_request_push_notifications |
|
||||||
|
| `GrandfatherSync` | grandfather-sync |
|
||||||
| `GuidedUpgrade` | guided-upgrade |
|
| `GuidedUpgrade` | guided-upgrade |
|
||||||
|
| `HardwareTranscoding` | hardware_transcoding |
|
||||||
| `Home` | home |
|
| `Home` | home |
|
||||||
|
| `Hwtranscode` | hwtranscode |
|
||||||
|
| `ImaggaV2` | imagga-v2 |
|
||||||
| `IncreasePasswordComplexity` | increase-password-complexity |
|
| `IncreasePasswordComplexity` | increase-password-complexity |
|
||||||
| `Ios14PrivacyBanner` | ios14-privacy-banner |
|
| `Ios14PrivacyBanner` | ios14-privacy-banner |
|
||||||
| `IterableNotificationTokens` | iterable-notification-tokens |
|
| `IterableNotificationTokens` | iterable-notification-tokens |
|
||||||
|
| `ItemClusters` | item_clusters |
|
||||||
| `KeepPaymentMethod` | keep-payment-method |
|
| `KeepPaymentMethod` | keep-payment-method |
|
||||||
| `KevinBacon` | kevin-bacon |
|
| `KevinBacon` | kevin-bacon |
|
||||||
| `KoreaConsent` | korea-consent |
|
| `KoreaConsent` | korea-consent |
|
||||||
@@ -49,25 +66,47 @@ let value: Features = Features.LiveTvSupportIncompleteSegments;
|
|||||||
| `LightningDvrPivot` | lightning-dvr-pivot |
|
| `LightningDvrPivot` | lightning-dvr-pivot |
|
||||||
| `LiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments |
|
| `LiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments |
|
||||||
| `Livetv` | livetv |
|
| `Livetv` | livetv |
|
||||||
|
| `Lyrics` | lyrics |
|
||||||
| `MetadataSearch` | metadata_search |
|
| `MetadataSearch` | metadata_search |
|
||||||
|
| `MusicAnalysis` | music-analysis |
|
||||||
|
| `MusicVideos` | music_videos |
|
||||||
| `NewPlexPassPrices` | new_plex_pass_prices |
|
| `NewPlexPassPrices` | new_plex_pass_prices |
|
||||||
| `NewsProviderSunsetModal` | news-provider-sunset-modal |
|
| `NewsProviderSunsetModal` | news-provider-sunset-modal |
|
||||||
|
| `Nominatim` | nominatim |
|
||||||
|
| `Pass` | pass |
|
||||||
| `PhotosFavorites` | photos-favorites |
|
| `PhotosFavorites` | photos-favorites |
|
||||||
| `PhotosMetadataEdition` | photos-metadata-edition |
|
| `PhotosMetadataEdition` | photos-metadata-edition |
|
||||||
|
| `PhotosV6Edit` | photosV6-edit |
|
||||||
|
| `PhotosV6TvAlbums` | photosV6-tv-albums |
|
||||||
| `PmsHealth` | pms_health |
|
| `PmsHealth` | pms_health |
|
||||||
|
| `PremiumDashboard` | premium-dashboard |
|
||||||
|
| `PremiumMusicMetadata` | premium_music_metadata |
|
||||||
| `Radio` | radio |
|
| `Radio` | radio |
|
||||||
| `RateLimitClientToken` | rate-limit-client-token |
|
| `RateLimitClientToken` | rate-limit-client-token |
|
||||||
| `ScrobblingServicePlexTv` | scrobbling-service-plex-tv |
|
| `ScrobblingServicePlexTv` | scrobbling-service-plex-tv |
|
||||||
|
| `SessionBandwidthRestrictions` | session_bandwidth_restrictions |
|
||||||
|
| `SessionKick` | session_kick |
|
||||||
| `SharedServerNotification` | shared_server_notification |
|
| `SharedServerNotification` | shared_server_notification |
|
||||||
| `SharedSourceNotification` | shared_source_notification |
|
| `SharedSourceNotification` | shared_source_notification |
|
||||||
|
| `SigninNotification` | signin_notification |
|
||||||
| `SigninWithApple` | signin_with_apple |
|
| `SigninWithApple` | signin_with_apple |
|
||||||
|
| `SilenceRemoval` | silence-removal |
|
||||||
|
| `SleepTimer` | sleep-timer |
|
||||||
| `SpringServeAdProvider` | spring_serve_ad_provider |
|
| `SpringServeAdProvider` | spring_serve_ad_provider |
|
||||||
|
| `Sync` | sync |
|
||||||
|
| `SweetFades` | sweet-fades |
|
||||||
| `TranscoderCache` | transcoder_cache |
|
| `TranscoderCache` | transcoder_cache |
|
||||||
|
| `Trailers` | trailers |
|
||||||
| `TunerSharing` | tuner-sharing |
|
| `TunerSharing` | tuner-sharing |
|
||||||
| `TwoFactorAuthentication` | two-factor-authentication |
|
| `TwoFactorAuthentication` | two-factor-authentication |
|
||||||
| `Unsupportedtuners` | unsupportedtuners |
|
| `Unsupportedtuners` | unsupportedtuners |
|
||||||
| `Upgrade3ds2` | upgrade-3ds2 |
|
| `Upgrade3ds2` | upgrade-3ds2 |
|
||||||
|
| `Visualizers` | visualizers |
|
||||||
| `VodSchema` | vod-schema |
|
| `VodSchema` | vod-schema |
|
||||||
| `VodCloudflare` | vod_cloudflare |
|
| `VodCloudflare` | vod_cloudflare |
|
||||||
|
| `VolumeLeveling` | volume-leveling |
|
||||||
| `WatchTogetherInvite` | watch-together-invite |
|
| `WatchTogetherInvite` | watch-together-invite |
|
||||||
|
| `WatchlistRss` | watchlist-rss |
|
||||||
| `WebServerDashboard` | web_server_dashboard |
|
| `WebServerDashboard` | web_server_dashboard |
|
||||||
|
| `Webhooks` | webhooks |
|
||||||
|
| - | `Unrecognized<string>` |
|
||||||
@@ -6,10 +6,10 @@
|
|||||||
import { Field } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Field } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: Field = {
|
let value: Field = {
|
||||||
key: "label",
|
key: "show.title",
|
||||||
title: "Label",
|
title: "Show Title",
|
||||||
type: "tag",
|
type: "string",
|
||||||
subType: "bitrate",
|
subType: "rating",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -17,7 +17,7 @@ let value: Field = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
| `key` | *string* | :heavy_minus_sign: | N/A | label |
|
| `key` | *string* | :heavy_check_mark: | N/A | show.title |
|
||||||
| `title` | *string* | :heavy_minus_sign: | N/A | Label |
|
| `title` | *string* | :heavy_check_mark: | N/A | Show Title |
|
||||||
| `type` | *string* | :heavy_minus_sign: | N/A | tag |
|
| `type` | *string* | :heavy_check_mark: | N/A | string |
|
||||||
| `subType` | *string* | :heavy_minus_sign: | N/A | bitrate |
|
| `subType` | *string* | :heavy_minus_sign: | N/A | rating |
|
||||||
@@ -6,7 +6,7 @@
|
|||||||
import { FieldType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { FieldType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: FieldType = {
|
let value: FieldType = {
|
||||||
type: "resolution",
|
type: "tag",
|
||||||
operator: [
|
operator: [
|
||||||
{
|
{
|
||||||
key: "=",
|
key: "=",
|
||||||
@@ -20,5 +20,5 @@ let value: FieldType = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||||
| `type` | *string* | :heavy_minus_sign: | N/A | resolution |
|
| `type` | *string* | :heavy_check_mark: | N/A | tag |
|
||||||
| `operator` | [operations.Operator](../../../sdk/models/operations/operator.md)[] | :heavy_minus_sign: | N/A | |
|
| `operator` | [operations.Operator](../../../sdk/models/operations/operator.md)[] | :heavy_check_mark: | N/A | |
|
||||||
@@ -7,7 +7,7 @@ Filter
|
|||||||
```typescript
|
```typescript
|
||||||
import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: Filter = Filter.All;
|
let value: Filter = Filter.Released;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|||||||
16
docs/sdk/models/operations/flattenseasons.md
Normal file
16
docs/sdk/models/operations/flattenseasons.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# FlattenSeasons
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { FlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: FlattenSeasons = FlattenSeasons.True;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------- | ------- |
|
||||||
|
| `False` | 0 |
|
||||||
|
| `True` | 1 |
|
||||||
@@ -7,7 +7,7 @@ Force the refresh even if the library is already being refreshed.
|
|||||||
```typescript
|
```typescript
|
||||||
import { Force } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Force } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: Force = Force.One;
|
let value: Force = Force.Zero;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
import { Genre } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Genre } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: Genre = {
|
let value: Genre = {
|
||||||
tag: "Comedy",
|
tag: "Adventure",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -14,4 +14,4 @@ let value: Genre = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Comedy |
|
| `tag` | *string* | :heavy_minus_sign: | N/A | Adventure |
|
||||||
@@ -14,7 +14,7 @@ let value: GeoData = {
|
|||||||
city: "Amsterdam",
|
city: "Amsterdam",
|
||||||
europeanUnionMember: true,
|
europeanUnionMember: true,
|
||||||
timeZone: "America/St_Thomas",
|
timeZone: "America/St_Thomas",
|
||||||
postalCode: 802,
|
postalCode: "802",
|
||||||
inPrivacyRestrictedCountry: true,
|
inPrivacyRestrictedCountry: true,
|
||||||
inPrivacyRestrictedRegion: true,
|
inPrivacyRestrictedRegion: true,
|
||||||
subdivisions: "Saint Thomas",
|
subdivisions: "Saint Thomas",
|
||||||
@@ -32,7 +32,7 @@ let value: GeoData = {
|
|||||||
| `city` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam |
|
| `city` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam |
|
||||||
| `europeanUnionMember` | *boolean* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
|
| `europeanUnionMember` | *boolean* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
|
||||||
| `timeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
|
| `timeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
|
||||||
| `postalCode` | *number* | :heavy_check_mark: | The postal code of the location. | 802 |
|
| `postalCode` | *string* | :heavy_check_mark: | The postal code of the location. | 802 |
|
||||||
| `inPrivacyRestrictedCountry` | *boolean* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
|
| `inPrivacyRestrictedCountry` | *boolean* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
|
||||||
| `inPrivacyRestrictedRegion` | *boolean* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
|
| `inPrivacyRestrictedRegion` | *boolean* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
|
||||||
| `subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
|
| `subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ let value: GetAllLibrariesDirectory = {
|
|||||||
scannedAt: 1556281940,
|
scannedAt: 1556281940,
|
||||||
content: true,
|
content: true,
|
||||||
directory: true,
|
directory: true,
|
||||||
contentChangedAt: 3192854,
|
contentChangedAt: 1556281940,
|
||||||
hidden: 0,
|
hidden: 0,
|
||||||
location: [
|
location: [
|
||||||
{
|
{
|
||||||
@@ -39,24 +39,24 @@ let value: GetAllLibrariesDirectory = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
|
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||||
| `art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||||
| `composite` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/composite/1705615584 |
|
| `composite` | *string* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
|
||||||
| `filters` | *boolean* | :heavy_minus_sign: | N/A | true |
|
| `filters` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||||
| `refreshing` | *boolean* | :heavy_minus_sign: | N/A | false |
|
| `refreshing` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
||||||
| `key` | *string* | :heavy_minus_sign: | N/A | 1 |
|
| `key` | *string* | :heavy_check_mark: | N/A | 1 |
|
||||||
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
| `type` | *string* | :heavy_check_mark: | N/A | movie |
|
||||||
| `title` | *string* | :heavy_minus_sign: | N/A | Movies |
|
| `title` | *string* | :heavy_check_mark: | N/A | Movies |
|
||||||
| `agent` | *string* | :heavy_minus_sign: | N/A | tv.plex.agents.movie |
|
| `agent` | *string* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
|
||||||
| `scanner` | *string* | :heavy_minus_sign: | N/A | Plex Movie |
|
| `scanner` | *string* | :heavy_check_mark: | N/A | Plex Movie |
|
||||||
| `language` | *string* | :heavy_minus_sign: | N/A | en-US |
|
| `language` | *string* | :heavy_check_mark: | N/A | en-US |
|
||||||
| `uuid` | *string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
| `uuid` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||||
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
| `updatedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `createdAt` | *number* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
| `createdAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `scannedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
| `scannedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `content` | *boolean* | :heavy_minus_sign: | N/A | true |
|
| `content` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||||
| `directory` | *boolean* | :heavy_minus_sign: | N/A | true |
|
| `directory` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||||
| `contentChangedAt` | *number* | :heavy_minus_sign: | N/A | 3192854 |
|
| `contentChangedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `hidden` | *number* | :heavy_minus_sign: | N/A | 0 |
|
| `hidden` | *number* | :heavy_check_mark: | N/A | 0 |
|
||||||
| `location` | [operations.Location](../../../sdk/models/operations/location.md)[] | :heavy_minus_sign: | N/A | |
|
| `location` | [operations.Location](../../../sdk/models/operations/location.md)[] | :heavy_check_mark: | N/A | |
|
||||||
@@ -29,7 +29,7 @@ let value: GetAllLibrariesMediaContainer = {
|
|||||||
scannedAt: 1556281940,
|
scannedAt: 1556281940,
|
||||||
content: true,
|
content: true,
|
||||||
directory: true,
|
directory: true,
|
||||||
contentChangedAt: 3192854,
|
contentChangedAt: 1556281940,
|
||||||
hidden: 0,
|
hidden: 0,
|
||||||
location: [
|
location: [
|
||||||
{
|
{
|
||||||
@@ -49,4 +49,4 @@ let value: GetAllLibrariesMediaContainer = {
|
|||||||
| `size` | *number* | :heavy_check_mark: | N/A | 5 |
|
| `size` | *number* | :heavy_check_mark: | N/A | 5 |
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||||
| `title1` | *string* | :heavy_check_mark: | N/A | Plex Library |
|
| `title1` | *string* | :heavy_check_mark: | N/A | Plex Library |
|
||||||
| `directory` | [operations.GetAllLibrariesDirectory](../../../sdk/models/operations/getalllibrariesdirectory.md)[] | :heavy_minus_sign: | N/A | |
|
| `directory` | [operations.GetAllLibrariesDirectory](../../../sdk/models/operations/getalllibrariesdirectory.md)[] | :heavy_check_mark: | N/A | |
|
||||||
@@ -7,7 +7,7 @@ import { GetAllLibrariesResponse } from "@lukehagar/plexjs/sdk/models/operations
|
|||||||
|
|
||||||
let value: GetAllLibrariesResponse = {
|
let value: GetAllLibrariesResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 437032,
|
statusCode: 308,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
@@ -36,7 +36,7 @@ let value: GetAllLibrariesResponse = {
|
|||||||
scannedAt: 1556281940,
|
scannedAt: 1556281940,
|
||||||
content: true,
|
content: true,
|
||||||
directory: true,
|
directory: true,
|
||||||
contentChangedAt: 3192854,
|
contentChangedAt: 1556281940,
|
||||||
hidden: 0,
|
hidden: 0,
|
||||||
location: [
|
location: [
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -32,7 +32,7 @@ let value: GetAllLibrariesResponseBody = {
|
|||||||
scannedAt: 1556281940,
|
scannedAt: 1556281940,
|
||||||
content: true,
|
content: true,
|
||||||
directory: true,
|
directory: true,
|
||||||
contentChangedAt: 3192854,
|
contentChangedAt: 1556281940,
|
||||||
hidden: 0,
|
hidden: 0,
|
||||||
location: [
|
location: [
|
||||||
{
|
{
|
||||||
@@ -50,4 +50,4 @@ let value: GetAllLibrariesResponseBody = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
| `mediaContainer` | [operations.GetAllLibrariesMediaContainer](../../../sdk/models/operations/getalllibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
| `mediaContainer` | [operations.GetAllLibrariesMediaContainer](../../../sdk/models/operations/getalllibrariesmediacontainer.md) | :heavy_check_mark: | N/A |
|
||||||
@@ -7,7 +7,7 @@ import { GetAvailableClientsResponse } from "@lukehagar/plexjs/sdk/models/operat
|
|||||||
|
|
||||||
let value: GetAvailableClientsResponse = {
|
let value: GetAvailableClientsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 715190,
|
statusCode: 305,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs/sdk/models/ope
|
|||||||
|
|
||||||
let value: GetBandwidthStatisticsResponse = {
|
let value: GetBandwidthStatisticsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 921158,
|
statusCode: 102,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -24,4 +24,4 @@ let value: GetBannerImageRequest = {
|
|||||||
| `height` | *number* | :heavy_check_mark: | N/A | 396 |
|
| `height` | *number* | :heavy_check_mark: | N/A | 396 |
|
||||||
| `minSize` | *number* | :heavy_check_mark: | N/A | 1 |
|
| `minSize` | *number* | :heavy_check_mark: | N/A | 1 |
|
||||||
| `upscale` | *number* | :heavy_check_mark: | N/A | 1 |
|
| `upscale` | *number* | :heavy_check_mark: | N/A | 1 |
|
||||||
| `xPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
|
| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
|
||||||
@@ -7,7 +7,7 @@ import { GetButlerTasksResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
|||||||
|
|
||||||
let value: GetButlerTasksResponse = {
|
let value: GetButlerTasksResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 528895,
|
statusCode: 431,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { GetCompanionsDataResponse } from "@lukehagar/plexjs/sdk/models/operatio
|
|||||||
|
|
||||||
let value: GetCompanionsDataResponse = {
|
let value: GetCompanionsDataResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 648172,
|
statusCode: 308,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { GetDevicesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: GetDevicesResponse = {
|
let value: GetDevicesResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 844266,
|
statusCode: 308,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { GetFileHashResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: GetFileHashResponse = {
|
let value: GetFileHashResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 359508,
|
statusCode: 305,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ let value: GetGeoDataGeoData = {
|
|||||||
city: "Amsterdam",
|
city: "Amsterdam",
|
||||||
europeanUnionMember: true,
|
europeanUnionMember: true,
|
||||||
timeZone: "America/St_Thomas",
|
timeZone: "America/St_Thomas",
|
||||||
postalCode: 802,
|
postalCode: "802",
|
||||||
inPrivacyRestrictedCountry: true,
|
inPrivacyRestrictedCountry: true,
|
||||||
inPrivacyRestrictedRegion: true,
|
inPrivacyRestrictedRegion: true,
|
||||||
subdivisions: "Saint Thomas",
|
subdivisions: "Saint Thomas",
|
||||||
@@ -32,7 +32,7 @@ let value: GetGeoDataGeoData = {
|
|||||||
| `city` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam |
|
| `city` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam |
|
||||||
| `europeanUnionMember` | *boolean* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
|
| `europeanUnionMember` | *boolean* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
|
||||||
| `timeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
|
| `timeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
|
||||||
| `postalCode` | *number* | :heavy_check_mark: | The postal code of the location. | 802 |
|
| `postalCode` | *string* | :heavy_check_mark: | The postal code of the location. | 802 |
|
||||||
| `inPrivacyRestrictedCountry` | *boolean* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
|
| `inPrivacyRestrictedCountry` | *boolean* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
|
||||||
| `inPrivacyRestrictedRegion` | *boolean* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
|
| `inPrivacyRestrictedRegion` | *boolean* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
|
||||||
| `subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
|
| `subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { GetGeoDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: GetGeoDataResponse = {
|
let value: GetGeoDataResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 368241,
|
statusCode: 102,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
@@ -18,7 +18,7 @@ let value: GetGeoDataResponse = {
|
|||||||
city: "Amsterdam",
|
city: "Amsterdam",
|
||||||
europeanUnionMember: true,
|
europeanUnionMember: true,
|
||||||
timeZone: "America/St_Thomas",
|
timeZone: "America/St_Thomas",
|
||||||
postalCode: 802,
|
postalCode: "802",
|
||||||
inPrivacyRestrictedCountry: true,
|
inPrivacyRestrictedCountry: true,
|
||||||
inPrivacyRestrictedRegion: true,
|
inPrivacyRestrictedRegion: true,
|
||||||
subdivisions: "Saint Thomas",
|
subdivisions: "Saint Thomas",
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { GetGlobalHubsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: GetGlobalHubsResponse = {
|
let value: GetGlobalHubsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 149675,
|
statusCode: 423,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { GetHomeDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: GetHomeDataResponse = {
|
let value: GetHomeDataResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 832620,
|
statusCode: 204,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
23
docs/sdk/models/operations/getlibrarydetailsfield.md
Normal file
23
docs/sdk/models/operations/getlibrarydetailsfield.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# GetLibraryDetailsField
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryDetailsField } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryDetailsField = {
|
||||||
|
key: "label",
|
||||||
|
title: "Label",
|
||||||
|
type: "tag",
|
||||||
|
subType: "bitrate",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | label |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | N/A | Label |
|
||||||
|
| `type` | *string* | :heavy_minus_sign: | N/A | tag |
|
||||||
|
| `subType` | *string* | :heavy_minus_sign: | N/A | bitrate |
|
||||||
24
docs/sdk/models/operations/getlibrarydetailsfieldtype.md
Normal file
24
docs/sdk/models/operations/getlibrarydetailsfieldtype.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# GetLibraryDetailsFieldType
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryDetailsFieldType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryDetailsFieldType = {
|
||||||
|
type: "resolution",
|
||||||
|
operator: [
|
||||||
|
{
|
||||||
|
key: "=",
|
||||||
|
title: "is",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||||
|
| `type` | *string* | :heavy_minus_sign: | N/A | resolution |
|
||||||
|
| `operator` | [operations.GetLibraryDetailsOperator](../../../sdk/models/operations/getlibrarydetailsoperator.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
@@ -94,4 +94,4 @@ let value: GetLibraryDetailsMediaContainer = {
|
|||||||
| `viewMode` | *number* | :heavy_minus_sign: | N/A | 65592 |
|
| `viewMode` | *number* | :heavy_minus_sign: | N/A | 65592 |
|
||||||
| `directory` | [operations.GetLibraryDetailsDirectory](../../../sdk/models/operations/getlibrarydetailsdirectory.md)[] | :heavy_minus_sign: | N/A | |
|
| `directory` | [operations.GetLibraryDetailsDirectory](../../../sdk/models/operations/getlibrarydetailsdirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `type` | [operations.GetLibraryDetailsType](../../../sdk/models/operations/getlibrarydetailstype.md)[] | :heavy_minus_sign: | N/A | |
|
| `type` | [operations.GetLibraryDetailsType](../../../sdk/models/operations/getlibrarydetailstype.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `fieldType` | [operations.FieldType](../../../sdk/models/operations/fieldtype.md)[] | :heavy_minus_sign: | N/A | |
|
| `fieldType` | [operations.GetLibraryDetailsFieldType](../../../sdk/models/operations/getlibrarydetailsfieldtype.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
19
docs/sdk/models/operations/getlibrarydetailsoperator.md
Normal file
19
docs/sdk/models/operations/getlibrarydetailsoperator.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# GetLibraryDetailsOperator
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryDetailsOperator } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryDetailsOperator = {
|
||||||
|
key: "=",
|
||||||
|
title: "is",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | = |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | N/A | is |
|
||||||
@@ -14,5 +14,5 @@ let value: GetLibraryDetailsRequest = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| 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 |
|
|
||||||
| `includeDetails` | [operations.IncludeDetails](../../../sdk/models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
| `includeDetails` | [operations.IncludeDetails](../../../sdk/models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
||||||
|
| `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 |
|
||||||
@@ -7,7 +7,7 @@ import { GetLibraryDetailsResponse } from "@lukehagar/plexjs/sdk/models/operatio
|
|||||||
|
|
||||||
let value: GetLibraryDetailsResponse = {
|
let value: GetLibraryDetailsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 697631,
|
statusCode: 308,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
27
docs/sdk/models/operations/getlibrarydetailssort.md
Normal file
27
docs/sdk/models/operations/getlibrarydetailssort.md
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
# GetLibraryDetailsSort
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryDetailsSort } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryDetailsSort = {
|
||||||
|
default: "asc",
|
||||||
|
defaultDirection: "desc",
|
||||||
|
descKey: "random:desc",
|
||||||
|
firstCharacterKey: "/library/sections/1/firstCharacter",
|
||||||
|
key: "random",
|
||||||
|
title: "Randomly",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||||
|
| `default` | *string* | :heavy_minus_sign: | N/A | asc |
|
||||||
|
| `defaultDirection` | *string* | :heavy_minus_sign: | N/A | desc |
|
||||||
|
| `descKey` | *string* | :heavy_minus_sign: | N/A | random:desc |
|
||||||
|
| `firstCharacterKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/firstCharacter |
|
||||||
|
| `key` | *string* | :heavy_minus_sign: | N/A | random |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | N/A | Randomly |
|
||||||
@@ -49,5 +49,5 @@ let value: GetLibraryDetailsType = {
|
|||||||
| `title` | *string* | :heavy_minus_sign: | N/A | Movies |
|
| `title` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||||
| `active` | *boolean* | :heavy_minus_sign: | N/A | false |
|
| `active` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
| `filter` | [operations.GetLibraryDetailsFilter](../../../sdk/models/operations/getlibrarydetailsfilter.md)[] | :heavy_minus_sign: | N/A | |
|
| `filter` | [operations.GetLibraryDetailsFilter](../../../sdk/models/operations/getlibrarydetailsfilter.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `sort` | [operations.Sort](../../../sdk/models/operations/sort.md)[] | :heavy_minus_sign: | N/A | |
|
| `sort` | [operations.GetLibraryDetailsSort](../../../sdk/models/operations/getlibrarydetailssort.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `field` | [operations.Field](../../../sdk/models/operations/field.md)[] | :heavy_minus_sign: | N/A | |
|
| `field` | [operations.GetLibraryDetailsField](../../../sdk/models/operations/getlibrarydetailsfield.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
@@ -6,7 +6,7 @@
|
|||||||
import { GetLibraryHubsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryHubsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryHubsRequest = {
|
let value: GetLibraryHubsRequest = {
|
||||||
sectionId: 2223.21,
|
sectionId: 6063.93,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
|||||||
|
|
||||||
let value: GetLibraryHubsResponse = {
|
let value: GetLibraryHubsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 616934,
|
statusCode: 101,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
20
docs/sdk/models/operations/getlibraryitemsactivedirection.md
Normal file
20
docs/sdk/models/operations/getlibraryitemsactivedirection.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# GetLibraryItemsActiveDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsActiveDirection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsActiveDirection =
|
||||||
|
GetLibraryItemsActiveDirection.Ascending;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
17
docs/sdk/models/operations/getlibraryitemscollection.md
Normal file
17
docs/sdk/models/operations/getlibraryitemscollection.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetLibraryItemsCollection
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsCollection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsCollection = {
|
||||||
|
tag: "Working NL Subs",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `tag` | *string* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
# GetLibraryItemsDefaultDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsDefaultDirection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsDefaultDirection =
|
||||||
|
GetLibraryItemsDefaultDirection.Ascending;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
23
docs/sdk/models/operations/getlibraryitemsfield.md
Normal file
23
docs/sdk/models/operations/getlibraryitemsfield.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# GetLibraryItemsField
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsField } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsField = {
|
||||||
|
key: "show.title",
|
||||||
|
title: "Show Title",
|
||||||
|
type: "string",
|
||||||
|
subType: "rating",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | N/A | show.title |
|
||||||
|
| `title` | *string* | :heavy_check_mark: | N/A | Show Title |
|
||||||
|
| `type` | *string* | :heavy_check_mark: | N/A | string |
|
||||||
|
| `subType` | *string* | :heavy_minus_sign: | N/A | rating |
|
||||||
24
docs/sdk/models/operations/getlibraryitemsfieldtype.md
Normal file
24
docs/sdk/models/operations/getlibraryitemsfieldtype.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# GetLibraryItemsFieldType
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsFieldType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsFieldType = {
|
||||||
|
type: "tag",
|
||||||
|
operator: [
|
||||||
|
{
|
||||||
|
key: "=",
|
||||||
|
title: "is",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||||
|
| `type` | *string* | :heavy_check_mark: | N/A | tag |
|
||||||
|
| `operator` | [operations.GetLibraryItemsOperator](../../../sdk/models/operations/getlibraryitemsoperator.md)[] | :heavy_check_mark: | N/A | |
|
||||||
25
docs/sdk/models/operations/getlibraryitemsfilter.md
Normal file
25
docs/sdk/models/operations/getlibraryitemsfilter.md
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
# GetLibraryItemsFilter
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsFilter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsFilter = {
|
||||||
|
filter: "genre",
|
||||||
|
filterType: "string",
|
||||||
|
key: "/library/sections/2/genre?type=2",
|
||||||
|
title: "Genre",
|
||||||
|
type: "filter",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||||
|
| `filter` | *string* | :heavy_check_mark: | N/A | genre |
|
||||||
|
| `filterType` | *string* | :heavy_check_mark: | N/A | string |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||||
|
| `title` | *string* | :heavy_check_mark: | N/A | Genre |
|
||||||
|
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||||
16
docs/sdk/models/operations/getlibraryitemsflattenseasons.md
Normal file
16
docs/sdk/models/operations/getlibraryitemsflattenseasons.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# GetLibraryItemsFlattenSeasons
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsFlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsFlattenSeasons = GetLibraryItemsFlattenSeasons.True;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------- | ------- |
|
||||||
|
| `False` | 0 |
|
||||||
|
| `True` | 1 |
|
||||||
16
docs/sdk/models/operations/getlibraryitemshasthumbnail.md
Normal file
16
docs/sdk/models/operations/getlibraryitemshasthumbnail.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# GetLibraryItemsHasThumbnail
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsHasThumbnail } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsHasThumbnail = GetLibraryItemsHasThumbnail.True;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------- | ------- |
|
||||||
|
| `False` | 0 |
|
||||||
|
| `True` | 1 |
|
||||||
21
docs/sdk/models/operations/getlibraryitemsimage.md
Normal file
21
docs/sdk/models/operations/getlibraryitemsimage.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetLibraryItemsImage
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsImage, GetLibraryItemsLibraryResponse200Type } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsImage = {
|
||||||
|
alt: "Episode 1",
|
||||||
|
type: GetLibraryItemsLibraryResponse200Type.Background,
|
||||||
|
url: "/library/metadata/45521/thumb/1644710589",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
|
||||||
|
| `type` | [operations.GetLibraryItemsLibraryResponse200Type](../../../sdk/models/operations/getlibraryitemslibraryresponse200type.md) | :heavy_check_mark: | N/A | background |
|
||||||
|
| `url` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
# GetLibraryItemsLibraryActiveDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsLibraryActiveDirection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsLibraryActiveDirection =
|
||||||
|
GetLibraryItemsLibraryActiveDirection.Ascending;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
# GetLibraryItemsLibraryDefaultDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsLibraryDefaultDirection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsLibraryDefaultDirection =
|
||||||
|
GetLibraryItemsLibraryDefaultDirection.Ascending;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
23
docs/sdk/models/operations/getlibraryitemslibraryfield.md
Normal file
23
docs/sdk/models/operations/getlibraryitemslibraryfield.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# GetLibraryItemsLibraryField
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsLibraryField } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsLibraryField = {
|
||||||
|
key: "show.title",
|
||||||
|
title: "Show Title",
|
||||||
|
type: "string",
|
||||||
|
subType: "rating",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | N/A | show.title |
|
||||||
|
| `title` | *string* | :heavy_check_mark: | N/A | Show Title |
|
||||||
|
| `type` | *string* | :heavy_check_mark: | N/A | string |
|
||||||
|
| `subType` | *string* | :heavy_minus_sign: | N/A | rating |
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
# GetLibraryItemsLibraryFieldType
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsLibraryFieldType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsLibraryFieldType = {
|
||||||
|
type: "tag",
|
||||||
|
operator: [
|
||||||
|
{
|
||||||
|
key: "=",
|
||||||
|
title: "is",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `type` | *string* | :heavy_check_mark: | N/A | tag |
|
||||||
|
| `operator` | [operations.GetLibraryItemsLibraryOperator](../../../sdk/models/operations/getlibraryitemslibraryoperator.md)[] | :heavy_check_mark: | N/A | |
|
||||||
25
docs/sdk/models/operations/getlibraryitemslibraryfilter.md
Normal file
25
docs/sdk/models/operations/getlibraryitemslibraryfilter.md
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
# GetLibraryItemsLibraryFilter
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsLibraryFilter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsLibraryFilter = {
|
||||||
|
filter: "genre",
|
||||||
|
filterType: "string",
|
||||||
|
key: "/library/sections/2/genre?type=2",
|
||||||
|
title: "Genre",
|
||||||
|
type: "filter",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||||
|
| `filter` | *string* | :heavy_check_mark: | N/A | genre |
|
||||||
|
| `filterType` | *string* | :heavy_check_mark: | N/A | string |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||||
|
| `title` | *string* | :heavy_check_mark: | N/A | Genre |
|
||||||
|
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||||
19
docs/sdk/models/operations/getlibraryitemslibraryoperator.md
Normal file
19
docs/sdk/models/operations/getlibraryitemslibraryoperator.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# GetLibraryItemsLibraryOperator
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsLibraryOperator } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsLibraryOperator = {
|
||||||
|
key: "=",
|
||||||
|
title: "is",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | N/A | = |
|
||||||
|
| `title` | *string* | :heavy_check_mark: | N/A | is |
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
# GetLibraryItemsLibraryResponse200Type
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsLibraryResponse200Type } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsLibraryResponse200Type =
|
||||||
|
GetLibraryItemsLibraryResponse200Type.Background;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------- | ------------- |
|
||||||
|
| `CoverPoster` | coverPoster |
|
||||||
|
| `Background` | background |
|
||||||
|
| `Snapshot` | snapshot |
|
||||||
|
| `ClearLogo` | clearLogo |
|
||||||
@@ -0,0 +1,59 @@
|
|||||||
|
# GetLibraryItemsLibraryResponseType
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import {
|
||||||
|
GetLibraryItemsLibraryActiveDirection,
|
||||||
|
GetLibraryItemsLibraryDefaultDirection,
|
||||||
|
GetLibraryItemsLibraryResponseType,
|
||||||
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsLibraryResponseType = {
|
||||||
|
key: "/library/sections/2/all?type=2",
|
||||||
|
type: "show",
|
||||||
|
title: "TV Shows",
|
||||||
|
active: false,
|
||||||
|
filter: [
|
||||||
|
{
|
||||||
|
filter: "genre",
|
||||||
|
filterType: "string",
|
||||||
|
key: "/library/sections/2/genre?type=2",
|
||||||
|
title: "Genre",
|
||||||
|
type: "filter",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
sort: [
|
||||||
|
{
|
||||||
|
default: "asc",
|
||||||
|
active: false,
|
||||||
|
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
|
||||||
|
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
|
||||||
|
descKey: "titleSort:desc",
|
||||||
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
|
key: "titleSort",
|
||||||
|
title: "Title",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
field: [
|
||||||
|
{
|
||||||
|
key: "show.title",
|
||||||
|
title: "Show Title",
|
||||||
|
type: "string",
|
||||||
|
subType: "rating",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||||
|
| `type` | *string* | :heavy_check_mark: | N/A | show |
|
||||||
|
| `title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||||
|
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||||
|
| `filter` | [operations.GetLibraryItemsLibraryFilter](../../../sdk/models/operations/getlibraryitemslibraryfilter.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `sort` | [operations.GetLibraryItemsLibrarySort](../../../sdk/models/operations/getlibraryitemslibrarysort.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `field` | [operations.GetLibraryItemsLibraryField](../../../sdk/models/operations/getlibraryitemslibraryfield.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
35
docs/sdk/models/operations/getlibraryitemslibrarysort.md
Normal file
35
docs/sdk/models/operations/getlibraryitemslibrarysort.md
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
# GetLibraryItemsLibrarySort
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import {
|
||||||
|
GetLibraryItemsLibraryActiveDirection,
|
||||||
|
GetLibraryItemsLibraryDefaultDirection,
|
||||||
|
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",
|
||||||
|
title: "Title",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `default` | *string* | :heavy_minus_sign: | N/A | asc |
|
||||||
|
| `active` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `activeDirection` | [operations.GetLibraryItemsLibraryActiveDirection](../../../sdk/models/operations/getlibraryitemslibraryactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||||
|
| `defaultDirection` | [operations.GetLibraryItemsLibraryDefaultDirection](../../../sdk/models/operations/getlibraryitemslibrarydefaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||||
|
| `descKey` | *string* | :heavy_minus_sign: | N/A | titleSort:desc |
|
||||||
|
| `firstCharacterKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | N/A | titleSort |
|
||||||
|
| `title` | *string* | :heavy_check_mark: | N/A | Title |
|
||||||
21
docs/sdk/models/operations/getlibraryitemslibrarytype.md
Normal file
21
docs/sdk/models/operations/getlibraryitemslibrarytype.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetLibraryItemsLibraryType
|
||||||
|
|
||||||
|
The type of media content
|
||||||
|
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsLibraryType = GetLibraryItemsLibraryType.Movie;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Movie` | movie |
|
||||||
|
| `TvShow` | show |
|
||||||
|
| `Season` | season |
|
||||||
|
| `Episode` | episode |
|
||||||
@@ -3,7 +3,11 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsMedia } from "@lukehagar/plexjs/sdk/models/operations";
|
import {
|
||||||
|
GetLibraryItemsHasThumbnail,
|
||||||
|
GetLibraryItemsMedia,
|
||||||
|
GetLibraryItemsOptimizedForStreaming,
|
||||||
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsMedia = {
|
let value: GetLibraryItemsMedia = {
|
||||||
id: 119534,
|
id: 119534,
|
||||||
@@ -12,6 +16,7 @@ let value: GetLibraryItemsMedia = {
|
|||||||
width: 3840,
|
width: 3840,
|
||||||
height: 2072,
|
height: 2072,
|
||||||
aspectRatio: 1.85,
|
aspectRatio: 1.85,
|
||||||
|
audioProfile: "dts",
|
||||||
audioChannels: 6,
|
audioChannels: 6,
|
||||||
audioCodec: "eac3",
|
audioCodec: "eac3",
|
||||||
videoCodec: "hevc",
|
videoCodec: "hevc",
|
||||||
@@ -19,6 +24,9 @@ let value: GetLibraryItemsMedia = {
|
|||||||
container: "mkv",
|
container: "mkv",
|
||||||
videoFrameRate: "24p",
|
videoFrameRate: "24p",
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
|
hasVoiceActivity: false,
|
||||||
|
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
||||||
|
has64bitOffsets: false,
|
||||||
part: [
|
part: [
|
||||||
{
|
{
|
||||||
id: 119542,
|
id: 119542,
|
||||||
@@ -28,7 +36,54 @@ let value: GetLibraryItemsMedia = {
|
|||||||
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
||||||
size: 36158371307,
|
size: 36158371307,
|
||||||
container: "mkv",
|
container: "mkv",
|
||||||
|
audioProfile: "dts",
|
||||||
|
has64bitOffsets: false,
|
||||||
|
optimizedForStreaming: false,
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
|
indexes: "sd",
|
||||||
|
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
||||||
|
stream: [
|
||||||
|
{
|
||||||
|
id: 272796,
|
||||||
|
streamType: 1,
|
||||||
|
default: true,
|
||||||
|
selected: true,
|
||||||
|
codec: "h264",
|
||||||
|
index: 0,
|
||||||
|
bitrate: 6273,
|
||||||
|
colorPrimaries: "bt709",
|
||||||
|
colorRange: "tv",
|
||||||
|
colorSpace: "bt709",
|
||||||
|
colorTrc: "bt709",
|
||||||
|
bitDepth: 8,
|
||||||
|
chromaLocation: "left",
|
||||||
|
streamIdentifier: "2",
|
||||||
|
chromaSubsampling: "4:2:0",
|
||||||
|
codedHeight: 1088,
|
||||||
|
codedWidth: 1920,
|
||||||
|
frameRate: 29.97,
|
||||||
|
hasScalingMatrix: false,
|
||||||
|
hearingImpaired: false,
|
||||||
|
closedCaptions: false,
|
||||||
|
embeddedInVideo: "1",
|
||||||
|
height: 1080,
|
||||||
|
level: 40,
|
||||||
|
profile: "main",
|
||||||
|
refFrames: 4,
|
||||||
|
scanType: "progressive",
|
||||||
|
width: 1920,
|
||||||
|
displayTitle: "1080p (H.264)",
|
||||||
|
extendedDisplayTitle: "1080p (H.264)",
|
||||||
|
channels: 2,
|
||||||
|
language: "English",
|
||||||
|
languageTag: "en",
|
||||||
|
languageCode: "eng",
|
||||||
|
audioChannelLayout: "stereo",
|
||||||
|
samplingRate: 48000,
|
||||||
|
title: "English",
|
||||||
|
canAutoSync: false,
|
||||||
|
},
|
||||||
|
],
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
};
|
};
|
||||||
@@ -36,19 +91,23 @@ let value: GetLibraryItemsMedia = {
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *number* | :heavy_minus_sign: | N/A | 119534 |
|
| `id` | *number* | :heavy_check_mark: | N/A | 119534 |
|
||||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
| `duration` | *number* | :heavy_check_mark: | N/A | 11558112 |
|
||||||
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 25025 |
|
| `bitrate` | *number* | :heavy_check_mark: | N/A | 25025 |
|
||||||
| `width` | *number* | :heavy_minus_sign: | N/A | 3840 |
|
| `width` | *number* | :heavy_check_mark: | N/A | 3840 |
|
||||||
| `height` | *number* | :heavy_minus_sign: | N/A | 2072 |
|
| `height` | *number* | :heavy_check_mark: | N/A | 2072 |
|
||||||
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 1.85 |
|
| `aspectRatio` | *number* | :heavy_check_mark: | N/A | 1.85 |
|
||||||
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 6 |
|
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | dts |
|
||||||
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | eac3 |
|
| `audioChannels` | *number* | :heavy_check_mark: | N/A | 6 |
|
||||||
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | hevc |
|
| `audioCodec` | *string* | :heavy_check_mark: | N/A | eac3 |
|
||||||
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 4k |
|
| `videoCodec` | *string* | :heavy_check_mark: | N/A | hevc |
|
||||||
| `container` | *string* | :heavy_minus_sign: | N/A | mkv |
|
| `videoResolution` | *string* | :heavy_check_mark: | N/A | 4k |
|
||||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
|
| `container` | *string* | :heavy_check_mark: | N/A | mkv |
|
||||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main 10 |
|
| `videoFrameRate` | *string* | :heavy_check_mark: | N/A | 24p |
|
||||||
| `part` | [operations.GetLibraryItemsPart](../../../sdk/models/operations/getlibraryitemspart.md)[] | :heavy_minus_sign: | N/A | |
|
| `videoProfile` | *string* | :heavy_check_mark: | N/A | main 10 |
|
||||||
|
| `hasVoiceActivity` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `optimizedForStreaming` | [operations.GetLibraryItemsOptimizedForStreaming](../../../sdk/models/operations/getlibraryitemsoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `part` | [operations.GetLibraryItemsPart](../../../sdk/models/operations/getlibraryitemspart.md)[] | :heavy_check_mark: | N/A | |
|
||||||
@@ -1,16 +1,84 @@
|
|||||||
# GetLibraryItemsMediaContainer
|
# GetLibraryItemsMediaContainer
|
||||||
|
|
||||||
|
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
||||||
|
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
import {
|
||||||
|
GetLibraryItemsActiveDirection,
|
||||||
|
GetLibraryItemsDefaultDirection,
|
||||||
|
GetLibraryItemsFlattenSeasons,
|
||||||
|
GetLibraryItemsHasThumbnail,
|
||||||
|
GetLibraryItemsLibraryActiveDirection,
|
||||||
|
GetLibraryItemsLibraryDefaultDirection,
|
||||||
|
GetLibraryItemsLibraryResponse200Type,
|
||||||
|
GetLibraryItemsLibraryType,
|
||||||
|
GetLibraryItemsMediaContainer,
|
||||||
|
GetLibraryItemsOptimizedForStreaming,
|
||||||
|
GetLibraryItemsShowOrdering,
|
||||||
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||||
|
|
||||||
let value: GetLibraryItemsMediaContainer = {
|
let value: GetLibraryItemsMediaContainer = {
|
||||||
|
type: [
|
||||||
|
{
|
||||||
|
key: "/library/sections/2/all?type=2",
|
||||||
|
type: "show",
|
||||||
|
title: "TV Shows",
|
||||||
|
active: false,
|
||||||
|
filter: [
|
||||||
|
{
|
||||||
|
filter: "genre",
|
||||||
|
filterType: "string",
|
||||||
|
key: "/library/sections/2/genre?type=2",
|
||||||
|
title: "Genre",
|
||||||
|
type: "filter",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
sort: [
|
||||||
|
{
|
||||||
|
default: "asc",
|
||||||
|
active: false,
|
||||||
|
activeDirection: GetLibraryItemsActiveDirection.Ascending,
|
||||||
|
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
|
||||||
|
descKey: "titleSort:desc",
|
||||||
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
|
key: "titleSort",
|
||||||
|
title: "Title",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
field: [
|
||||||
|
{
|
||||||
|
key: "show.title",
|
||||||
|
title: "Show Title",
|
||||||
|
type: "string",
|
||||||
|
subType: "rating",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
fieldType: [
|
||||||
|
{
|
||||||
|
type: "tag",
|
||||||
|
operator: [
|
||||||
|
{
|
||||||
|
key: "=",
|
||||||
|
title: "is",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
size: 70,
|
size: 70,
|
||||||
|
totalSize: 170,
|
||||||
|
offset: 0,
|
||||||
|
content: "secondary",
|
||||||
allowSync: true,
|
allowSync: true,
|
||||||
|
nocache: true,
|
||||||
art: "/:/resources/movie-fanart.jpg",
|
art: "/:/resources/movie-fanart.jpg",
|
||||||
identifier: "com.plexapp.plugins.library",
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
librarySectionID: 1,
|
||||||
librarySectionTitle: "Movies",
|
librarySectionTitle: "Movies",
|
||||||
librarySectionUUID: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
librarySectionUUID: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
@@ -27,21 +95,30 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
key: "/library/metadata/58683",
|
key: "/library/metadata/58683",
|
||||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||||
studio: "20th Century Studios",
|
studio: "20th Century Studios",
|
||||||
type: "movie",
|
skipChildren: false,
|
||||||
|
librarySectionID: 1,
|
||||||
|
librarySectionTitle: "Movies",
|
||||||
|
librarySectionKey: "/library/sections/1",
|
||||||
|
type: GetLibraryItemsLibraryType.Movie,
|
||||||
title: "Avatar: The Way of Water",
|
title: "Avatar: The Way of Water",
|
||||||
|
slug: "4-for-texas",
|
||||||
contentRating: "PG-13",
|
contentRating: "PG-13",
|
||||||
summary:
|
summary:
|
||||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.",
|
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.",
|
||||||
rating: 7.6,
|
rating: 7.6,
|
||||||
audienceRating: 9.2,
|
audienceRating: 9.2,
|
||||||
year: 2022,
|
year: 2022,
|
||||||
|
seasonCount: 2022,
|
||||||
tagline: "Return to Pandora.",
|
tagline: "Return to Pandora.",
|
||||||
|
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
|
||||||
|
showOrdering: GetLibraryItemsShowOrdering.Dvd,
|
||||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||||
art: "/library/metadata/58683/art/1703239236",
|
art: "/library/metadata/58683/art/1703239236",
|
||||||
|
banner: "/library/metadata/58683/banner/1703239236",
|
||||||
duration: 11558112,
|
duration: 11558112,
|
||||||
originallyAvailableAt: new RFCDate("2022-12-14T00:00:00Z"),
|
originallyAvailableAt: new RFCDate("2022-12-14T00:00:00Z"),
|
||||||
addedAt: 1680457607,
|
addedAt: 1556281940,
|
||||||
updatedAt: 1703239236,
|
updatedAt: 1556281940,
|
||||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||||
chapterSource: "media",
|
chapterSource: "media",
|
||||||
primaryExtraKey: "/library/metadata/58684",
|
primaryExtraKey: "/library/metadata/58684",
|
||||||
@@ -51,6 +128,8 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
grandparentKey: "/library/metadata/66",
|
grandparentKey: "/library/metadata/66",
|
||||||
grandparentTitle: "Caprica",
|
grandparentTitle: "Caprica",
|
||||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||||
|
parentSlug: "alice-in-borderland-2020",
|
||||||
|
grandparentSlug: "alice-in-borderland-2020",
|
||||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||||
media: [
|
media: [
|
||||||
@@ -61,6 +140,7 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
width: 3840,
|
width: 3840,
|
||||||
height: 2072,
|
height: 2072,
|
||||||
aspectRatio: 1.85,
|
aspectRatio: 1.85,
|
||||||
|
audioProfile: "dts",
|
||||||
audioChannels: 6,
|
audioChannels: 6,
|
||||||
audioCodec: "eac3",
|
audioCodec: "eac3",
|
||||||
videoCodec: "hevc",
|
videoCodec: "hevc",
|
||||||
@@ -68,6 +148,9 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
container: "mkv",
|
container: "mkv",
|
||||||
videoFrameRate: "24p",
|
videoFrameRate: "24p",
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
|
hasVoiceActivity: false,
|
||||||
|
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
||||||
|
has64bitOffsets: false,
|
||||||
part: [
|
part: [
|
||||||
{
|
{
|
||||||
id: 119542,
|
id: 119542,
|
||||||
@@ -77,7 +160,54 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
||||||
size: 36158371307,
|
size: 36158371307,
|
||||||
container: "mkv",
|
container: "mkv",
|
||||||
|
audioProfile: "dts",
|
||||||
|
has64bitOffsets: false,
|
||||||
|
optimizedForStreaming: false,
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
|
indexes: "sd",
|
||||||
|
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
||||||
|
stream: [
|
||||||
|
{
|
||||||
|
id: 272796,
|
||||||
|
streamType: 1,
|
||||||
|
default: true,
|
||||||
|
selected: true,
|
||||||
|
codec: "h264",
|
||||||
|
index: 0,
|
||||||
|
bitrate: 6273,
|
||||||
|
colorPrimaries: "bt709",
|
||||||
|
colorRange: "tv",
|
||||||
|
colorSpace: "bt709",
|
||||||
|
colorTrc: "bt709",
|
||||||
|
bitDepth: 8,
|
||||||
|
chromaLocation: "left",
|
||||||
|
streamIdentifier: "2",
|
||||||
|
chromaSubsampling: "4:2:0",
|
||||||
|
codedHeight: 1088,
|
||||||
|
codedWidth: 1920,
|
||||||
|
frameRate: 29.97,
|
||||||
|
hasScalingMatrix: false,
|
||||||
|
hearingImpaired: false,
|
||||||
|
closedCaptions: false,
|
||||||
|
embeddedInVideo: "1",
|
||||||
|
height: 1080,
|
||||||
|
level: 40,
|
||||||
|
profile: "main",
|
||||||
|
refFrames: 4,
|
||||||
|
scanType: "progressive",
|
||||||
|
width: 1920,
|
||||||
|
displayTitle: "1080p (H.264)",
|
||||||
|
extendedDisplayTitle: "1080p (H.264)",
|
||||||
|
channels: 2,
|
||||||
|
language: "English",
|
||||||
|
languageTag: "en",
|
||||||
|
languageCode: "eng",
|
||||||
|
audioChannelLayout: "stereo",
|
||||||
|
samplingRate: 48000,
|
||||||
|
title: "English",
|
||||||
|
canAutoSync: false,
|
||||||
|
},
|
||||||
|
],
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
@@ -102,9 +232,45 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
tag: "James Cameron",
|
tag: "James Cameron",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
|
collection: [
|
||||||
|
{
|
||||||
|
tag: "Working NL Subs",
|
||||||
|
},
|
||||||
|
],
|
||||||
role: [
|
role: [
|
||||||
{
|
{
|
||||||
tag: "Sigourney Weaver",
|
id: 294129,
|
||||||
|
filter: "actor=294129",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg",
|
||||||
|
tag: "Mike Smith",
|
||||||
|
tagKey: "668e7e7b22bcad9064350c91",
|
||||||
|
role: "Self",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
mediaGuid: [
|
||||||
|
{
|
||||||
|
id: "imdb://tt13015952",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
ultraBlurColors: {
|
||||||
|
topLeft: "11333b",
|
||||||
|
topRight: "0a232d",
|
||||||
|
bottomRight: "73958",
|
||||||
|
bottomLeft: "1f5066",
|
||||||
|
},
|
||||||
|
metaDataRating: [
|
||||||
|
{
|
||||||
|
image: "themoviedb://image.rating",
|
||||||
|
value: 3,
|
||||||
|
type: "audience",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
image: [
|
||||||
|
{
|
||||||
|
alt: "Episode 1",
|
||||||
|
type: GetLibraryItemsLibraryResponse200Type.Background,
|
||||||
|
url: "/library/metadata/45521/thumb/1644710589",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
titleSort: "Whale",
|
titleSort: "Whale",
|
||||||
@@ -131,26 +297,83 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
parentTheme: "/library/metadata/66/theme/1705716261",
|
parentTheme: "/library/metadata/66/theme/1705716261",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
|
meta: {
|
||||||
|
type: [
|
||||||
|
{
|
||||||
|
key: "/library/sections/2/all?type=2",
|
||||||
|
type: "show",
|
||||||
|
title: "TV Shows",
|
||||||
|
active: false,
|
||||||
|
filter: [
|
||||||
|
{
|
||||||
|
filter: "genre",
|
||||||
|
filterType: "string",
|
||||||
|
key: "/library/sections/2/genre?type=2",
|
||||||
|
title: "Genre",
|
||||||
|
type: "filter",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
sort: [
|
||||||
|
{
|
||||||
|
default: "asc",
|
||||||
|
active: false,
|
||||||
|
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
|
||||||
|
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
|
||||||
|
descKey: "titleSort:desc",
|
||||||
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
|
key: "titleSort",
|
||||||
|
title: "Title",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
field: [
|
||||||
|
{
|
||||||
|
key: "show.title",
|
||||||
|
title: "Show Title",
|
||||||
|
type: "string",
|
||||||
|
subType: "rating",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
fieldType: [
|
||||||
|
{
|
||||||
|
type: "tag",
|
||||||
|
operator: [
|
||||||
|
{
|
||||||
|
key: "=",
|
||||||
|
title: "is",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||||
| `size` | *number* | :heavy_minus_sign: | N/A | 70 |
|
| `type` | [operations.GetLibraryItemsType](../../../sdk/models/operations/getlibraryitemstype.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
|
| `fieldType` | [operations.GetLibraryItemsFieldType](../../../sdk/models/operations/getlibraryitemsfieldtype.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
| `size` | *number* | :heavy_check_mark: | N/A | 70 |
|
||||||
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
| `totalSize` | *number* | :heavy_check_mark: | N/A | 170 |
|
||||||
| `librarySectionID` | *operations.LibrarySectionID* | :heavy_minus_sign: | N/A | |
|
| `offset` | *number* | :heavy_check_mark: | N/A | 0 |
|
||||||
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
| `content` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||||
| `librarySectionUUID` | *string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||||
| `mediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
| `nocache` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
| `mediaTagVersion` | *number* | :heavy_minus_sign: | N/A | 1701731894 |
|
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
| `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
||||||
| `title1` | *string* | :heavy_minus_sign: | N/A | Movies |
|
| `librarySectionID` | *number* | :heavy_check_mark: | N/A | 1 |
|
||||||
| `title2` | *string* | :heavy_minus_sign: | N/A | Recently Released |
|
| `librarySectionTitle` | *string* | :heavy_check_mark: | N/A | Movies |
|
||||||
| `viewGroup` | *string* | :heavy_minus_sign: | N/A | movie |
|
| `librarySectionUUID` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||||
| `viewMode` | *number* | :heavy_minus_sign: | N/A | 65592 |
|
| `mediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
||||||
| `mixedParents` | *boolean* | :heavy_minus_sign: | N/A | true |
|
| `mediaTagVersion` | *number* | :heavy_check_mark: | N/A | 1701731894 |
|
||||||
| `metadata` | [operations.GetLibraryItemsMetadata](../../../sdk/models/operations/getlibraryitemsmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
||||||
|
| `title1` | *string* | :heavy_check_mark: | N/A | Movies |
|
||||||
|
| `title2` | *string* | :heavy_check_mark: | N/A | Recently Released |
|
||||||
|
| `viewGroup` | *string* | :heavy_check_mark: | N/A | movie |
|
||||||
|
| `viewMode` | *number* | :heavy_minus_sign: | N/A | 65592 |
|
||||||
|
| `mixedParents` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `metadata` | [operations.GetLibraryItemsMetadata](../../../sdk/models/operations/getlibraryitemsmetadata.md)[] | :heavy_check_mark: | N/A | |
|
||||||
|
| `meta` | [operations.GetLibraryItemsMeta](../../../sdk/models/operations/getlibraryitemsmeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||||
17
docs/sdk/models/operations/getlibraryitemsmediaguid.md
Normal file
17
docs/sdk/models/operations/getlibraryitemsmediaguid.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetLibraryItemsMediaGuid
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsMediaGuid } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsMediaGuid = {
|
||||||
|
id: "imdb://tt13015952",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *string* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |
|
||||||
72
docs/sdk/models/operations/getlibraryitemsmeta.md
Normal file
72
docs/sdk/models/operations/getlibraryitemsmeta.md
Normal file
@@ -0,0 +1,72 @@
|
|||||||
|
# GetLibraryItemsMeta
|
||||||
|
|
||||||
|
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
||||||
|
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import {
|
||||||
|
GetLibraryItemsLibraryActiveDirection,
|
||||||
|
GetLibraryItemsLibraryDefaultDirection,
|
||||||
|
GetLibraryItemsMeta,
|
||||||
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsMeta = {
|
||||||
|
type: [
|
||||||
|
{
|
||||||
|
key: "/library/sections/2/all?type=2",
|
||||||
|
type: "show",
|
||||||
|
title: "TV Shows",
|
||||||
|
active: false,
|
||||||
|
filter: [
|
||||||
|
{
|
||||||
|
filter: "genre",
|
||||||
|
filterType: "string",
|
||||||
|
key: "/library/sections/2/genre?type=2",
|
||||||
|
title: "Genre",
|
||||||
|
type: "filter",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
sort: [
|
||||||
|
{
|
||||||
|
default: "asc",
|
||||||
|
active: false,
|
||||||
|
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
|
||||||
|
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
|
||||||
|
descKey: "titleSort:desc",
|
||||||
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
|
key: "titleSort",
|
||||||
|
title: "Title",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
field: [
|
||||||
|
{
|
||||||
|
key: "show.title",
|
||||||
|
title: "Show Title",
|
||||||
|
type: "string",
|
||||||
|
subType: "rating",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
fieldType: [
|
||||||
|
{
|
||||||
|
type: "tag",
|
||||||
|
operator: [
|
||||||
|
{
|
||||||
|
key: "=",
|
||||||
|
title: "is",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `type` | [operations.GetLibraryItemsLibraryResponseType](../../../sdk/models/operations/getlibraryitemslibraryresponsetype.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `fieldType` | [operations.GetLibraryItemsLibraryFieldType](../../../sdk/models/operations/getlibraryitemslibraryfieldtype.md)[] | :heavy_minus_sign: | N/A |
|
||||||
@@ -3,7 +3,15 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsMetadata } from "@lukehagar/plexjs/sdk/models/operations";
|
import {
|
||||||
|
GetLibraryItemsFlattenSeasons,
|
||||||
|
GetLibraryItemsHasThumbnail,
|
||||||
|
GetLibraryItemsLibraryResponse200Type,
|
||||||
|
GetLibraryItemsLibraryType,
|
||||||
|
GetLibraryItemsMetadata,
|
||||||
|
GetLibraryItemsOptimizedForStreaming,
|
||||||
|
GetLibraryItemsShowOrdering,
|
||||||
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||||
|
|
||||||
let value: GetLibraryItemsMetadata = {
|
let value: GetLibraryItemsMetadata = {
|
||||||
@@ -11,21 +19,30 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
key: "/library/metadata/58683",
|
key: "/library/metadata/58683",
|
||||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||||
studio: "20th Century Studios",
|
studio: "20th Century Studios",
|
||||||
type: "movie",
|
skipChildren: false,
|
||||||
|
librarySectionID: 1,
|
||||||
|
librarySectionTitle: "Movies",
|
||||||
|
librarySectionKey: "/library/sections/1",
|
||||||
|
type: GetLibraryItemsLibraryType.Movie,
|
||||||
title: "Avatar: The Way of Water",
|
title: "Avatar: The Way of Water",
|
||||||
|
slug: "4-for-texas",
|
||||||
contentRating: "PG-13",
|
contentRating: "PG-13",
|
||||||
summary:
|
summary:
|
||||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.",
|
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.",
|
||||||
rating: 7.6,
|
rating: 7.6,
|
||||||
audienceRating: 9.2,
|
audienceRating: 9.2,
|
||||||
year: 2022,
|
year: 2022,
|
||||||
|
seasonCount: 2022,
|
||||||
tagline: "Return to Pandora.",
|
tagline: "Return to Pandora.",
|
||||||
|
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
|
||||||
|
showOrdering: GetLibraryItemsShowOrdering.Dvd,
|
||||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||||
art: "/library/metadata/58683/art/1703239236",
|
art: "/library/metadata/58683/art/1703239236",
|
||||||
|
banner: "/library/metadata/58683/banner/1703239236",
|
||||||
duration: 11558112,
|
duration: 11558112,
|
||||||
originallyAvailableAt: new RFCDate("2022-12-14T00:00:00Z"),
|
originallyAvailableAt: new RFCDate("2022-12-14T00:00:00Z"),
|
||||||
addedAt: 1680457607,
|
addedAt: 1556281940,
|
||||||
updatedAt: 1703239236,
|
updatedAt: 1556281940,
|
||||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||||
chapterSource: "media",
|
chapterSource: "media",
|
||||||
primaryExtraKey: "/library/metadata/58684",
|
primaryExtraKey: "/library/metadata/58684",
|
||||||
@@ -35,6 +52,8 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
grandparentKey: "/library/metadata/66",
|
grandparentKey: "/library/metadata/66",
|
||||||
grandparentTitle: "Caprica",
|
grandparentTitle: "Caprica",
|
||||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||||
|
parentSlug: "alice-in-borderland-2020",
|
||||||
|
grandparentSlug: "alice-in-borderland-2020",
|
||||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||||
media: [
|
media: [
|
||||||
@@ -45,6 +64,7 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
width: 3840,
|
width: 3840,
|
||||||
height: 2072,
|
height: 2072,
|
||||||
aspectRatio: 1.85,
|
aspectRatio: 1.85,
|
||||||
|
audioProfile: "dts",
|
||||||
audioChannels: 6,
|
audioChannels: 6,
|
||||||
audioCodec: "eac3",
|
audioCodec: "eac3",
|
||||||
videoCodec: "hevc",
|
videoCodec: "hevc",
|
||||||
@@ -52,6 +72,9 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
container: "mkv",
|
container: "mkv",
|
||||||
videoFrameRate: "24p",
|
videoFrameRate: "24p",
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
|
hasVoiceActivity: false,
|
||||||
|
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
||||||
|
has64bitOffsets: false,
|
||||||
part: [
|
part: [
|
||||||
{
|
{
|
||||||
id: 119542,
|
id: 119542,
|
||||||
@@ -61,7 +84,54 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
||||||
size: 36158371307,
|
size: 36158371307,
|
||||||
container: "mkv",
|
container: "mkv",
|
||||||
|
audioProfile: "dts",
|
||||||
|
has64bitOffsets: false,
|
||||||
|
optimizedForStreaming: false,
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
|
indexes: "sd",
|
||||||
|
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
||||||
|
stream: [
|
||||||
|
{
|
||||||
|
id: 272796,
|
||||||
|
streamType: 1,
|
||||||
|
default: true,
|
||||||
|
selected: true,
|
||||||
|
codec: "h264",
|
||||||
|
index: 0,
|
||||||
|
bitrate: 6273,
|
||||||
|
colorPrimaries: "bt709",
|
||||||
|
colorRange: "tv",
|
||||||
|
colorSpace: "bt709",
|
||||||
|
colorTrc: "bt709",
|
||||||
|
bitDepth: 8,
|
||||||
|
chromaLocation: "left",
|
||||||
|
streamIdentifier: "2",
|
||||||
|
chromaSubsampling: "4:2:0",
|
||||||
|
codedHeight: 1088,
|
||||||
|
codedWidth: 1920,
|
||||||
|
frameRate: 29.97,
|
||||||
|
hasScalingMatrix: false,
|
||||||
|
hearingImpaired: false,
|
||||||
|
closedCaptions: false,
|
||||||
|
embeddedInVideo: "1",
|
||||||
|
height: 1080,
|
||||||
|
level: 40,
|
||||||
|
profile: "main",
|
||||||
|
refFrames: 4,
|
||||||
|
scanType: "progressive",
|
||||||
|
width: 1920,
|
||||||
|
displayTitle: "1080p (H.264)",
|
||||||
|
extendedDisplayTitle: "1080p (H.264)",
|
||||||
|
channels: 2,
|
||||||
|
language: "English",
|
||||||
|
languageTag: "en",
|
||||||
|
languageCode: "eng",
|
||||||
|
audioChannelLayout: "stereo",
|
||||||
|
samplingRate: 48000,
|
||||||
|
title: "English",
|
||||||
|
canAutoSync: false,
|
||||||
|
},
|
||||||
|
],
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
@@ -86,9 +156,45 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
tag: "James Cameron",
|
tag: "James Cameron",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
|
collection: [
|
||||||
|
{
|
||||||
|
tag: "Working NL Subs",
|
||||||
|
},
|
||||||
|
],
|
||||||
role: [
|
role: [
|
||||||
{
|
{
|
||||||
tag: "Sigourney Weaver",
|
id: 294129,
|
||||||
|
filter: "actor=294129",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg",
|
||||||
|
tag: "Mike Smith",
|
||||||
|
tagKey: "668e7e7b22bcad9064350c91",
|
||||||
|
role: "Self",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
mediaGuid: [
|
||||||
|
{
|
||||||
|
id: "imdb://tt13015952",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
ultraBlurColors: {
|
||||||
|
topLeft: "11333b",
|
||||||
|
topRight: "0a232d",
|
||||||
|
bottomRight: "73958",
|
||||||
|
bottomLeft: "1f5066",
|
||||||
|
},
|
||||||
|
metaDataRating: [
|
||||||
|
{
|
||||||
|
image: "themoviedb://image.rating",
|
||||||
|
value: 3,
|
||||||
|
type: "audience",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
image: [
|
||||||
|
{
|
||||||
|
alt: "Episode 1",
|
||||||
|
type: GetLibraryItemsLibraryResponse200Type.Background,
|
||||||
|
url: "/library/metadata/45521/thumb/1644710589",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
titleSort: "Whale",
|
titleSort: "Whale",
|
||||||
@@ -120,24 +226,33 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 58683 |
|
| `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
|
||||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683 |
|
| `key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 |
|
||||||
| `guid` | *string* | :heavy_minus_sign: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
| `guid` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||||
| `studio` | *string* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
| `studio` | *string* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||||
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
| `skipChildren` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
| `title` | *string* | :heavy_minus_sign: | N/A | Avatar: The Way of Water |
|
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||||
|
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||||
|
| `type` | [operations.GetLibraryItemsLibraryType](../../../sdk/models/operations/getlibraryitemslibrarytype.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
||||||
|
| `title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||||
|
| `slug` | *string* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||||
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 |
|
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 |
|
||||||
| `summary` | *string* | :heavy_minus_sign: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
| `summary` | *string* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
||||||
| `rating` | *number* | :heavy_minus_sign: | N/A | 7.6 |
|
| `rating` | *number* | :heavy_minus_sign: | N/A | 7.6 |
|
||||||
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 9.2 |
|
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 9.2 |
|
||||||
| `year` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
| `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. |
|
| `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/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
|
||||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||||
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||||
|
| `banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
||||||
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
||||||
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1680457607 |
|
| `addedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1703239236 |
|
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||||
| `chapterSource` | *string* | :heavy_minus_sign: | N/A | media |
|
| `chapterSource` | *string* | :heavy_minus_sign: | N/A | media |
|
||||||
| `primaryExtraKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
| `primaryExtraKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||||
@@ -147,14 +262,21 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
| `grandparentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
| `grandparentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||||
| `grandparentTitle` | *string* | :heavy_minus_sign: | N/A | Caprica |
|
| `grandparentTitle` | *string* | :heavy_minus_sign: | N/A | Caprica |
|
||||||
| `grandparentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
| `grandparentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||||
|
| `parentSlug` | *string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||||
|
| `grandparentSlug` | *string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||||
| `grandparentArt` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
| `grandparentArt` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||||
| `grandparentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
| `grandparentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||||
| `media` | [operations.GetLibraryItemsMedia](../../../sdk/models/operations/getlibraryitemsmedia.md)[] | :heavy_minus_sign: | N/A | |
|
| `media` | [operations.GetLibraryItemsMedia](../../../sdk/models/operations/getlibraryitemsmedia.md)[] | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
||||||
| `genre` | [operations.GetLibraryItemsGenre](../../../sdk/models/operations/getlibraryitemsgenre.md)[] | :heavy_minus_sign: | N/A | |
|
| `genre` | [operations.GetLibraryItemsGenre](../../../sdk/models/operations/getlibraryitemsgenre.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `country` | [operations.GetLibraryItemsCountry](../../../sdk/models/operations/getlibraryitemscountry.md)[] | :heavy_minus_sign: | N/A | |
|
| `country` | [operations.GetLibraryItemsCountry](../../../sdk/models/operations/getlibraryitemscountry.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `director` | [operations.GetLibraryItemsDirector](../../../sdk/models/operations/getlibraryitemsdirector.md)[] | :heavy_minus_sign: | N/A | |
|
| `director` | [operations.GetLibraryItemsDirector](../../../sdk/models/operations/getlibraryitemsdirector.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `writer` | [operations.GetLibraryItemsWriter](../../../sdk/models/operations/getlibraryitemswriter.md)[] | :heavy_minus_sign: | N/A | |
|
| `writer` | [operations.GetLibraryItemsWriter](../../../sdk/models/operations/getlibraryitemswriter.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `collection` | [operations.GetLibraryItemsCollection](../../../sdk/models/operations/getlibraryitemscollection.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `role` | [operations.GetLibraryItemsRole](../../../sdk/models/operations/getlibraryitemsrole.md)[] | :heavy_minus_sign: | N/A | |
|
| `role` | [operations.GetLibraryItemsRole](../../../sdk/models/operations/getlibraryitemsrole.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `mediaGuid` | [operations.GetLibraryItemsMediaGuid](../../../sdk/models/operations/getlibraryitemsmediaguid.md)[] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||||
|
| `ultraBlurColors` | [operations.GetLibraryItemsUltraBlurColors](../../../sdk/models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `metaDataRating` | [operations.GetLibraryItemsMetaDataRating](../../../sdk/models/operations/getlibraryitemsmetadatarating.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `image` | [operations.GetLibraryItemsImage](../../../sdk/models/operations/getlibraryitemsimage.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `titleSort` | *string* | :heavy_minus_sign: | N/A | Whale |
|
| `titleSort` | *string* | :heavy_minus_sign: | N/A | Whale |
|
||||||
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1682752242 |
|
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||||
@@ -168,7 +290,7 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
| `childCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
| `childCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `hasPremiumExtras` | *string* | :heavy_minus_sign: | N/A | 1 |
|
| `hasPremiumExtras` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `hasPremiumPrimaryExtra` | *string* | :heavy_minus_sign: | N/A | 1 |
|
| `hasPremiumPrimaryExtra` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `parentRatingKey` | *string* | :heavy_minus_sign: | N/A | 66 |
|
| `parentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
||||||
| `parentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
| `parentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
| `parentStudio` | *string* | :heavy_minus_sign: | N/A | UCP |
|
| `parentStudio` | *string* | :heavy_minus_sign: | N/A | UCP |
|
||||||
| `parentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
| `parentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||||
|
|||||||
21
docs/sdk/models/operations/getlibraryitemsmetadatarating.md
Normal file
21
docs/sdk/models/operations/getlibraryitemsmetadatarating.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetLibraryItemsMetaDataRating
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsMetaDataRating } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsMetaDataRating = {
|
||||||
|
image: "themoviedb://image.rating",
|
||||||
|
value: 3,
|
||||||
|
type: "audience",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||||
|
| `image` | *string* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
|
||||||
|
| `value` | *number* | :heavy_check_mark: | The value of the rating. | 3 |
|
||||||
|
| `type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
||||||
19
docs/sdk/models/operations/getlibraryitemsoperator.md
Normal file
19
docs/sdk/models/operations/getlibraryitemsoperator.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# GetLibraryItemsOperator
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsOperator } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsOperator = {
|
||||||
|
key: "=",
|
||||||
|
title: "is",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | N/A | = |
|
||||||
|
| `title` | *string* | :heavy_check_mark: | N/A | is |
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
# GetLibraryItemsOptimizedForStreaming
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsOptimizedForStreaming } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsOptimizedForStreaming =
|
||||||
|
GetLibraryItemsOptimizedForStreaming.Enable;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsPart } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsHasThumbnail, GetLibraryItemsPart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsPart = {
|
let value: GetLibraryItemsPart = {
|
||||||
id: 119542,
|
id: 119542,
|
||||||
@@ -13,7 +13,54 @@ let value: GetLibraryItemsPart = {
|
|||||||
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
||||||
size: 36158371307,
|
size: 36158371307,
|
||||||
container: "mkv",
|
container: "mkv",
|
||||||
|
audioProfile: "dts",
|
||||||
|
has64bitOffsets: false,
|
||||||
|
optimizedForStreaming: false,
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
|
indexes: "sd",
|
||||||
|
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
||||||
|
stream: [
|
||||||
|
{
|
||||||
|
id: 272796,
|
||||||
|
streamType: 1,
|
||||||
|
default: true,
|
||||||
|
selected: true,
|
||||||
|
codec: "h264",
|
||||||
|
index: 0,
|
||||||
|
bitrate: 6273,
|
||||||
|
colorPrimaries: "bt709",
|
||||||
|
colorRange: "tv",
|
||||||
|
colorSpace: "bt709",
|
||||||
|
colorTrc: "bt709",
|
||||||
|
bitDepth: 8,
|
||||||
|
chromaLocation: "left",
|
||||||
|
streamIdentifier: "2",
|
||||||
|
chromaSubsampling: "4:2:0",
|
||||||
|
codedHeight: 1088,
|
||||||
|
codedWidth: 1920,
|
||||||
|
frameRate: 29.97,
|
||||||
|
hasScalingMatrix: false,
|
||||||
|
hearingImpaired: false,
|
||||||
|
closedCaptions: false,
|
||||||
|
embeddedInVideo: "1",
|
||||||
|
height: 1080,
|
||||||
|
level: 40,
|
||||||
|
profile: "main",
|
||||||
|
refFrames: 4,
|
||||||
|
scanType: "progressive",
|
||||||
|
width: 1920,
|
||||||
|
displayTitle: "1080p (H.264)",
|
||||||
|
extendedDisplayTitle: "1080p (H.264)",
|
||||||
|
channels: 2,
|
||||||
|
language: "English",
|
||||||
|
languageTag: "en",
|
||||||
|
languageCode: "eng",
|
||||||
|
audioChannelLayout: "stereo",
|
||||||
|
samplingRate: 48000,
|
||||||
|
title: "English",
|
||||||
|
canAutoSync: false,
|
||||||
|
},
|
||||||
|
],
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -21,10 +68,16 @@ let value: GetLibraryItemsPart = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *number* | :heavy_minus_sign: | N/A | 119542 |
|
| `id` | *number* | :heavy_check_mark: | N/A | 119542 |
|
||||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/parts/119542/1680457526/file.mkv |
|
| `key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
| `duration` | *number* | :heavy_check_mark: | N/A | 11558112 |
|
||||||
| `file` | *string* | :heavy_minus_sign: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
| `file` | *string* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||||
| `size` | *number* | :heavy_minus_sign: | N/A | 36158371307 |
|
| `size` | *number* | :heavy_check_mark: | N/A | 36158371307 |
|
||||||
| `container` | *string* | :heavy_minus_sign: | N/A | mkv |
|
| `container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
||||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main 10 |
|
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | dts |
|
||||||
|
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `optimizedForStreaming` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `videoProfile` | *string* | :heavy_check_mark: | N/A | main 10 |
|
||||||
|
| `indexes` | *string* | :heavy_minus_sign: | N/A | sd |
|
||||||
|
| `hasThumbnail` | [operations.GetLibraryItemsHasThumbnail](../../../sdk/models/operations/getlibraryitemshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `stream` | [operations.GetLibraryItemsStream](../../../sdk/models/operations/getlibraryitemsstream.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user