mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
Compare commits
11 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
18b64727c3 | ||
|
|
3152372037 | ||
|
|
13cd8a7fe5 | ||
|
|
cdcdc0ca8e | ||
|
|
b03cc6a609 | ||
|
|
4e989e0de3 | ||
|
|
c10e011a68 | ||
|
|
7e3dca8466 | ||
|
|
8a2d3e04ab | ||
|
|
6c8a73ae84 | ||
|
|
c839d9f6c7 |
@@ -1,28 +0,0 @@
|
|||||||
/* eslint-env node */
|
|
||||||
module.exports = {
|
|
||||||
root: true,
|
|
||||||
extends: [
|
|
||||||
"eslint:recommended",
|
|
||||||
"plugin:@typescript-eslint/recommended",
|
|
||||||
"plugin:import/recommended",
|
|
||||||
"plugin:import/typescript",
|
|
||||||
],
|
|
||||||
parser: "@typescript-eslint/parser",
|
|
||||||
plugins: ["@typescript-eslint"],
|
|
||||||
settings: {
|
|
||||||
"import/resolver": {
|
|
||||||
typescript: true,
|
|
||||||
node: true,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
rules: {
|
|
||||||
// Handled by typescript compiler
|
|
||||||
"@typescript-eslint/no-unused-vars": "off",
|
|
||||||
"@typescript-eslint/ban-types": "off",
|
|
||||||
"@typescript-eslint/no-namespace": "off",
|
|
||||||
"@typescript-eslint/no-explicit-any": "off",
|
|
||||||
"import/no-named-as-default-member": "off",
|
|
||||||
|
|
||||||
"import/no-default-export": "error",
|
|
||||||
},
|
|
||||||
};
|
|
||||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -1,3 +1,6 @@
|
|||||||
|
/.eslintcache
|
||||||
|
/.speakeasy/reports
|
||||||
|
/react-query
|
||||||
/sdk/models/errors
|
/sdk/models/errors
|
||||||
/sdk/types
|
/sdk/types
|
||||||
/__tests__
|
/__tests__
|
||||||
|
|||||||
@@ -1,9 +1,13 @@
|
|||||||
**/*
|
**/*
|
||||||
|
!/FUNCTIONS.md
|
||||||
|
!/RUNTIMES.md
|
||||||
|
!/REACT_QUERY.md
|
||||||
!/**/*.ts
|
!/**/*.ts
|
||||||
!/**/*.js
|
!/**/*.js
|
||||||
|
!/**/*.json
|
||||||
!/**/*.map
|
!/**/*.map
|
||||||
|
|
||||||
/.eslintrc.js
|
/eslint.config.mjs
|
||||||
/cjs
|
/cjs
|
||||||
/.tshy
|
/.tshy
|
||||||
/.tshy-*
|
/.tshy-*
|
||||||
|
|||||||
1605
.speakeasy/gen.lock
1605
.speakeasy/gen.lock
File diff suppressed because one or more lines are too long
@@ -11,8 +11,9 @@ generation:
|
|||||||
requestResponseComponentNamesFeb2024: true
|
requestResponseComponentNamesFeb2024: true
|
||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
|
oAuth2PasswordEnabled: false
|
||||||
typescript:
|
typescript:
|
||||||
version: 0.25.1
|
version: 0.32.5
|
||||||
additionalDependencies:
|
additionalDependencies:
|
||||||
dependencies: {}
|
dependencies: {}
|
||||||
devDependencies: {}
|
devDependencies: {}
|
||||||
@@ -20,6 +21,9 @@ typescript:
|
|||||||
additionalPackageJSON: {}
|
additionalPackageJSON: {}
|
||||||
author: LukeHagar
|
author: LukeHagar
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
|
defaultErrorName: SDKError
|
||||||
|
enableCustomCodeRegions: false
|
||||||
|
enableReactQuery: false
|
||||||
enumFormat: enum
|
enumFormat: enum
|
||||||
flattenGlobalSecurity: true
|
flattenGlobalSecurity: true
|
||||||
flatteningOrder: body-first
|
flatteningOrder: body-first
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
speakeasyVersion: 1.405.6
|
speakeasyVersion: 1.484.1
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
@@ -9,26 +9,29 @@ sources:
|
|||||||
- main
|
- main
|
||||||
plexapi:
|
plexapi:
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:c6ab8f13847c7cdc4ab3752f517164d7da08266726255aa0d614b1eaea66fb0e
|
sourceRevisionDigest: sha256:e6ab335dd91a4165f4510e4a3af8a55819c6310b7e66251266d2384376f3ccae
|
||||||
sourceBlobDigest: sha256:64c7694915a0828aeb256d10d2fa0ea477681785b818916b6681be8cc5ffb93b
|
sourceBlobDigest: sha256:89d1b1133e400c89f0d06efe5e5168f5ba25a413e1ab8380d442d6b233e2e5a9
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- main
|
- speakeasy-sdk-regen-1738800605
|
||||||
|
- 0.0.3
|
||||||
targets:
|
targets:
|
||||||
plexjs:
|
plexjs:
|
||||||
source: plexapi
|
source: plexapi
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:c6ab8f13847c7cdc4ab3752f517164d7da08266726255aa0d614b1eaea66fb0e
|
sourceRevisionDigest: sha256:e6ab335dd91a4165f4510e4a3af8a55819c6310b7e66251266d2384376f3ccae
|
||||||
sourceBlobDigest: sha256:64c7694915a0828aeb256d10d2fa0ea477681785b818916b6681be8cc5ffb93b
|
sourceBlobDigest: sha256:89d1b1133e400c89f0d06efe5e5168f5ba25a413e1ab8380d442d6b233e2e5a9
|
||||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||||
codeSamplesRevisionDigest: sha256:9667534090efff73eeec1ce4a99b4aebdd251a5eac0cfa5c78ddc0def4d4624e
|
codeSamplesRevisionDigest: sha256:214b9a57e050598b3c15f0f8504a591973e8399cad8b8be2917772c3f75861a9
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
sources:
|
sources:
|
||||||
plexapi:
|
plexapi:
|
||||||
inputs:
|
inputs:
|
||||||
- location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main
|
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/output/plex-media-server-spec-dereferenced.yaml
|
||||||
|
registry:
|
||||||
|
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
|
||||||
targets:
|
targets:
|
||||||
plexjs:
|
plexjs:
|
||||||
target: typescript
|
target: typescript
|
||||||
|
|||||||
@@ -3,7 +3,9 @@ speakeasyVersion: latest
|
|||||||
sources:
|
sources:
|
||||||
plexapi:
|
plexapi:
|
||||||
inputs:
|
inputs:
|
||||||
- location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main
|
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/output/plex-media-server-spec-dereferenced.yaml
|
||||||
|
registry:
|
||||||
|
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
|
||||||
targets:
|
targets:
|
||||||
plexjs:
|
plexjs:
|
||||||
target: typescript
|
target: typescript
|
||||||
|
|||||||
@@ -27,11 +27,6 @@ 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>",
|
||||||
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() {
|
||||||
|
|||||||
316
README.md
316
README.md
@@ -40,18 +40,26 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
|
|||||||
|
|
||||||
<!-- Start Table of Contents [toc] -->
|
<!-- Start Table of Contents [toc] -->
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
<!-- $toc-max-depth=2 -->
|
||||||
|
* [@lukehagar/plexjs](#lukehagarplexjs)
|
||||||
|
* [Plex Media Server OpenAPI Specification](#plex-media-server-openapi-specification)
|
||||||
|
* [Documentation](#documentation)
|
||||||
|
* [SDKs](#sdks)
|
||||||
|
* [SDK Installation](#sdk-installation)
|
||||||
|
* [SDK Example Usage](#sdk-example-usage)
|
||||||
|
* [Available Resources and Operations](#available-resources-and-operations)
|
||||||
|
* [Error Handling](#error-handling)
|
||||||
|
* [Server Selection](#server-selection)
|
||||||
|
* [Custom HTTP Client](#custom-http-client)
|
||||||
|
* [Authentication](#authentication)
|
||||||
|
* [Requirements](#requirements)
|
||||||
|
* [Standalone functions](#standalone-functions)
|
||||||
|
* [Retries](#retries)
|
||||||
|
* [Debugging](#debugging)
|
||||||
|
* [Development](#development)
|
||||||
|
* [Maturity](#maturity)
|
||||||
|
* [Contributions](#contributions)
|
||||||
|
|
||||||
* [SDK Installation](#sdk-installation)
|
|
||||||
* [Requirements](#requirements)
|
|
||||||
* [SDK Example Usage](#sdk-example-usage)
|
|
||||||
* [Available Resources and Operations](#available-resources-and-operations)
|
|
||||||
* [Standalone functions](#standalone-functions)
|
|
||||||
* [Retries](#retries)
|
|
||||||
* [Error Handling](#error-handling)
|
|
||||||
* [Server Selection](#server-selection)
|
|
||||||
* [Custom HTTP Client](#custom-http-client)
|
|
||||||
* [Authentication](#authentication)
|
|
||||||
* [Debugging](#debugging)
|
|
||||||
<!-- End Table of Contents [toc] -->
|
<!-- End Table of Contents [toc] -->
|
||||||
|
|
||||||
<!-- Start SDK Installation [installation] -->
|
<!-- Start SDK Installation [installation] -->
|
||||||
@@ -97,11 +105,6 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
|||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
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() {
|
||||||
@@ -158,6 +161,8 @@ run();
|
|||||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||||
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||||
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||||
|
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
||||||
|
* [getCountriesLibrary](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
|
||||||
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||||
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
||||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||||
@@ -238,6 +243,10 @@ run();
|
|||||||
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
||||||
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
||||||
|
|
||||||
|
### [users](docs/sdks/users/README.md)
|
||||||
|
|
||||||
|
* [getUsers](docs/sdks/users/README.md#getusers) - Get list of all connected users
|
||||||
|
|
||||||
### [video](docs/sdks/video/README.md)
|
### [video](docs/sdks/video/README.md)
|
||||||
|
|
||||||
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
||||||
@@ -253,25 +262,15 @@ run();
|
|||||||
<!-- Start Error Handling [errors] -->
|
<!-- Start Error Handling [errors] -->
|
||||||
## Error Handling
|
## Error Handling
|
||||||
|
|
||||||
All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`.
|
Some methods specify known errors which can be thrown. All the known errors are enumerated in the `sdk/models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `getServerCapabilities` method may throw the following errors:
|
||||||
|
|
||||||
If a HTTP request fails, an operation my also throw an error from the `sdk/models/errors/httpclienterrors.ts` module:
|
| Error Type | Status Code | Content Type |
|
||||||
|
| ---------------------------------------- | ----------- | ---------------- |
|
||||||
|
| errors.GetServerCapabilitiesBadRequest | 400 | application/json |
|
||||||
|
| errors.GetServerCapabilitiesUnauthorized | 401 | application/json |
|
||||||
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
||||||
|
|
||||||
| HTTP Client Error | Description |
|
If the method throws an error and it is not captured by the known errors, it will default to throwing a `SDKError`.
|
||||||
| ---------------------------------------------------- | ---------------------------------------------------- |
|
|
||||||
| 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.GetServerCapabilitiesUnauthorized | 401 | application/json |
|
|
||||||
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
@@ -283,11 +282,6 @@ import {
|
|||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
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() {
|
||||||
@@ -299,8 +293,9 @@ async function run() {
|
|||||||
console.log(result);
|
console.log(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
switch (true) {
|
switch (true) {
|
||||||
|
// The server response does not match the expected SDK schema
|
||||||
case (err instanceof SDKValidationError): {
|
case (err instanceof SDKValidationError): {
|
||||||
// Validation errors can be pretty-printed
|
// Pretty-print will provide a human-readable multi-line error message
|
||||||
console.error(err.pretty());
|
console.error(err.pretty());
|
||||||
// Raw value may also be inspected
|
// Raw value may also be inspected
|
||||||
console.error(err.rawValue);
|
console.error(err.rawValue);
|
||||||
@@ -317,6 +312,7 @@ async function run() {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
default: {
|
default: {
|
||||||
|
// Other errors such as network errors, see HTTPClientErrors for more details
|
||||||
throw err;
|
throw err;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -327,66 +323,38 @@ 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.
|
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 multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
|
||||||
|
|
||||||
|
In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in 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 |
|
||||||
<!-- End Error Handling [errors] -->
|
<!-- End Error Handling [errors] -->
|
||||||
|
|
||||||
<!-- Start Server Selection [server] -->
|
<!-- Start Server Selection [server] -->
|
||||||
## Server Selection
|
## Server Selection
|
||||||
|
|
||||||
### Select Server by Index
|
### Server Variables
|
||||||
|
|
||||||
You can override the default server globally by passing a server index to the `serverIdx` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
|
The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following parameters are available when initializing the SDK client instance:
|
||||||
|
|
||||||
| # | Server | Variables |
|
|
||||||
| - | ------ | --------- |
|
|
||||||
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `https`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
|
||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
|
||||||
serverIdx: 0,
|
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
|
||||||
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
|
||||||
clientName: "Plex for Roku",
|
|
||||||
clientVersion: "2.4.1",
|
|
||||||
platform: "Roku",
|
|
||||||
deviceNickname: "Roku 3",
|
|
||||||
});
|
|
||||||
|
|
||||||
async function run() {
|
|
||||||
const result = await plexAPI.server.getServerCapabilities();
|
|
||||||
|
|
||||||
// Handle the result
|
|
||||||
console.log(result);
|
|
||||||
}
|
|
||||||
|
|
||||||
run();
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Variables
|
|
||||||
|
|
||||||
Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
|
|
||||||
* `protocol: models.ServerProtocol`
|
* `protocol: models.ServerProtocol`
|
||||||
* `ip: string`
|
* `ip: string`
|
||||||
* `port: string`
|
* `port: string`
|
||||||
|
|
||||||
### Override Server URL Per-Client
|
### Override Server URL Per-Client
|
||||||
|
|
||||||
The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example:
|
The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
serverURL: "{protocol}://{ip}:{port}",
|
serverURL: "https://10.10.10.47:32400",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
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() {
|
||||||
@@ -399,20 +367,15 @@ async function run() {
|
|||||||
run();
|
run();
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Override Server URL Per-Operation
|
### Override Server URL Per-Operation
|
||||||
|
|
||||||
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
|
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
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() {
|
||||||
@@ -485,9 +448,9 @@ const sdk = new PlexAPI({ httpClient });
|
|||||||
|
|
||||||
This SDK supports the following security scheme globally:
|
This SDK supports the following security scheme globally:
|
||||||
|
|
||||||
| Name | Type | Scheme |
|
| Name | Type | Scheme |
|
||||||
| ------------- | ------------- | ------------- |
|
| ------------- | ------ | ------- |
|
||||||
| `accessToken` | apiKey | API key |
|
| `accessToken` | apiKey | API key |
|
||||||
|
|
||||||
To authenticate with the API the `accessToken` parameter must be set when initializing the SDK client instance. For example:
|
To authenticate with the API the `accessToken` parameter must be set when initializing the SDK client instance. For example:
|
||||||
```typescript
|
```typescript
|
||||||
@@ -495,11 +458,6 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
|||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
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() {
|
||||||
@@ -535,83 +493,85 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|||||||
|
|
||||||
<summary>Available standalone functions</summary>
|
<summary>Available standalone functions</summary>
|
||||||
|
|
||||||
- [activitiesCancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities)
|
- [`activitiesCancelServerActivities`](docs/sdks/activities/README.md#cancelserveractivities) - Cancel Server Activities
|
||||||
- [activitiesGetServerActivities](docs/sdks/activities/README.md#getserveractivities)
|
- [`activitiesGetServerActivities`](docs/sdks/activities/README.md#getserveractivities) - Get Server Activities
|
||||||
- [authenticationGetSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation)
|
- [`authenticationGetSourceConnectionInformation`](docs/sdks/authentication/README.md#getsourceconnectioninformation) - Get Source Connection Information
|
||||||
- [authenticationGetTokenDetails](docs/sdks/authentication/README.md#gettokendetails)
|
- [`authenticationGetTokenDetails`](docs/sdks/authentication/README.md#gettokendetails) - Get Token Details
|
||||||
- [authenticationGetTransientToken](docs/sdks/authentication/README.md#gettransienttoken)
|
- [`authenticationGetTransientToken`](docs/sdks/authentication/README.md#gettransienttoken) - Get a Transient Token
|
||||||
- [authenticationPostUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata)
|
- [`authenticationPostUsersSignInData`](docs/sdks/authentication/README.md#postuserssignindata) - Get User Sign In Data
|
||||||
- [butlerGetButlerTasks](docs/sdks/butler/README.md#getbutlertasks)
|
- [`butlerGetButlerTasks`](docs/sdks/butler/README.md#getbutlertasks) - Get Butler tasks
|
||||||
- [butlerStartAllTasks](docs/sdks/butler/README.md#startalltasks)
|
- [`butlerStartAllTasks`](docs/sdks/butler/README.md#startalltasks) - Start all Butler tasks
|
||||||
- [butlerStartTask](docs/sdks/butler/README.md#starttask)
|
- [`butlerStartTask`](docs/sdks/butler/README.md#starttask) - Start a single Butler task
|
||||||
- [butlerStopAllTasks](docs/sdks/butler/README.md#stopalltasks)
|
- [`butlerStopAllTasks`](docs/sdks/butler/README.md#stopalltasks) - Stop all Butler tasks
|
||||||
- [butlerStopTask](docs/sdks/butler/README.md#stoptask)
|
- [`butlerStopTask`](docs/sdks/butler/README.md#stoptask) - Stop a single Butler task
|
||||||
- [hubsGetGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs)
|
- [`hubsGetGlobalHubs`](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
|
||||||
- [hubsGetLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs)
|
- [`hubsGetLibraryHubs`](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
||||||
- [hubsGetRecentlyAdded](docs/sdks/hubs/README.md#getrecentlyadded)
|
- [`hubsGetRecentlyAdded`](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
|
||||||
- [libraryDeleteLibrary](docs/sdks/library/README.md#deletelibrary)
|
- [`libraryDeleteLibrary`](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||||
- [libraryGetAllLibraries](docs/sdks/library/README.md#getalllibraries)
|
- [`libraryGetAllLibraries`](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
||||||
- [libraryGetFileHash](docs/sdks/library/README.md#getfilehash)
|
- [`libraryGetCountriesLibrary`](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
|
||||||
- [libraryGetLibraryDetails](docs/sdks/library/README.md#getlibrarydetails)
|
- [`libraryGetFileHash`](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||||
- [libraryGetLibraryItems](docs/sdks/library/README.md#getlibraryitems)
|
- [`libraryGetGenresLibrary`](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
||||||
- [libraryGetMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey)
|
- [`libraryGetLibraryDetails`](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||||
- [libraryGetMetadataChildren](docs/sdks/library/README.md#getmetadatachildren)
|
- [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||||
- [libraryGetOnDeck](docs/sdks/library/README.md#getondeck)
|
- [`libraryGetMetaDataByRatingKey`](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
||||||
- [libraryGetRecentlyAddedLibrary](docs/sdks/library/README.md#getrecentlyaddedlibrary)
|
- [`libraryGetMetadataChildren`](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||||
- [libraryGetRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata)
|
- [`libraryGetOnDeck`](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||||
- [libraryGetSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries)
|
- [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
|
||||||
- [libraryGetSearchLibrary](docs/sdks/library/README.md#getsearchlibrary)
|
- [`libraryGetRefreshLibraryMetadata`](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||||
- [libraryGetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent)
|
- [`libraryGetSearchAllLibraries`](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||||
- [logEnablePaperTrail](docs/sdks/log/README.md#enablepapertrail)
|
- [`libraryGetSearchLibrary`](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||||
- [logLogLine](docs/sdks/log/README.md#logline)
|
- [`libraryGetTopWatchedContent`](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||||
- [logLogMultiLine](docs/sdks/log/README.md#logmultiline)
|
- [`logEnablePaperTrail`](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
|
||||||
- [mediaGetBannerImage](docs/sdks/media/README.md#getbannerimage)
|
- [`logLogLine`](docs/sdks/log/README.md#logline) - Logging a single line message.
|
||||||
- [mediaGetThumbImage](docs/sdks/media/README.md#getthumbimage)
|
- [`logLogMultiLine`](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
|
||||||
- [mediaMarkPlayed](docs/sdks/media/README.md#markplayed)
|
- [`mediaGetBannerImage`](docs/sdks/media/README.md#getbannerimage) - Get Banner Image
|
||||||
- [mediaMarkUnplayed](docs/sdks/media/README.md#markunplayed)
|
- [`mediaGetThumbImage`](docs/sdks/media/README.md#getthumbimage) - Get Thumb Image
|
||||||
- [mediaUpdatePlayProgress](docs/sdks/media/README.md#updateplayprogress)
|
- [`mediaMarkPlayed`](docs/sdks/media/README.md#markplayed) - Mark Media Played
|
||||||
- [playlistsAddPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents)
|
- [`mediaMarkUnplayed`](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
|
||||||
- [playlistsClearPlaylistContents](docs/sdks/playlists/README.md#clearplaylistcontents)
|
- [`mediaUpdatePlayProgress`](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress
|
||||||
- [playlistsCreatePlaylist](docs/sdks/playlists/README.md#createplaylist)
|
- [`playlistsAddPlaylistContents`](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a Playlist
|
||||||
- [playlistsDeletePlaylist](docs/sdks/playlists/README.md#deleteplaylist)
|
- [`playlistsClearPlaylistContents`](docs/sdks/playlists/README.md#clearplaylistcontents) - Delete Playlist Contents
|
||||||
- [playlistsGetPlaylistContents](docs/sdks/playlists/README.md#getplaylistcontents)
|
- [`playlistsCreatePlaylist`](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
|
||||||
- [playlistsGetPlaylist](docs/sdks/playlists/README.md#getplaylist)
|
- [`playlistsDeletePlaylist`](docs/sdks/playlists/README.md#deleteplaylist) - Deletes a Playlist
|
||||||
- [playlistsGetPlaylists](docs/sdks/playlists/README.md#getplaylists)
|
- [`playlistsGetPlaylist`](docs/sdks/playlists/README.md#getplaylist) - Retrieve Playlist
|
||||||
- [playlistsUpdatePlaylist](docs/sdks/playlists/README.md#updateplaylist)
|
- [`playlistsGetPlaylistContents`](docs/sdks/playlists/README.md#getplaylistcontents) - Retrieve Playlist Contents
|
||||||
- [playlistsUploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist)
|
- [`playlistsGetPlaylists`](docs/sdks/playlists/README.md#getplaylists) - Get All Playlists
|
||||||
- [plexGetCompanionsData](docs/sdks/plex/README.md#getcompanionsdata)
|
- [`playlistsUpdatePlaylist`](docs/sdks/playlists/README.md#updateplaylist) - Update a Playlist
|
||||||
- [plexGetGeoData](docs/sdks/plex/README.md#getgeodata)
|
- [`playlistsUploadPlaylist`](docs/sdks/playlists/README.md#uploadplaylist) - Upload Playlist
|
||||||
- [plexGetHomeData](docs/sdks/plex/README.md#gethomedata)
|
- [`plexGetCompanionsData`](docs/sdks/plex/README.md#getcompanionsdata) - Get Companions Data
|
||||||
- [plexGetPin](docs/sdks/plex/README.md#getpin)
|
- [`plexGetGeoData`](docs/sdks/plex/README.md#getgeodata) - Get Geo Data
|
||||||
- [plexGetServerResources](docs/sdks/plex/README.md#getserverresources)
|
- [`plexGetHomeData`](docs/sdks/plex/README.md#gethomedata) - Get Plex Home Data
|
||||||
- [plexGetTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid)
|
- [`plexGetPin`](docs/sdks/plex/README.md#getpin) - Get a Pin
|
||||||
- [plexGetUserFriends](docs/sdks/plex/README.md#getuserfriends)
|
- [`plexGetServerResources`](docs/sdks/plex/README.md#getserverresources) - Get Server Resources
|
||||||
- [searchGetSearchResults](docs/sdks/search/README.md#getsearchresults)
|
- [`plexGetTokenByPinId`](docs/sdks/plex/README.md#gettokenbypinid) - Get Access Token by PinId
|
||||||
- [searchPerformSearch](docs/sdks/search/README.md#performsearch)
|
- [`plexGetUserFriends`](docs/sdks/plex/README.md#getuserfriends) - Get list of friends of the user logged in
|
||||||
- [searchPerformVoiceSearch](docs/sdks/search/README.md#performvoicesearch)
|
- [`searchGetSearchResults`](docs/sdks/search/README.md#getsearchresults) - Get Search Results
|
||||||
- [serverGetAvailableClients](docs/sdks/server/README.md#getavailableclients)
|
- [`searchPerformSearch`](docs/sdks/search/README.md#performsearch) - Perform a search
|
||||||
- [serverGetDevices](docs/sdks/server/README.md#getdevices)
|
- [`searchPerformVoiceSearch`](docs/sdks/search/README.md#performvoicesearch) - Perform a voice search
|
||||||
- [serverGetMediaProviders](docs/sdks/server/README.md#getmediaproviders)
|
- [`serverGetAvailableClients`](docs/sdks/server/README.md#getavailableclients) - Get Available Clients
|
||||||
- [serverGetMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount)
|
- [`serverGetDevices`](docs/sdks/server/README.md#getdevices) - Get Devices
|
||||||
- [serverGetResizedPhoto](docs/sdks/server/README.md#getresizedphoto)
|
- [`serverGetMediaProviders`](docs/sdks/server/README.md#getmediaproviders) - Get Media Providers
|
||||||
- [serverGetServerCapabilities](docs/sdks/server/README.md#getservercapabilities)
|
- [`serverGetMyPlexAccount`](docs/sdks/server/README.md#getmyplexaccount) - Get MyPlex Account
|
||||||
- [serverGetServerIdentity](docs/sdks/server/README.md#getserveridentity)
|
- [`serverGetResizedPhoto`](docs/sdks/server/README.md#getresizedphoto) - Get a Resized Photo
|
||||||
- [serverGetServerList](docs/sdks/server/README.md#getserverlist)
|
- [`serverGetServerCapabilities`](docs/sdks/server/README.md#getservercapabilities) - Get Server Capabilities
|
||||||
- [serverGetServerPreferences](docs/sdks/server/README.md#getserverpreferences)
|
- [`serverGetServerIdentity`](docs/sdks/server/README.md#getserveridentity) - Get Server Identity
|
||||||
- [sessionsGetSessionHistory](docs/sdks/sessions/README.md#getsessionhistory)
|
- [`serverGetServerList`](docs/sdks/server/README.md#getserverlist) - Get Server List
|
||||||
- [sessionsGetSessions](docs/sdks/sessions/README.md#getsessions)
|
- [`serverGetServerPreferences`](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
|
||||||
- [sessionsGetTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions)
|
- [`sessionsGetSessionHistory`](docs/sdks/sessions/README.md#getsessionhistory) - Get Session History
|
||||||
- [sessionsStopTranscodeSession](docs/sdks/sessions/README.md#stoptranscodesession)
|
- [`sessionsGetSessions`](docs/sdks/sessions/README.md#getsessions) - Get Active Sessions
|
||||||
- [statisticsGetBandwidthStatistics](docs/sdks/statistics/README.md#getbandwidthstatistics)
|
- [`sessionsGetTranscodeSessions`](docs/sdks/sessions/README.md#gettranscodesessions) - Get Transcode Sessions
|
||||||
- [statisticsGetResourcesStatistics](docs/sdks/statistics/README.md#getresourcesstatistics)
|
- [`sessionsStopTranscodeSession`](docs/sdks/sessions/README.md#stoptranscodesession) - Stop a Transcode Session
|
||||||
- [statisticsGetStatistics](docs/sdks/statistics/README.md#getstatistics)
|
- [`statisticsGetBandwidthStatistics`](docs/sdks/statistics/README.md#getbandwidthstatistics) - Get Bandwidth Statistics
|
||||||
- [updaterApplyUpdates](docs/sdks/updater/README.md#applyupdates)
|
- [`statisticsGetResourcesStatistics`](docs/sdks/statistics/README.md#getresourcesstatistics) - Get Resources Statistics
|
||||||
- [updaterCheckForUpdates](docs/sdks/updater/README.md#checkforupdates)
|
- [`statisticsGetStatistics`](docs/sdks/statistics/README.md#getstatistics) - Get Media Statistics
|
||||||
- [updaterGetUpdateStatus](docs/sdks/updater/README.md#getupdatestatus)
|
- [`updaterApplyUpdates`](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
||||||
- [videoGetTimeline](docs/sdks/video/README.md#gettimeline)
|
- [`updaterCheckForUpdates`](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
||||||
- [videoStartUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode)
|
- [`updaterGetUpdateStatus`](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
|
||||||
- [watchlistGetWatchList](docs/sdks/watchlist/README.md#getwatchlist)
|
- [`usersGetUsers`](docs/sdks/users/README.md#getusers) - Get list of all connected users
|
||||||
|
- [`videoGetTimeline`](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
||||||
|
- [`videoStartUniversalTranscode`](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
|
||||||
|
- [`watchlistGetWatchList`](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
<!-- End Standalone functions [standalone-funcs] -->
|
<!-- End Standalone functions [standalone-funcs] -->
|
||||||
@@ -627,11 +587,6 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
|||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
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() {
|
||||||
@@ -672,11 +627,6 @@ const plexAPI = new PlexAPI({
|
|||||||
retryConnectionErrors: false,
|
retryConnectionErrors: false,
|
||||||
},
|
},
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
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() {
|
||||||
|
|||||||
102
RELEASES.md
102
RELEASES.md
@@ -1108,4 +1108,104 @@ Based on:
|
|||||||
### Generated
|
### Generated
|
||||||
- [typescript v0.25.1] .
|
- [typescript v0.25.1] .
|
||||||
### Releases
|
### Releases
|
||||||
- [NPM v0.25.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.25.1 - .
|
- [NPM v0.25.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.25.1 - .
|
||||||
|
|
||||||
|
## 2024-10-03 12:26:50
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.26.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.26.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.26.1 - .
|
||||||
|
|
||||||
|
## 2024-11-11 20:28:21
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.28.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.28.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.28.0 - .
|
||||||
|
|
||||||
|
## 2024-11-14 00:09:39
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.30.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.30.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.30.0 - .
|
||||||
|
|
||||||
|
## 2024-12-16 22:17:52
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.31.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.31.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.31.1 - .
|
||||||
|
|
||||||
|
## 2024-12-20 16:01:16
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.456.1 (2.481.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.32.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.32.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.0 - .
|
||||||
|
|
||||||
|
## 2024-12-22 00:10:48
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.459.2 (2.483.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.32.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.32.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.1 - .
|
||||||
|
|
||||||
|
## 2025-01-24 00:09:35
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.474.0 (2.495.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.32.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.32.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.2 - .
|
||||||
|
|
||||||
|
## 2025-01-27 00:09:48
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.476.1 (2.495.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.32.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.32.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.3 - .
|
||||||
|
|
||||||
|
## 2025-02-05 00:09:58
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.32.4] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.32.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.4 - .
|
||||||
|
|
||||||
|
## 2025-02-06 00:09:46
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.32.5] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.32.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.5 - .
|
||||||
28
RUNTIMES.md
28
RUNTIMES.md
@@ -1,6 +1,6 @@
|
|||||||
# Supported JavaScript runtimes
|
# Supported JavaScript runtimes
|
||||||
|
|
||||||
This SDK is intended to be used in JavaScript runtimes that support the following features:
|
This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
|
||||||
|
|
||||||
* [Web Fetch API][web-fetch]
|
* [Web Fetch API][web-fetch]
|
||||||
* [Web Streams API][web-streams] and in particular `ReadableStream`
|
* [Web Streams API][web-streams] and in particular `ReadableStream`
|
||||||
@@ -20,3 +20,29 @@ Runtime environments that are explicitly supported are:
|
|||||||
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
|
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
|
||||||
|
|
||||||
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
|
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
|
||||||
|
|
||||||
|
## Recommended TypeScript compiler options
|
||||||
|
|
||||||
|
The following `tsconfig.json` options are recommended for projects using this
|
||||||
|
SDK in order to get static type support for features like async iterables,
|
||||||
|
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
|
||||||
|
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
|
||||||
|
so on):
|
||||||
|
|
||||||
|
[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
|
||||||
|
[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
|
||||||
|
[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
|
||||||
|
[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"target": "es2020", // or higher
|
||||||
|
"lib": ["es2020", "dom", "dom.iterable"],
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
While `target` can be set to older ECMAScript versions, it may result in extra,
|
||||||
|
unnecessary compatibility code being generated if you are not targeting old
|
||||||
|
runtimes.
|
||||||
5
USAGE.md
5
USAGE.md
@@ -4,11 +4,6 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
|||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
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() {
|
||||||
|
|||||||
526
codeSamples.yaml
526
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
18
docs/sdk/models/errors/getcountrieslibrarybadrequest.md
Normal file
18
docs/sdk/models/errors/getcountrieslibrarybadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetCountriesLibraryBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetCountriesLibraryErrors](../../../sdk/models/errors/getcountrieslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
21
docs/sdk/models/errors/getcountrieslibraryerrors.md
Normal file
21
docs/sdk/models/errors/getcountrieslibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetCountriesLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetCountriesLibraryErrors = {
|
||||||
|
code: 1000,
|
||||||
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
|
status: 400,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/getcountrieslibrarylibraryerrors.md
Normal file
21
docs/sdk/models/errors/getcountrieslibrarylibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetCountriesLibraryLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetCountriesLibraryLibraryErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/getcountrieslibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getcountrieslibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetCountriesLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetCountriesLibraryLibraryErrors](../../../sdk/models/errors/getcountrieslibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
18
docs/sdk/models/errors/getgenreslibrarybadrequest.md
Normal file
18
docs/sdk/models/errors/getgenreslibrarybadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetGenresLibraryBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetGenresLibraryErrors](../../../sdk/models/errors/getgenreslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
21
docs/sdk/models/errors/getgenreslibraryerrors.md
Normal file
21
docs/sdk/models/errors/getgenreslibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetGenresLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetGenresLibraryErrors = {
|
||||||
|
code: 1000,
|
||||||
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
|
status: 400,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/getgenreslibrarylibraryerrors.md
Normal file
21
docs/sdk/models/errors/getgenreslibrarylibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetGenresLibraryLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetGenresLibraryLibraryErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/getgenreslibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getgenreslibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetGenresLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetGenresLibraryLibraryErrors](../../../sdk/models/errors/getgenreslibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
18
docs/sdk/models/errors/getusersbadrequest.md
Normal file
18
docs/sdk/models/errors/getusersbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetUsersBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetUsersBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetUsersErrors](../../../sdk/models/errors/getuserserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
21
docs/sdk/models/errors/getuserserrors.md
Normal file
21
docs/sdk/models/errors/getuserserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetUsersErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetUsersErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetUsersErrors = {
|
||||||
|
code: 1000,
|
||||||
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
|
status: 400,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
18
docs/sdk/models/errors/getusersunauthorized.md
Normal file
18
docs/sdk/models/errors/getusersunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetUsersUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetUsersUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetUsersUsersErrors](../../../sdk/models/errors/getusersuserserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
21
docs/sdk/models/errors/getusersuserserrors.md
Normal file
21
docs/sdk/models/errors/getusersuserserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetUsersUsersErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetUsersUsersErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetUsersUsersErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -6,7 +6,7 @@
|
|||||||
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: AddPlaylistContentsRequest = {
|
let value: AddPlaylistContentsRequest = {
|
||||||
playlistID: 6289.82,
|
playlistID: 1856.36,
|
||||||
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
||||||
playQueueID: 123,
|
playQueueID: 123,
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { AddPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operat
|
|||||||
|
|
||||||
let value: AddPlaylistContentsResponse = {
|
let value: AddPlaylistContentsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 503,
|
statusCode: 507,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
18
docs/sdk/models/operations/alllibraries.md
Normal file
18
docs/sdk/models/operations/alllibraries.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# AllLibraries
|
||||||
|
|
||||||
|
Indicates if the user has access to all libraries.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AllLibraries } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: AllLibraries = AllLibraries.Enable;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
18
docs/sdk/models/operations/allowcameraupload.md
Normal file
18
docs/sdk/models/operations/allowcameraupload.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# AllowCameraUpload
|
||||||
|
|
||||||
|
Indicates if the user is allowed to upload from a camera.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AllowCameraUpload } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: AllowCameraUpload = AllowCameraUpload.Enable;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
18
docs/sdk/models/operations/allowchannels.md
Normal file
18
docs/sdk/models/operations/allowchannels.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# AllowChannels
|
||||||
|
|
||||||
|
Indicates if the user has access to channels.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AllowChannels } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: AllowChannels = AllowChannels.Enable;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
18
docs/sdk/models/operations/allowsubtitleadmin.md
Normal file
18
docs/sdk/models/operations/allowsubtitleadmin.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# AllowSubtitleAdmin
|
||||||
|
|
||||||
|
Indicates if the user can manage subtitles.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AllowSubtitleAdmin } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: AllowSubtitleAdmin = AllowSubtitleAdmin.Enable;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
18
docs/sdk/models/operations/allowsync.md
Normal file
18
docs/sdk/models/operations/allowsync.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# AllowSync
|
||||||
|
|
||||||
|
Indicates if the user is allowed to sync media.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AllowSync } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: AllowSync = AllowSync.Enable;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
18
docs/sdk/models/operations/allowtuners.md
Normal file
18
docs/sdk/models/operations/allowtuners.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# AllowTuners
|
||||||
|
|
||||||
|
Indicates if the user is allowed to use tuners.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AllowTuners } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: AllowTuners = AllowTuners.Enable;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
@@ -7,7 +7,7 @@ import { ApplyUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: ApplyUpdatesResponse = {
|
let value: ApplyUpdatesResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 103,
|
statusCode: 205,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { Billing } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: Billing = {
|
let value: Billing = {
|
||||||
internalPaymentMethod: {},
|
internalPaymentMethod: {},
|
||||||
paymentMethodId: 374170,
|
paymentMethodId: 863856,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { CheckForUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations
|
|||||||
|
|
||||||
let value: CheckForUpdatesResponse = {
|
let value: CheckForUpdatesResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 201,
|
statusCode: 424,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: ClearPlaylistContentsRequest = {
|
let value: ClearPlaylistContentsRequest = {
|
||||||
playlistID: 3834.64,
|
playlistID: 8726.51,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { ClearPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/oper
|
|||||||
|
|
||||||
let value: ClearPlaylistContentsResponse = {
|
let value: ClearPlaylistContentsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 307,
|
statusCode: 207,
|
||||||
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 @@ type of playlist to create
|
|||||||
```typescript
|
```typescript
|
||||||
import { CreatePlaylistQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { CreatePlaylistQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Audio;
|
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Video;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|||||||
@@ -7,9 +7,9 @@ import { CreatePlaylistQueryParamType, CreatePlaylistRequest, Smart } from "@luk
|
|||||||
|
|
||||||
let value: CreatePlaylistRequest = {
|
let value: CreatePlaylistRequest = {
|
||||||
title: "<value>",
|
title: "<value>",
|
||||||
type: CreatePlaylistQueryParamType.Photo,
|
type: CreatePlaylistQueryParamType.Audio,
|
||||||
smart: Smart.One,
|
smart: Smart.Zero,
|
||||||
uri: "https://enchanted-disclosure.com/",
|
uri: "https://general-possession.info/",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { CreatePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
|||||||
|
|
||||||
let value: CreatePlaylistResponse = {
|
let value: CreatePlaylistResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 302,
|
statusCode: 100,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: DeletePlaylistRequest = {
|
let value: DeletePlaylistRequest = {
|
||||||
playlistID: 5365.79,
|
playlistID: 6630.78,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { DeletePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
|||||||
|
|
||||||
let value: DeletePlaylistResponse = {
|
let value: DeletePlaylistResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 511,
|
statusCode: 200,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
19
docs/sdk/models/operations/enablecreditsmarkergeneration.md
Normal file
19
docs/sdk/models/operations/enablecreditsmarkergeneration.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# EnableCreditsMarkerGeneration
|
||||||
|
|
||||||
|
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { EnableCreditsMarkerGeneration } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: EnableCreditsMarkerGeneration =
|
||||||
|
EnableCreditsMarkerGeneration.LibraryDefault;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------- | ---------------- |
|
||||||
|
| `LibraryDefault` | -1 |
|
||||||
|
| `Disabled` | 0 |
|
||||||
@@ -7,7 +7,7 @@ import { EnablePaperTrailResponse } from "@lukehagar/plexjs/sdk/models/operation
|
|||||||
|
|
||||||
let value: EnablePaperTrailResponse = {
|
let value: EnablePaperTrailResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 203,
|
statusCode: 508,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
19
docs/sdk/models/operations/episodesort.md
Normal file
19
docs/sdk/models/operations/episodesort.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# EpisodeSort
|
||||||
|
|
||||||
|
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { EpisodeSort } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: EpisodeSort = EpisodeSort.OldestFirst;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------- | ---------------- |
|
||||||
|
| `LibraryDefault` | -1 |
|
||||||
|
| `OldestFirst` | 0 |
|
||||||
|
| `NewestFirst` | 1 |
|
||||||
@@ -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.Available;
|
let value: Filter = Filter.All;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|||||||
@@ -1,16 +1,19 @@
|
|||||||
# FlattenSeasons
|
# FlattenSeasons
|
||||||
|
|
||||||
|
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { FlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
|
import { FlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: FlattenSeasons = FlattenSeasons.True;
|
let value: FlattenSeasons = FlattenSeasons.Show;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| ------- | ------- |
|
| ---------------- | ---------------- |
|
||||||
| `False` | 0 |
|
| `LibraryDefault` | -1 |
|
||||||
| `True` | 1 |
|
| `Hide` | 0 |
|
||||||
|
| `Show` | 1 |
|
||||||
@@ -10,13 +10,8 @@ let value: Friend = {
|
|||||||
friendlyName: "exampleUser",
|
friendlyName: "exampleUser",
|
||||||
home: true,
|
home: true,
|
||||||
id: 0,
|
id: 0,
|
||||||
restricted: false,
|
sharedServers: [],
|
||||||
sharedServers: [
|
sharedSources: [],
|
||||||
{},
|
|
||||||
],
|
|
||||||
sharedSources: [
|
|
||||||
{},
|
|
||||||
],
|
|
||||||
status: Status.Accepted,
|
status: Status.Accepted,
|
||||||
thumb: "https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578",
|
thumb: "https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578",
|
||||||
title: "username123",
|
title: "username123",
|
||||||
|
|||||||
@@ -12,11 +12,8 @@ let value: GeoData = {
|
|||||||
continentCode: "NA",
|
continentCode: "NA",
|
||||||
country: "United States Virgin Islands",
|
country: "United States Virgin Islands",
|
||||||
city: "Amsterdam",
|
city: "Amsterdam",
|
||||||
europeanUnionMember: true,
|
|
||||||
timeZone: "America/St_Thomas",
|
timeZone: "America/St_Thomas",
|
||||||
postalCode: "802",
|
postalCode: "802",
|
||||||
inPrivacyRestrictedCountry: true,
|
|
||||||
inPrivacyRestrictedRegion: true,
|
|
||||||
subdivisions: "Saint Thomas",
|
subdivisions: "Saint Thomas",
|
||||||
coordinates: "18.3381, -64.8941",
|
coordinates: "18.3381, -64.8941",
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs/sdk/models/ope
|
|||||||
|
|
||||||
let value: GetBandwidthStatisticsResponse = {
|
let value: GetBandwidthStatisticsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 101,
|
statusCode: 423,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
21
docs/sdk/models/operations/getcountrieslibrarydirectory.md
Normal file
21
docs/sdk/models/operations/getcountrieslibrarydirectory.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetCountriesLibraryDirectory
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryDirectory } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetCountriesLibraryDirectory = {
|
||||||
|
fastKey: "/library/sections/2/all?country=15491",
|
||||||
|
key: "15491",
|
||||||
|
title: "Japan",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
|
||||||
|
| `fastKey` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?country=15491 |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | N/A | 15491 |
|
||||||
|
| `title` | *string* | :heavy_check_mark: | N/A | Japan |
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
# GetCountriesLibraryMediaContainer
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetCountriesLibraryMediaContainer = {
|
||||||
|
size: 50,
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
allowSync: false,
|
||||||
|
art: "/:/resources/show-fanart.jpg",
|
||||||
|
content: "secondary",
|
||||||
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
|
mediaTagVersion: 1734362201,
|
||||||
|
nocache: true,
|
||||||
|
thumb: "/:/resources/show.png",
|
||||||
|
title1: "TV Series",
|
||||||
|
title2: "By Country",
|
||||||
|
viewGroup: "secondary",
|
||||||
|
directory: [
|
||||||
|
{
|
||||||
|
fastKey: "/library/sections/2/all?country=15491",
|
||||||
|
key: "15491",
|
||||||
|
title: "Japan",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
|
||||||
|
| `offset` | *number* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `totalSize` | *number* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
||||||
|
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||||
|
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
|
||||||
|
| `content` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||||
|
| `mediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
||||||
|
| `mediaTagVersion` | *number* | :heavy_check_mark: | N/A | 1734362201 |
|
||||||
|
| `nocache` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||||
|
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/show.png |
|
||||||
|
| `title1` | *string* | :heavy_check_mark: | N/A | TV Series |
|
||||||
|
| `title2` | *string* | :heavy_check_mark: | N/A | By Country |
|
||||||
|
| `viewGroup` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||||
|
| `directory` | [operations.GetCountriesLibraryDirectory](../../../sdk/models/operations/getcountrieslibrarydirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
17
docs/sdk/models/operations/getcountrieslibraryrequest.md
Normal file
17
docs/sdk/models/operations/getcountrieslibraryrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetCountriesLibraryRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetCountriesLibraryRequest = {
|
||||||
|
sectionKey: 9518,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
47
docs/sdk/models/operations/getcountrieslibraryresponse.md
Normal file
47
docs/sdk/models/operations/getcountrieslibraryresponse.md
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
# GetCountriesLibraryResponse
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetCountriesLibraryResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 300,
|
||||||
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
}),
|
||||||
|
object: {
|
||||||
|
mediaContainer: {
|
||||||
|
size: 50,
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
allowSync: false,
|
||||||
|
art: "/:/resources/show-fanart.jpg",
|
||||||
|
content: "secondary",
|
||||||
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
|
mediaTagVersion: 1734362201,
|
||||||
|
nocache: true,
|
||||||
|
thumb: "/:/resources/show.png",
|
||||||
|
title1: "TV Series",
|
||||||
|
title2: "By Country",
|
||||||
|
viewGroup: "secondary",
|
||||||
|
directory: [
|
||||||
|
{
|
||||||
|
fastKey: "/library/sections/2/all?country=15491",
|
||||||
|
key: "15491",
|
||||||
|
title: "Japan",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [operations.GetCountriesLibraryResponseBody](../../../sdk/models/operations/getcountrieslibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
# GetCountriesLibraryResponseBody
|
||||||
|
|
||||||
|
Successful response containing media container data.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetCountriesLibraryResponseBody = {
|
||||||
|
mediaContainer: {
|
||||||
|
size: 50,
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
allowSync: false,
|
||||||
|
art: "/:/resources/show-fanart.jpg",
|
||||||
|
content: "secondary",
|
||||||
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
|
mediaTagVersion: 1734362201,
|
||||||
|
nocache: true,
|
||||||
|
thumb: "/:/resources/show.png",
|
||||||
|
title1: "TV Series",
|
||||||
|
title2: "By Country",
|
||||||
|
viewGroup: "secondary",
|
||||||
|
directory: [
|
||||||
|
{
|
||||||
|
fastKey: "/library/sections/2/all?country=15491",
|
||||||
|
key: "15491",
|
||||||
|
title: "Japan",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `mediaContainer` | [operations.GetCountriesLibraryMediaContainer](../../../sdk/models/operations/getcountrieslibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
23
docs/sdk/models/operations/getgenreslibrarydirectory.md
Normal file
23
docs/sdk/models/operations/getgenreslibrarydirectory.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# GetGenresLibraryDirectory
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryDirectory } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetGenresLibraryDirectory = {
|
||||||
|
fastKey: "/library/sections/10/all?genre=89",
|
||||||
|
key: "89",
|
||||||
|
title: "Action",
|
||||||
|
type: "genre",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
|
||||||
|
| `fastKey` | *string* | :heavy_check_mark: | N/A | /library/sections/10/all?genre=89 |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | N/A | 89 |
|
||||||
|
| `title` | *string* | :heavy_check_mark: | N/A | Action |
|
||||||
|
| `type` | *string* | :heavy_check_mark: | N/A | genre |
|
||||||
50
docs/sdk/models/operations/getgenreslibrarymediacontainer.md
Normal file
50
docs/sdk/models/operations/getgenreslibrarymediacontainer.md
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
# GetGenresLibraryMediaContainer
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetGenresLibraryMediaContainer = {
|
||||||
|
size: 50,
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
allowSync: false,
|
||||||
|
art: "/:/resources/show-fanart.jpg",
|
||||||
|
content: "secondary",
|
||||||
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
|
mediaTagVersion: 1734362201,
|
||||||
|
nocache: true,
|
||||||
|
thumb: "/:/resources/show.png",
|
||||||
|
title1: "TV Shows (Reality)",
|
||||||
|
title2: "By Genre",
|
||||||
|
viewGroup: "secondary",
|
||||||
|
directory: [
|
||||||
|
{
|
||||||
|
fastKey: "/library/sections/10/all?genre=89",
|
||||||
|
key: "89",
|
||||||
|
title: "Action",
|
||||||
|
type: "genre",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
|
||||||
|
| `offset` | *number* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `totalSize` | *number* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
||||||
|
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||||
|
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
|
||||||
|
| `content` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||||
|
| `mediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
||||||
|
| `mediaTagVersion` | *number* | :heavy_check_mark: | N/A | 1734362201 |
|
||||||
|
| `nocache` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||||
|
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/show.png |
|
||||||
|
| `title1` | *string* | :heavy_check_mark: | N/A | TV Shows (Reality) |
|
||||||
|
| `title2` | *string* | :heavy_check_mark: | N/A | By Genre |
|
||||||
|
| `viewGroup` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||||
|
| `directory` | [operations.GetGenresLibraryDirectory](../../../sdk/models/operations/getgenreslibrarydirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
17
docs/sdk/models/operations/getgenreslibraryrequest.md
Normal file
17
docs/sdk/models/operations/getgenreslibraryrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetGenresLibraryRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetGenresLibraryRequest = {
|
||||||
|
sectionKey: 9518,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
48
docs/sdk/models/operations/getgenreslibraryresponse.md
Normal file
48
docs/sdk/models/operations/getgenreslibraryresponse.md
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
# GetGenresLibraryResponse
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetGenresLibraryResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 506,
|
||||||
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
}),
|
||||||
|
object: {
|
||||||
|
mediaContainer: {
|
||||||
|
size: 50,
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
allowSync: false,
|
||||||
|
art: "/:/resources/show-fanart.jpg",
|
||||||
|
content: "secondary",
|
||||||
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
|
mediaTagVersion: 1734362201,
|
||||||
|
nocache: true,
|
||||||
|
thumb: "/:/resources/show.png",
|
||||||
|
title1: "TV Shows (Reality)",
|
||||||
|
title2: "By Genre",
|
||||||
|
viewGroup: "secondary",
|
||||||
|
directory: [
|
||||||
|
{
|
||||||
|
fastKey: "/library/sections/10/all?genre=89",
|
||||||
|
key: "89",
|
||||||
|
title: "Action",
|
||||||
|
type: "genre",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [operations.GetGenresLibraryResponseBody](../../../sdk/models/operations/getgenreslibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||||
40
docs/sdk/models/operations/getgenreslibraryresponsebody.md
Normal file
40
docs/sdk/models/operations/getgenreslibraryresponsebody.md
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
# GetGenresLibraryResponseBody
|
||||||
|
|
||||||
|
Successful response containing media container data.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetGenresLibraryResponseBody = {
|
||||||
|
mediaContainer: {
|
||||||
|
size: 50,
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
allowSync: false,
|
||||||
|
art: "/:/resources/show-fanart.jpg",
|
||||||
|
content: "secondary",
|
||||||
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
|
mediaTagVersion: 1734362201,
|
||||||
|
nocache: true,
|
||||||
|
thumb: "/:/resources/show.png",
|
||||||
|
title1: "TV Shows (Reality)",
|
||||||
|
title2: "By Genre",
|
||||||
|
viewGroup: "secondary",
|
||||||
|
directory: [
|
||||||
|
{
|
||||||
|
fastKey: "/library/sections/10/all?genre=89",
|
||||||
|
key: "89",
|
||||||
|
title: "Action",
|
||||||
|
type: "genre",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `mediaContainer` | [operations.GetGenresLibraryMediaContainer](../../../sdk/models/operations/getgenreslibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -12,11 +12,8 @@ let value: GetGeoDataGeoData = {
|
|||||||
continentCode: "NA",
|
continentCode: "NA",
|
||||||
country: "United States Virgin Islands",
|
country: "United States Virgin Islands",
|
||||||
city: "Amsterdam",
|
city: "Amsterdam",
|
||||||
europeanUnionMember: true,
|
|
||||||
timeZone: "America/St_Thomas",
|
timeZone: "America/St_Thomas",
|
||||||
postalCode: "802",
|
postalCode: "802",
|
||||||
inPrivacyRestrictedCountry: true,
|
|
||||||
inPrivacyRestrictedRegion: true,
|
|
||||||
subdivisions: "Saint Thomas",
|
subdivisions: "Saint Thomas",
|
||||||
coordinates: "18.3381, -64.8941",
|
coordinates: "18.3381, -64.8941",
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -16,11 +16,8 @@ let value: GetGeoDataResponse = {
|
|||||||
continentCode: "NA",
|
continentCode: "NA",
|
||||||
country: "United States Virgin Islands",
|
country: "United States Virgin Islands",
|
||||||
city: "Amsterdam",
|
city: "Amsterdam",
|
||||||
europeanUnionMember: true,
|
|
||||||
timeZone: "America/St_Thomas",
|
timeZone: "America/St_Thomas",
|
||||||
postalCode: "802",
|
postalCode: "802",
|
||||||
inPrivacyRestrictedCountry: true,
|
|
||||||
inPrivacyRestrictedRegion: true,
|
|
||||||
subdivisions: "Saint Thomas",
|
subdivisions: "Saint Thomas",
|
||||||
coordinates: "18.3381, -64.8941",
|
coordinates: "18.3381, -64.8941",
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -0,0 +1,19 @@
|
|||||||
|
# GetLibraryItemsEnableCreditsMarkerGeneration
|
||||||
|
|
||||||
|
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsEnableCreditsMarkerGeneration } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsEnableCreditsMarkerGeneration =
|
||||||
|
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------- | ---------------- |
|
||||||
|
| `LibraryDefault` | -1 |
|
||||||
|
| `Disabled` | 0 |
|
||||||
19
docs/sdk/models/operations/getlibraryitemsepisodesort.md
Normal file
19
docs/sdk/models/operations/getlibraryitemsepisodesort.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# GetLibraryItemsEpisodeSort
|
||||||
|
|
||||||
|
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsEpisodeSort } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsEpisodeSort = GetLibraryItemsEpisodeSort.OldestFirst;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------- | ---------------- |
|
||||||
|
| `LibraryDefault` | -1 |
|
||||||
|
| `OldestFirst` | 0 |
|
||||||
|
| `NewestFirst` | 1 |
|
||||||
@@ -1,16 +1,19 @@
|
|||||||
# GetLibraryItemsFlattenSeasons
|
# GetLibraryItemsFlattenSeasons
|
||||||
|
|
||||||
|
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsFlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsFlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsFlattenSeasons = GetLibraryItemsFlattenSeasons.True;
|
let value: GetLibraryItemsFlattenSeasons = GetLibraryItemsFlattenSeasons.Show;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| ------- | ------- |
|
| ---------------- | ---------------- |
|
||||||
| `False` | 0 |
|
| `LibraryDefault` | -1 |
|
||||||
| `True` | 1 |
|
| `Hide` | 0 |
|
||||||
|
| `Show` | 1 |
|
||||||
@@ -3,11 +3,7 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import { GetLibraryItemsLibraryResponseType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
GetLibraryItemsLibraryActiveDirection,
|
|
||||||
GetLibraryItemsLibraryDefaultDirection,
|
|
||||||
GetLibraryItemsLibraryResponseType,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsLibraryResponseType = {
|
let value: GetLibraryItemsLibraryResponseType = {
|
||||||
key: "/library/sections/2/all?type=2",
|
key: "/library/sections/2/all?type=2",
|
||||||
@@ -27,8 +23,6 @@ let value: GetLibraryItemsLibraryResponseType = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
|
|
||||||
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
@@ -3,17 +3,11 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import { GetLibraryItemsLibrarySort } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
GetLibraryItemsLibraryActiveDirection,
|
|
||||||
GetLibraryItemsLibraryDefaultDirection,
|
|
||||||
GetLibraryItemsLibrarySort,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsLibrarySort = {
|
let value: GetLibraryItemsLibrarySort = {
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
|
|
||||||
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
@@ -3,11 +3,7 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import { GetLibraryItemsMedia } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
GetLibraryItemsHasThumbnail,
|
|
||||||
GetLibraryItemsMedia,
|
|
||||||
GetLibraryItemsOptimizedForStreaming,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsMedia = {
|
let value: GetLibraryItemsMedia = {
|
||||||
id: 119534,
|
id: 119534,
|
||||||
@@ -25,7 +21,6 @@ let value: GetLibraryItemsMedia = {
|
|||||||
videoFrameRate: "24p",
|
videoFrameRate: "24p",
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
hasVoiceActivity: false,
|
hasVoiceActivity: false,
|
||||||
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
|
||||||
has64bitOffsets: false,
|
has64bitOffsets: false,
|
||||||
part: [
|
part: [
|
||||||
{
|
{
|
||||||
@@ -41,7 +36,6 @@ let value: GetLibraryItemsMedia = {
|
|||||||
optimizedForStreaming: false,
|
optimizedForStreaming: false,
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
indexes: "sd",
|
indexes: "sd",
|
||||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
|
||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 272796,
|
id: 272796,
|
||||||
|
|||||||
@@ -7,16 +7,12 @@ The Meta object is only included in the response if the `includeMeta` parameter
|
|||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import {
|
||||||
GetLibraryItemsActiveDirection,
|
GetLibraryItemsEnableCreditsMarkerGeneration,
|
||||||
GetLibraryItemsDefaultDirection,
|
GetLibraryItemsEpisodeSort,
|
||||||
GetLibraryItemsFlattenSeasons,
|
GetLibraryItemsFlattenSeasons,
|
||||||
GetLibraryItemsHasThumbnail,
|
|
||||||
GetLibraryItemsLibraryActiveDirection,
|
|
||||||
GetLibraryItemsLibraryDefaultDirection,
|
|
||||||
GetLibraryItemsLibraryResponse200Type,
|
GetLibraryItemsLibraryResponse200Type,
|
||||||
GetLibraryItemsLibraryType,
|
GetLibraryItemsLibraryType,
|
||||||
GetLibraryItemsMediaContainer,
|
GetLibraryItemsMediaContainer,
|
||||||
GetLibraryItemsOptimizedForStreaming,
|
|
||||||
GetLibraryItemsShowOrdering,
|
GetLibraryItemsShowOrdering,
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||||
@@ -41,8 +37,6 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsActiveDirection.Ascending,
|
|
||||||
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
@@ -110,8 +104,11 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
year: 2022,
|
year: 2022,
|
||||||
seasonCount: 2022,
|
seasonCount: 2022,
|
||||||
tagline: "Return to Pandora.",
|
tagline: "Return to Pandora.",
|
||||||
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
|
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
|
||||||
showOrdering: GetLibraryItemsShowOrdering.Dvd,
|
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
|
||||||
|
enableCreditsMarkerGeneration:
|
||||||
|
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
|
||||||
|
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
|
||||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||||
art: "/library/metadata/58683/art/1703239236",
|
art: "/library/metadata/58683/art/1703239236",
|
||||||
banner: "/library/metadata/58683/banner/1703239236",
|
banner: "/library/metadata/58683/banner/1703239236",
|
||||||
@@ -149,7 +146,6 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
videoFrameRate: "24p",
|
videoFrameRate: "24p",
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
hasVoiceActivity: false,
|
hasVoiceActivity: false,
|
||||||
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
|
||||||
has64bitOffsets: false,
|
has64bitOffsets: false,
|
||||||
part: [
|
part: [
|
||||||
{
|
{
|
||||||
@@ -165,7 +161,6 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
optimizedForStreaming: false,
|
optimizedForStreaming: false,
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
indexes: "sd",
|
indexes: "sd",
|
||||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
|
||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 272796,
|
id: 272796,
|
||||||
@@ -322,8 +317,6 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
|
|
||||||
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
@@ -380,5 +373,5 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
| `viewGroup` | *string* | :heavy_check_mark: | N/A | movie |
|
| `viewGroup` | *string* | :heavy_check_mark: | N/A | movie |
|
||||||
| `viewMode` | *number* | :heavy_minus_sign: | N/A | 65592 |
|
| `viewMode` | *number* | :heavy_minus_sign: | N/A | 65592 |
|
||||||
| `mixedParents` | *boolean* | :heavy_minus_sign: | N/A | true |
|
| `mixedParents` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
| `metadata` | [operations.GetLibraryItemsMetadata](../../../sdk/models/operations/getlibraryitemsmetadata.md)[] | :heavy_check_mark: | N/A | |
|
| `metadata` | [operations.GetLibraryItemsMetadata](../../../sdk/models/operations/getlibraryitemsmetadata.md)[] | :heavy_minus_sign: | 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/> | |
|
| `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/> | |
|
||||||
@@ -6,11 +6,7 @@ The Meta object is only included in the response if the `includeMeta` parameter
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import { GetLibraryItemsMeta } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
GetLibraryItemsLibraryActiveDirection,
|
|
||||||
GetLibraryItemsLibraryDefaultDirection,
|
|
||||||
GetLibraryItemsMeta,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsMeta = {
|
let value: GetLibraryItemsMeta = {
|
||||||
type: [
|
type: [
|
||||||
@@ -32,8 +28,6 @@ let value: GetLibraryItemsMeta = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
|
|
||||||
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
@@ -4,12 +4,12 @@
|
|||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import {
|
||||||
|
GetLibraryItemsEnableCreditsMarkerGeneration,
|
||||||
|
GetLibraryItemsEpisodeSort,
|
||||||
GetLibraryItemsFlattenSeasons,
|
GetLibraryItemsFlattenSeasons,
|
||||||
GetLibraryItemsHasThumbnail,
|
|
||||||
GetLibraryItemsLibraryResponse200Type,
|
GetLibraryItemsLibraryResponse200Type,
|
||||||
GetLibraryItemsLibraryType,
|
GetLibraryItemsLibraryType,
|
||||||
GetLibraryItemsMetadata,
|
GetLibraryItemsMetadata,
|
||||||
GetLibraryItemsOptimizedForStreaming,
|
|
||||||
GetLibraryItemsShowOrdering,
|
GetLibraryItemsShowOrdering,
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||||
@@ -34,8 +34,11 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
year: 2022,
|
year: 2022,
|
||||||
seasonCount: 2022,
|
seasonCount: 2022,
|
||||||
tagline: "Return to Pandora.",
|
tagline: "Return to Pandora.",
|
||||||
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
|
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
|
||||||
showOrdering: GetLibraryItemsShowOrdering.Dvd,
|
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
|
||||||
|
enableCreditsMarkerGeneration:
|
||||||
|
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
|
||||||
|
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
|
||||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||||
art: "/library/metadata/58683/art/1703239236",
|
art: "/library/metadata/58683/art/1703239236",
|
||||||
banner: "/library/metadata/58683/banner/1703239236",
|
banner: "/library/metadata/58683/banner/1703239236",
|
||||||
@@ -73,7 +76,6 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
videoFrameRate: "24p",
|
videoFrameRate: "24p",
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
hasVoiceActivity: false,
|
hasVoiceActivity: false,
|
||||||
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
|
||||||
has64bitOffsets: false,
|
has64bitOffsets: false,
|
||||||
part: [
|
part: [
|
||||||
{
|
{
|
||||||
@@ -89,7 +91,6 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
optimizedForStreaming: false,
|
optimizedForStreaming: false,
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
indexes: "sd",
|
indexes: "sd",
|
||||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
|
||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 272796,
|
id: 272796,
|
||||||
@@ -249,8 +250,10 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
| `year` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
| `year` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
||||||
| `seasonCount` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
| `seasonCount` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
||||||
| `tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
| `tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||||
| `flattenSeasons` | [operations.GetLibraryItemsFlattenSeasons](../../../sdk/models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
|
| `flattenSeasons` | [operations.GetLibraryItemsFlattenSeasons](../../../sdk/models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
|
||||||
| `showOrdering` | [operations.GetLibraryItemsShowOrdering](../../../sdk/models/operations/getlibraryitemsshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
|
| `episodeSort` | [operations.GetLibraryItemsEpisodeSort](../../../sdk/models/operations/getlibraryitemsepisodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
|
||||||
|
| `enableCreditsMarkerGeneration` | [operations.GetLibraryItemsEnableCreditsMarkerGeneration](../../../sdk/models/operations/getlibraryitemsenablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
||||||
|
| `showOrdering` | [operations.GetLibraryItemsShowOrdering](../../../sdk/models/operations/getlibraryitemsshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
|
||||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||||
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||||
| `banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
| `banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsHasThumbnail, GetLibraryItemsPart } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsPart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsPart = {
|
let value: GetLibraryItemsPart = {
|
||||||
id: 119542,
|
id: 119542,
|
||||||
@@ -18,7 +18,6 @@ let value: GetLibraryItemsPart = {
|
|||||||
optimizedForStreaming: false,
|
optimizedForStreaming: false,
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
indexes: "sd",
|
indexes: "sd",
|
||||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
|
||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 272796,
|
id: 272796,
|
||||||
|
|||||||
@@ -23,4 +23,7 @@ let value: GetLibraryItemsQueryParamType = GetLibraryItemsQueryParamType.TvShow;
|
|||||||
| `Movie` | 1 |
|
| `Movie` | 1 |
|
||||||
| `TvShow` | 2 |
|
| `TvShow` | 2 |
|
||||||
| `Season` | 3 |
|
| `Season` | 3 |
|
||||||
| `Episode` | 4 |
|
| `Episode` | 4 |
|
||||||
|
| `Audio` | 8 |
|
||||||
|
| `Album` | 9 |
|
||||||
|
| `Track` | 10 |
|
||||||
@@ -3,22 +3,12 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import { GetLibraryItemsQueryParamType, GetLibraryItemsRequest, Tag } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
GetLibraryItemsQueryParamIncludeMeta,
|
|
||||||
GetLibraryItemsQueryParamType,
|
|
||||||
GetLibraryItemsRequest,
|
|
||||||
IncludeGuids,
|
|
||||||
Tag,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsRequest = {
|
let value: GetLibraryItemsRequest = {
|
||||||
tag: Tag.FirstCharacter,
|
tag: Tag.Folder,
|
||||||
includeGuids: IncludeGuids.Enable,
|
|
||||||
type: GetLibraryItemsQueryParamType.TvShow,
|
type: GetLibraryItemsQueryParamType.TvShow,
|
||||||
sectionKey: 9518,
|
sectionKey: 9518,
|
||||||
includeMeta: GetLibraryItemsQueryParamIncludeMeta.Enable,
|
|
||||||
xPlexContainerStart: 0,
|
|
||||||
xPlexContainerSize: 50,
|
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -4,15 +4,11 @@
|
|||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import {
|
||||||
GetLibraryItemsActiveDirection,
|
GetLibraryItemsEnableCreditsMarkerGeneration,
|
||||||
GetLibraryItemsDefaultDirection,
|
GetLibraryItemsEpisodeSort,
|
||||||
GetLibraryItemsFlattenSeasons,
|
GetLibraryItemsFlattenSeasons,
|
||||||
GetLibraryItemsHasThumbnail,
|
|
||||||
GetLibraryItemsLibraryActiveDirection,
|
|
||||||
GetLibraryItemsLibraryDefaultDirection,
|
|
||||||
GetLibraryItemsLibraryResponse200Type,
|
GetLibraryItemsLibraryResponse200Type,
|
||||||
GetLibraryItemsLibraryType,
|
GetLibraryItemsLibraryType,
|
||||||
GetLibraryItemsOptimizedForStreaming,
|
|
||||||
GetLibraryItemsResponse,
|
GetLibraryItemsResponse,
|
||||||
GetLibraryItemsShowOrdering,
|
GetLibraryItemsShowOrdering,
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -45,8 +41,6 @@ let value: GetLibraryItemsResponse = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsActiveDirection.Ascending,
|
|
||||||
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
@@ -114,8 +108,11 @@ let value: GetLibraryItemsResponse = {
|
|||||||
year: 2022,
|
year: 2022,
|
||||||
seasonCount: 2022,
|
seasonCount: 2022,
|
||||||
tagline: "Return to Pandora.",
|
tagline: "Return to Pandora.",
|
||||||
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
|
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
|
||||||
showOrdering: GetLibraryItemsShowOrdering.Dvd,
|
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
|
||||||
|
enableCreditsMarkerGeneration:
|
||||||
|
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
|
||||||
|
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
|
||||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||||
art: "/library/metadata/58683/art/1703239236",
|
art: "/library/metadata/58683/art/1703239236",
|
||||||
banner: "/library/metadata/58683/banner/1703239236",
|
banner: "/library/metadata/58683/banner/1703239236",
|
||||||
@@ -153,8 +150,6 @@ let value: GetLibraryItemsResponse = {
|
|||||||
videoFrameRate: "24p",
|
videoFrameRate: "24p",
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
hasVoiceActivity: false,
|
hasVoiceActivity: false,
|
||||||
optimizedForStreaming:
|
|
||||||
GetLibraryItemsOptimizedForStreaming.Enable,
|
|
||||||
has64bitOffsets: false,
|
has64bitOffsets: false,
|
||||||
part: [
|
part: [
|
||||||
{
|
{
|
||||||
@@ -170,7 +165,6 @@ let value: GetLibraryItemsResponse = {
|
|||||||
optimizedForStreaming: false,
|
optimizedForStreaming: false,
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
indexes: "sd",
|
indexes: "sd",
|
||||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
|
||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 272796,
|
id: 272796,
|
||||||
@@ -327,10 +321,6 @@ let value: GetLibraryItemsResponse = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection:
|
|
||||||
GetLibraryItemsLibraryActiveDirection.Ascending,
|
|
||||||
defaultDirection:
|
|
||||||
GetLibraryItemsLibraryDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
@@ -6,15 +6,11 @@ The contents of the library by section and tag
|
|||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import {
|
||||||
GetLibraryItemsActiveDirection,
|
GetLibraryItemsEnableCreditsMarkerGeneration,
|
||||||
GetLibraryItemsDefaultDirection,
|
GetLibraryItemsEpisodeSort,
|
||||||
GetLibraryItemsFlattenSeasons,
|
GetLibraryItemsFlattenSeasons,
|
||||||
GetLibraryItemsHasThumbnail,
|
|
||||||
GetLibraryItemsLibraryActiveDirection,
|
|
||||||
GetLibraryItemsLibraryDefaultDirection,
|
|
||||||
GetLibraryItemsLibraryResponse200Type,
|
GetLibraryItemsLibraryResponse200Type,
|
||||||
GetLibraryItemsLibraryType,
|
GetLibraryItemsLibraryType,
|
||||||
GetLibraryItemsOptimizedForStreaming,
|
|
||||||
GetLibraryItemsResponseBody,
|
GetLibraryItemsResponseBody,
|
||||||
GetLibraryItemsShowOrdering,
|
GetLibraryItemsShowOrdering,
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -41,8 +37,6 @@ let value: GetLibraryItemsResponseBody = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsActiveDirection.Ascending,
|
|
||||||
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
@@ -110,8 +104,11 @@ let value: GetLibraryItemsResponseBody = {
|
|||||||
year: 2022,
|
year: 2022,
|
||||||
seasonCount: 2022,
|
seasonCount: 2022,
|
||||||
tagline: "Return to Pandora.",
|
tagline: "Return to Pandora.",
|
||||||
flattenSeasons: GetLibraryItemsFlattenSeasons.True,
|
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
|
||||||
showOrdering: GetLibraryItemsShowOrdering.Dvd,
|
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
|
||||||
|
enableCreditsMarkerGeneration:
|
||||||
|
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
|
||||||
|
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
|
||||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||||
art: "/library/metadata/58683/art/1703239236",
|
art: "/library/metadata/58683/art/1703239236",
|
||||||
banner: "/library/metadata/58683/banner/1703239236",
|
banner: "/library/metadata/58683/banner/1703239236",
|
||||||
@@ -149,7 +146,6 @@ let value: GetLibraryItemsResponseBody = {
|
|||||||
videoFrameRate: "24p",
|
videoFrameRate: "24p",
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
hasVoiceActivity: false,
|
hasVoiceActivity: false,
|
||||||
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
|
||||||
has64bitOffsets: false,
|
has64bitOffsets: false,
|
||||||
part: [
|
part: [
|
||||||
{
|
{
|
||||||
@@ -165,7 +161,6 @@ let value: GetLibraryItemsResponseBody = {
|
|||||||
optimizedForStreaming: false,
|
optimizedForStreaming: false,
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
indexes: "sd",
|
indexes: "sd",
|
||||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
|
||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 272796,
|
id: 272796,
|
||||||
@@ -322,9 +317,6 @@ let value: GetLibraryItemsResponseBody = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
|
|
||||||
defaultDirection:
|
|
||||||
GetLibraryItemsLibraryDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
# GetLibraryItemsShowOrdering
|
# GetLibraryItemsShowOrdering
|
||||||
|
|
||||||
Setting that indicates the episode ordering for the show
|
Setting that indicates the episode ordering for the show.
|
||||||
None = Library default,
|
None = Library default,
|
||||||
tmdbAiring = The Movie Database (Aired),
|
tmdbAiring = The Movie Database (Aired),
|
||||||
aired = TheTVDB (Aired),
|
aired = TheTVDB (Aired),
|
||||||
dvd = TheTVDB (DVD),
|
dvd = TheTVDB (DVD),
|
||||||
absolute = TheTVDB (Absolute)).
|
absolute = TheTVDB (Absolute)).
|
||||||
|
|
||||||
|
|
||||||
@@ -13,15 +13,16 @@ absolute = TheTVDB (Absolute)).
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsShowOrdering } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsShowOrdering } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsShowOrdering = GetLibraryItemsShowOrdering.Dvd;
|
let value: GetLibraryItemsShowOrdering =
|
||||||
|
GetLibraryItemsShowOrdering.TvdbAbsolute;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| ------------ | ------------ |
|
| -------------- | -------------- |
|
||||||
| `None` | None |
|
| `None` | None |
|
||||||
| `TmdbAiring` | tmdbAiring |
|
| `TmdbAiring` | tmdbAiring |
|
||||||
| `Aired` | aired |
|
| `TvdbAired` | aired |
|
||||||
| `Dvd` | dvd |
|
| `TvdbDvd` | dvd |
|
||||||
| `Absolute` | absolute |
|
| `TvdbAbsolute` | absolute |
|
||||||
@@ -3,17 +3,11 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import { GetLibraryItemsSort } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
GetLibraryItemsActiveDirection,
|
|
||||||
GetLibraryItemsDefaultDirection,
|
|
||||||
GetLibraryItemsSort,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsSort = {
|
let value: GetLibraryItemsSort = {
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsActiveDirection.Ascending,
|
|
||||||
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
@@ -3,11 +3,7 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import { GetLibraryItemsType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
GetLibraryItemsActiveDirection,
|
|
||||||
GetLibraryItemsDefaultDirection,
|
|
||||||
GetLibraryItemsType,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsType = {
|
let value: GetLibraryItemsType = {
|
||||||
key: "/library/sections/2/all?type=2",
|
key: "/library/sections/2/all?type=2",
|
||||||
@@ -27,8 +23,6 @@ let value: GetLibraryItemsType = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: GetLibraryItemsActiveDirection.Ascending,
|
|
||||||
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
@@ -185,6 +185,11 @@ let value: GetMetaDataByRatingKeyMetadata = {
|
|||||||
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||||
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||||
|
| `grandparentTitle` | *string* | :heavy_minus_sign: | The name of the album artist for the track when audio, and the name of the TV show for the episode when video. | |
|
||||||
|
| `parentTitle` | *string* | :heavy_minus_sign: | The name of the album for the track when audio, and the name of the season for the episode when TV show. | |
|
||||||
|
| `originalTitle` | *string* | :heavy_minus_sign: | The orginal untranslated name of the media item when non-english. | |
|
||||||
|
| `index` | *number* | :heavy_minus_sign: | The index starting from 0 of this media item in the MetaData array. | |
|
||||||
|
| `parentIndex` | *number* | :heavy_minus_sign: | The parent index starting from 0 of this media item in the parent MetaData array. | |
|
||||||
| `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 | Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job. |
|
| `summary` | *string* | :heavy_minus_sign: | N/A | Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job. |
|
||||||
| `rating` | *number* | :heavy_minus_sign: | N/A | 8.2 |
|
| `rating` | *number* | :heavy_minus_sign: | N/A | 8.2 |
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
|||||||
|
|
||||||
let value: GetMetaDataByRatingKeyResponse = {
|
let value: GetMetaDataByRatingKeyResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 207,
|
statusCode: 100,
|
||||||
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 { GetMetadataChildrenRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetMetadataChildrenRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetMetadataChildrenRequest = {
|
let value: GetMetadataChildrenRequest = {
|
||||||
ratingKey: 1716.30,
|
ratingKey: 185.21,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { GetMetadataChildrenResponse } from "@lukehagar/plexjs/sdk/models/operat
|
|||||||
|
|
||||||
let value: GetMetadataChildrenResponse = {
|
let value: GetMetadataChildrenResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 300,
|
statusCode: 406,
|
||||||
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 { GetOnDeckResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: GetOnDeckResponse = {
|
let value: GetOnDeckResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 406,
|
statusCode: 400,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -11,7 +11,6 @@ let value: GetPinAuthPinContainer = {
|
|||||||
id: 308667304,
|
id: 308667304,
|
||||||
code: "7RQZ",
|
code: "7RQZ",
|
||||||
product: "0",
|
product: "0",
|
||||||
trusted: false,
|
|
||||||
qr: "https://plex.tv/api/v2/pins/qr/7RQZ",
|
qr: "https://plex.tv/api/v2/pins/qr/7RQZ",
|
||||||
clientIdentifier: "string",
|
clientIdentifier: "string",
|
||||||
location: {
|
location: {
|
||||||
@@ -19,15 +18,11 @@ let value: GetPinAuthPinContainer = {
|
|||||||
continentCode: "NA",
|
continentCode: "NA",
|
||||||
country: "United States Virgin Islands",
|
country: "United States Virgin Islands",
|
||||||
city: "Amsterdam",
|
city: "Amsterdam",
|
||||||
europeanUnionMember: true,
|
|
||||||
timeZone: "America/St_Thomas",
|
timeZone: "America/St_Thomas",
|
||||||
postalCode: "802",
|
postalCode: "802",
|
||||||
inPrivacyRestrictedCountry: true,
|
|
||||||
inPrivacyRestrictedRegion: true,
|
|
||||||
subdivisions: "Saint Thomas",
|
subdivisions: "Saint Thomas",
|
||||||
coordinates: "18.3381, -64.8941",
|
coordinates: "18.3381, -64.8941",
|
||||||
},
|
},
|
||||||
expiresIn: 876,
|
|
||||||
createdAt: new Date("2024-07-16T17:03:05Z"),
|
createdAt: new Date("2024-07-16T17:03:05Z"),
|
||||||
expiresAt: new Date("2024-07-16T17:18:05Z"),
|
expiresAt: new Date("2024-07-16T17:18:05Z"),
|
||||||
authToken: null,
|
authToken: null,
|
||||||
|
|||||||
@@ -1,19 +0,0 @@
|
|||||||
# GetPinGlobals
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetPinGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetPinGlobals = {};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
|
||||||
| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
|
||||||
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
|
|
||||||
| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
|
||||||
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
|
|
||||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client application. | Roku |
|
|
||||||
@@ -5,7 +5,13 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetPinRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetPinRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetPinRequest = {};
|
let value: GetPinRequest = {
|
||||||
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -13,7 +19,7 @@ let value: GetPinRequest = {};
|
|||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `strong` | *boolean* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
|
| `strong` | *boolean* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
|
||||||
| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
| `clientID` | *string* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||||
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
|
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
|
||||||
| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||||
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
|
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
|
||||||
|
|||||||
@@ -15,7 +15,6 @@ let value: GetPinResponse = {
|
|||||||
id: 308667304,
|
id: 308667304,
|
||||||
code: "7RQZ",
|
code: "7RQZ",
|
||||||
product: "0",
|
product: "0",
|
||||||
trusted: false,
|
|
||||||
qr: "https://plex.tv/api/v2/pins/qr/7RQZ",
|
qr: "https://plex.tv/api/v2/pins/qr/7RQZ",
|
||||||
clientIdentifier: "string",
|
clientIdentifier: "string",
|
||||||
location: {
|
location: {
|
||||||
@@ -23,15 +22,11 @@ let value: GetPinResponse = {
|
|||||||
continentCode: "NA",
|
continentCode: "NA",
|
||||||
country: "United States Virgin Islands",
|
country: "United States Virgin Islands",
|
||||||
city: "Amsterdam",
|
city: "Amsterdam",
|
||||||
europeanUnionMember: true,
|
|
||||||
timeZone: "America/St_Thomas",
|
timeZone: "America/St_Thomas",
|
||||||
postalCode: "802",
|
postalCode: "802",
|
||||||
inPrivacyRestrictedCountry: true,
|
|
||||||
inPrivacyRestrictedRegion: true,
|
|
||||||
subdivisions: "Saint Thomas",
|
subdivisions: "Saint Thomas",
|
||||||
coordinates: "18.3381, -64.8941",
|
coordinates: "18.3381, -64.8941",
|
||||||
},
|
},
|
||||||
expiresIn: 876,
|
|
||||||
createdAt: new Date("2024-07-16T17:03:05Z"),
|
createdAt: new Date("2024-07-16T17:03:05Z"),
|
||||||
expiresAt: new Date("2024-07-16T17:18:05Z"),
|
expiresAt: new Date("2024-07-16T17:18:05Z"),
|
||||||
authToken: null,
|
authToken: null,
|
||||||
|
|||||||
@@ -24,4 +24,7 @@ let value: GetPlaylistContentsQueryParamType =
|
|||||||
| `Movie` | 1 |
|
| `Movie` | 1 |
|
||||||
| `TvShow` | 2 |
|
| `TvShow` | 2 |
|
||||||
| `Season` | 3 |
|
| `Season` | 3 |
|
||||||
| `Episode` | 4 |
|
| `Episode` | 4 |
|
||||||
|
| `Audio` | 8 |
|
||||||
|
| `Album` | 9 |
|
||||||
|
| `Track` | 10 |
|
||||||
@@ -6,7 +6,7 @@
|
|||||||
import { GetPlaylistContentsQueryParamType, GetPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetPlaylistContentsQueryParamType, GetPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetPlaylistContentsRequest = {
|
let value: GetPlaylistContentsRequest = {
|
||||||
playlistID: 206.51,
|
playlistID: 5883.17,
|
||||||
type: GetPlaylistContentsQueryParamType.TvShow,
|
type: GetPlaylistContentsQueryParamType.TvShow,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
|||||||
|
|
||||||
let value: GetPlaylistContentsResponse = {
|
let value: GetPlaylistContentsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 409,
|
statusCode: 506,
|
||||||
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 { GetPlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetPlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetPlaylistRequest = {
|
let value: GetPlaylistRequest = {
|
||||||
playlistID: 672.50,
|
playlistID: 8966.72,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { GetPlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: GetPlaylistResponse = {
|
let value: GetPlaylistResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 413,
|
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 { GetPlaylistsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: GetPlaylistsResponse = {
|
let value: GetPlaylistsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 100,
|
statusCode: 304,
|
||||||
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 @@ The Meta object is only included in the response if the `includeMeta` parameter
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { ActiveDirection, DefaultDirection, GetRecentlyAddedLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetRecentlyAddedLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetRecentlyAddedLibraryMediaContainer = {
|
let value: GetRecentlyAddedLibraryMediaContainer = {
|
||||||
type: [
|
type: [
|
||||||
@@ -28,8 +28,6 @@ let value: GetRecentlyAddedLibraryMediaContainer = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: ActiveDirection.Ascending,
|
|
||||||
defaultDirection: DefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetRecentlyAddedLibraryRequest, QueryParamIncludeMeta, QueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetRecentlyAddedLibraryRequest, QueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetRecentlyAddedLibraryRequest = {
|
let value: GetRecentlyAddedLibraryRequest = {
|
||||||
contentDirectoryID: 2,
|
contentDirectoryID: 2,
|
||||||
@@ -23,9 +23,6 @@ let value: GetRecentlyAddedLibraryRequest = {
|
|||||||
],
|
],
|
||||||
sectionID: 2,
|
sectionID: 2,
|
||||||
type: QueryParamType.TvShow,
|
type: QueryParamType.TvShow,
|
||||||
includeMeta: QueryParamIncludeMeta.Enable,
|
|
||||||
xPlexContainerStart: 0,
|
|
||||||
xPlexContainerSize: 50,
|
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { ActiveDirection, DefaultDirection, GetRecentlyAddedLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetRecentlyAddedLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetRecentlyAddedLibraryResponse = {
|
let value: GetRecentlyAddedLibraryResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
@@ -32,8 +32,6 @@ let value: GetRecentlyAddedLibraryResponse = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: ActiveDirection.Ascending,
|
|
||||||
defaultDirection: DefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ The recently added content
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { ActiveDirection, DefaultDirection, GetRecentlyAddedLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetRecentlyAddedLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetRecentlyAddedLibraryResponseBody = {
|
let value: GetRecentlyAddedLibraryResponseBody = {
|
||||||
mediaContainer: {
|
mediaContainer: {
|
||||||
@@ -28,8 +28,6 @@ let value: GetRecentlyAddedLibraryResponseBody = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: ActiveDirection.Ascending,
|
|
||||||
defaultDirection: DefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { ActiveDirection, DefaultDirection, GetRecentlyAddedLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetRecentlyAddedLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetRecentlyAddedLibraryType = {
|
let value: GetRecentlyAddedLibraryType = {
|
||||||
key: "/library/sections/2/all?type=2",
|
key: "/library/sections/2/all?type=2",
|
||||||
@@ -23,8 +23,6 @@ let value: GetRecentlyAddedLibraryType = {
|
|||||||
{
|
{
|
||||||
default: "asc",
|
default: "asc",
|
||||||
active: false,
|
active: false,
|
||||||
activeDirection: ActiveDirection.Ascending,
|
|
||||||
defaultDirection: DefaultDirection.Ascending,
|
|
||||||
descKey: "titleSort:desc",
|
descKey: "titleSort:desc",
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
key: "titleSort",
|
key: "titleSort",
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user