mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 20:47:46 +00:00
Compare commits
24 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5d57cd7c34 | ||
|
|
1a8e227874 | ||
|
|
8360d057ab | ||
|
|
18b64727c3 | ||
|
|
3152372037 | ||
|
|
13cd8a7fe5 | ||
|
|
cdcdc0ca8e | ||
|
|
b03cc6a609 | ||
|
|
4e989e0de3 | ||
|
|
c10e011a68 | ||
|
|
7e3dca8466 | ||
|
|
8a2d3e04ab | ||
|
|
6c8a73ae84 | ||
|
|
c839d9f6c7 | ||
|
|
77b0ef9507 | ||
|
|
1cfbd17f28 | ||
|
|
2492807c65 | ||
|
|
ead0a8773c | ||
|
|
e254f82e06 | ||
|
|
a4369c999a | ||
|
|
c50b85f29a | ||
|
|
496ebda695 | ||
|
|
d436fc3452 | ||
|
|
99cdf6effe |
@@ -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",
|
|
||||||
},
|
|
||||||
};
|
|
||||||
5
.gitignore
vendored
5
.gitignore
vendored
@@ -1,3 +1,8 @@
|
|||||||
|
/mcp-server
|
||||||
|
/bin
|
||||||
|
/.eslintcache
|
||||||
|
/.speakeasy/reports
|
||||||
|
/react-query
|
||||||
/sdk/models/errors
|
/sdk/models/errors
|
||||||
/sdk/types
|
/sdk/types
|
||||||
/__tests__
|
/__tests__
|
||||||
|
|||||||
@@ -1,9 +1,14 @@
|
|||||||
**/*
|
**/*
|
||||||
|
!/FUNCTIONS.md
|
||||||
|
!/RUNTIMES.md
|
||||||
|
!/REACT_QUERY.md
|
||||||
!/**/*.ts
|
!/**/*.ts
|
||||||
!/**/*.js
|
!/**/*.js
|
||||||
|
!/**/*.mjs
|
||||||
|
!/**/*.json
|
||||||
!/**/*.map
|
!/**/*.map
|
||||||
|
|
||||||
/.eslintrc.js
|
/eslint.config.mjs
|
||||||
/cjs
|
/cjs
|
||||||
/.tshy
|
/.tshy
|
||||||
/.tshy-*
|
/.tshy-*
|
||||||
|
|||||||
1150
.speakeasy/gen.lock
1150
.speakeasy/gen.lock
File diff suppressed because one or more lines are too long
@@ -7,12 +7,15 @@ generation:
|
|||||||
useClassNamesForArrayFields: true
|
useClassNamesForArrayFields: true
|
||||||
fixes:
|
fixes:
|
||||||
nameResolutionDec2023: true
|
nameResolutionDec2023: true
|
||||||
|
nameResolutionFeb2025: false
|
||||||
parameterOrderingFeb2024: true
|
parameterOrderingFeb2024: true
|
||||||
requestResponseComponentNamesFeb2024: true
|
requestResponseComponentNamesFeb2024: true
|
||||||
|
securityFeb2025: false
|
||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
|
oAuth2PasswordEnabled: false
|
||||||
typescript:
|
typescript:
|
||||||
version: 0.23.1
|
version: 0.35.0
|
||||||
additionalDependencies:
|
additionalDependencies:
|
||||||
dependencies: {}
|
dependencies: {}
|
||||||
devDependencies: {}
|
devDependencies: {}
|
||||||
@@ -20,8 +23,13 @@ typescript:
|
|||||||
additionalPackageJSON: {}
|
additionalPackageJSON: {}
|
||||||
author: LukeHagar
|
author: LukeHagar
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
|
defaultErrorName: SDKError
|
||||||
|
enableCustomCodeRegions: false
|
||||||
|
enableMCPServer: true
|
||||||
|
enableReactQuery: false
|
||||||
enumFormat: enum
|
enumFormat: enum
|
||||||
flattenGlobalSecurity: true
|
flattenGlobalSecurity: true
|
||||||
|
flatteningOrder: body-first
|
||||||
imports:
|
imports:
|
||||||
option: openapi
|
option: openapi
|
||||||
paths:
|
paths:
|
||||||
@@ -31,6 +39,7 @@ typescript:
|
|||||||
shared: sdk/models/shared
|
shared: sdk/models/shared
|
||||||
webhooks: sdk/models/webhooks
|
webhooks: sdk/models/webhooks
|
||||||
inputModelSuffix: input
|
inputModelSuffix: input
|
||||||
|
jsonpath: legacy
|
||||||
maxMethodParams: 4
|
maxMethodParams: 4
|
||||||
methodArguments: require-security-and-request
|
methodArguments: require-security-and-request
|
||||||
moduleFormat: commonjs
|
moduleFormat: commonjs
|
||||||
|
|||||||
@@ -1,35 +1,45 @@
|
|||||||
speakeasyVersion: 1.396.9
|
speakeasyVersion: 1.513.2
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
sourceRevisionDigest: sha256:6e5c8b2dc2253134817e8cd9db54e7f607e5f30f8757899692db6e33a0f3402e
|
sourceRevisionDigest: sha256:1b8840d540c66b58d1009ec2581fb18464158ec9aa00464eac05ba737f31207e
|
||||||
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- main
|
- main
|
||||||
|
plexapi:
|
||||||
|
sourceNamespace: plexapi
|
||||||
|
sourceRevisionDigest: sha256:bf7001af017ce5072c503bfbaf60793f94549163b517489dc53e4f7b685659c0
|
||||||
|
sourceBlobDigest: sha256:ed2b29043c84f32d2efa92a126083fd9a81644a7ce9c6ac86d9aeb3493cbd6f8
|
||||||
|
tags:
|
||||||
|
- latest
|
||||||
|
- speakeasy-sdk-regen-1741306213
|
||||||
|
- 0.0.3
|
||||||
targets:
|
targets:
|
||||||
plexjs:
|
plexjs:
|
||||||
source: my-source
|
source: plexapi
|
||||||
sourceNamespace: my-source
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:6e5c8b2dc2253134817e8cd9db54e7f607e5f30f8757899692db6e33a0f3402e
|
sourceRevisionDigest: sha256:bf7001af017ce5072c503bfbaf60793f94549163b517489dc53e4f7b685659c0
|
||||||
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
sourceBlobDigest: sha256:ed2b29043c84f32d2efa92a126083fd9a81644a7ce9c6ac86d9aeb3493cbd6f8
|
||||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||||
codeSamplesRevisionDigest: sha256:9837480d20f37ab49a390e3efbebde941398c0b7fd51d86a42e2cfc07da39329
|
codeSamplesRevisionDigest: sha256:e9663ecbdaaaaaf3f7ff17e00365dc176eda813f06e83bae125af65c9ab34453
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
plexapi:
|
||||||
inputs:
|
inputs:
|
||||||
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main
|
- location: 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
|
||||||
source: my-source
|
source: plexapi
|
||||||
publish:
|
publish:
|
||||||
npm:
|
npm:
|
||||||
token: $npm_token
|
token: $npm_token
|
||||||
codeSamples:
|
codeSamples:
|
||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-typescript-plexjs
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||||
|
|||||||
@@ -1,17 +1,19 @@
|
|||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
plexapi:
|
||||||
inputs:
|
inputs:
|
||||||
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main
|
- location: 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
|
||||||
source: my-source
|
source: plexapi
|
||||||
publish:
|
publish:
|
||||||
npm:
|
npm:
|
||||||
token: $npm_token
|
token: $npm_token
|
||||||
codeSamples:
|
codeSamples:
|
||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-typescript-plexjs
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||||
|
|||||||
@@ -27,7 +27,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>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
@@ -53,7 +52,7 @@ async function run() {
|
|||||||
const { value: result } = res;
|
const { value: result } = res;
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result);
|
||||||
}
|
}
|
||||||
|
|
||||||
run();
|
run();
|
||||||
|
|||||||
349
README.md
349
README.md
@@ -11,23 +11,55 @@
|
|||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
||||||
|
|
||||||
|
# Plex Media Server OpenAPI Specification
|
||||||
|
|
||||||
|
An Open Source OpenAPI Specification for Plex Media Server
|
||||||
|
|
||||||
|
Automation and SDKs provided by [Speakeasy](https://speakeasyapi.dev/)
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
[API Documentation](https://plexapi.dev)
|
||||||
|
|
||||||
|
## SDKs
|
||||||
|
|
||||||
|
The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the [main specification Repository](https://github.com/LukeHagar/plex-api-spec).
|
||||||
|
|
||||||
|
| Language | Repository | Releases | Other |
|
||||||
|
| --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
|
||||||
|
| Python | [GitHub](https://github.com/LukeHagar/plexpy) | [PyPI](https://pypi.org/project/plex-api-client/) | - |
|
||||||
|
| JavaScript/TypeScript | [GitHub](https://github.com/LukeHagar/plexjs) | [NPM](https://www.npmjs.com/package/@lukehagar/plexjs) \ [JSR](https://jsr.io/@lukehagar/plexjs) | - |
|
||||||
|
| Go | [GitHub](https://github.com/LukeHagar/plexgo) | [Releases](https://github.com/LukeHagar/plexgo/releases) | [GoDoc](https://pkg.go.dev/github.com/LukeHagar/plexgo) |
|
||||||
|
| Ruby | [GitHub](https://github.com/LukeHagar/plexruby) | [Releases](https://github.com/LukeHagar/plexruby/releases) | - |
|
||||||
|
| Swift | [GitHub](https://github.com/LukeHagar/plexswift) | [Releases](https://github.com/LukeHagar/plexswift/releases) | - |
|
||||||
|
| PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - |
|
||||||
|
| Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - |
|
||||||
|
| C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -
|
||||||
<!-- End Summary [summary] -->
|
<!-- End Summary [summary] -->
|
||||||
|
|
||||||
<!-- Start Table of Contents [toc] -->
|
<!-- Start Table of Contents [toc] -->
|
||||||
## 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)
|
|
||||||
* [Global Parameters](#global-parameters)
|
|
||||||
* [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] -->
|
||||||
@@ -73,7 +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>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
@@ -117,19 +148,25 @@ run();
|
|||||||
### [hubs](docs/sdks/hubs/README.md)
|
### [hubs](docs/sdks/hubs/README.md)
|
||||||
|
|
||||||
* [getGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
|
* [getGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
|
||||||
|
* [getRecentlyAdded](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
|
||||||
* [getLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
* [getLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
||||||
|
|
||||||
### [library](docs/sdks/library/README.md)
|
### [library](docs/sdks/library/README.md)
|
||||||
|
|
||||||
* [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
* [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||||
* [getRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded) - Get Recently Added
|
* [getRecentlyAddedLibrary](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
|
||||||
* [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
* [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
||||||
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||||
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||||
|
* [getAllMediaLibrary](docs/sdks/library/README.md#getallmedialibrary) - Get all media of library
|
||||||
* [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
|
||||||
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
||||||
|
* [getCountriesLibrary](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
|
||||||
|
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
|
||||||
|
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||||
|
* [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
||||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||||
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||||
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||||
@@ -208,6 +245,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
|
||||||
@@ -223,16 +264,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. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
|
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:
|
||||||
|
|
||||||
| Error Object | Status Code | Content Type |
|
| Error Type | Status Code | Content Type |
|
||||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
| ---------------------------------------- | ----------- | ---------------- |
|
||||||
| errors.GetServerCapabilitiesBadRequest | 400 | application/json |
|
| errors.GetServerCapabilitiesBadRequest | 400 | application/json |
|
||||||
| errors.GetServerCapabilitiesUnauthorized | 401 | application/json |
|
| errors.GetServerCapabilitiesUnauthorized | 401 | application/json |
|
||||||
| errors.SDKError | 4xx-5xx | */* |
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
||||||
|
|
||||||
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
|
|
||||||
|
|
||||||
|
If the method throws an error and it is not captured by the known errors, it will default to throwing a `SDKError`.
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
@@ -244,7 +284,6 @@ import {
|
|||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
@@ -256,8 +295,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);
|
||||||
@@ -274,6 +314,7 @@ async function run() {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
default: {
|
default: {
|
||||||
|
// Other errors such as network errors, see HTTPClientErrors for more details
|
||||||
throw err;
|
throw err;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -283,26 +324,43 @@ async function run() {
|
|||||||
run();
|
run();
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted 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 |
|
| Variable | Parameter | Supported Values | Default | Description |
|
||||||
| - | ------ | --------- |
|
| ---------- | --------------------------------- | -------------------------- | --------------- | ---------------------------------------------- |
|
||||||
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `https`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
| `protocol` | `protocol: models.ServerProtocol` | - `"http"`<br/>- `"https"` | `"https"` | The protocol to use for the server connection |
|
||||||
|
| `ip` | `ip: string` | string | `"10.10.10.47"` | The IP address or hostname of your Plex Server |
|
||||||
|
| `port` | `port: string` | string | `"32400"` | The port of your Plex Server |
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
serverIdx: 0,
|
protocol: "https",
|
||||||
|
ip: "e0c3:bcc0:6bac:dccc:c4ec:34b1:ca98:4cb9",
|
||||||
|
port: "40311",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
@@ -316,24 +374,15 @@ 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`
|
|
||||||
* `ip: 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 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>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
@@ -346,21 +395,20 @@ 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>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.plex.getCompanionsData({
|
const result = await plexAPI.plex.getCompanionsData({
|
||||||
serverURL: "https://plex.tv/api/v2/",
|
serverURL: "https://plex.tv/api/v2",
|
||||||
});
|
});
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
@@ -429,7 +477,7 @@ 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:
|
||||||
@@ -438,7 +486,6 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
|||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
@@ -474,137 +521,91 @@ 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
|
||||||
- [libraryDeleteLibrary](docs/sdks/library/README.md#deletelibrary)
|
- [`hubsGetRecentlyAdded`](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
|
||||||
- [libraryGetAllLibraries](docs/sdks/library/README.md#getalllibraries)
|
- [`libraryDeleteLibrary`](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||||
- [libraryGetFileHash](docs/sdks/library/README.md#getfilehash)
|
- [`libraryGetActorsLibrary`](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
|
||||||
- [libraryGetLibraryDetails](docs/sdks/library/README.md#getlibrarydetails)
|
- [`libraryGetAllLibraries`](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
||||||
- [libraryGetLibraryItems](docs/sdks/library/README.md#getlibraryitems)
|
- [`libraryGetAllMediaLibrary`](docs/sdks/library/README.md#getallmedialibrary) - Get all media of library
|
||||||
- [libraryGetMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey)
|
- [`libraryGetCountriesLibrary`](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
|
||||||
- [libraryGetMetadataChildren](docs/sdks/library/README.md#getmetadatachildren)
|
- [`libraryGetFileHash`](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||||
- [libraryGetOnDeck](docs/sdks/library/README.md#getondeck)
|
- [`libraryGetGenresLibrary`](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
||||||
- [libraryGetRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded)
|
- [`libraryGetLibraryDetails`](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||||
- [libraryGetRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata)
|
- [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||||
- [libraryGetSearchLibrary](docs/sdks/library/README.md#getsearchlibrary)
|
- [`libraryGetMediaMetaData`](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
||||||
- [libraryGetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent)
|
- [`libraryGetMetadataChildren`](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||||
- [logEnablePaperTrail](docs/sdks/log/README.md#enablepapertrail)
|
- [`libraryGetOnDeck`](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||||
- [logLogLine](docs/sdks/log/README.md#logline)
|
- [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
|
||||||
- [logLogMultiLine](docs/sdks/log/README.md#logmultiline)
|
- [`libraryGetRefreshLibraryMetadata`](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||||
- [mediaGetBannerImage](docs/sdks/media/README.md#getbannerimage)
|
- [`libraryGetSearchAllLibraries`](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||||
- [mediaGetThumbImage](docs/sdks/media/README.md#getthumbimage)
|
- [`libraryGetSearchLibrary`](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||||
- [mediaMarkPlayed](docs/sdks/media/README.md#markplayed)
|
- [`libraryGetTopWatchedContent`](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||||
- [mediaMarkUnplayed](docs/sdks/media/README.md#markunplayed)
|
- [`logEnablePaperTrail`](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
|
||||||
- [mediaUpdatePlayProgress](docs/sdks/media/README.md#updateplayprogress)
|
- [`logLogLine`](docs/sdks/log/README.md#logline) - Logging a single line message.
|
||||||
- [playlistsAddPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents)
|
- [`logLogMultiLine`](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
|
||||||
- [playlistsClearPlaylistContents](docs/sdks/playlists/README.md#clearplaylistcontents)
|
- [`mediaGetBannerImage`](docs/sdks/media/README.md#getbannerimage) - Get Banner Image
|
||||||
- [playlistsCreatePlaylist](docs/sdks/playlists/README.md#createplaylist)
|
- [`mediaGetThumbImage`](docs/sdks/media/README.md#getthumbimage) - Get Thumb Image
|
||||||
- [playlistsDeletePlaylist](docs/sdks/playlists/README.md#deleteplaylist)
|
- [`mediaMarkPlayed`](docs/sdks/media/README.md#markplayed) - Mark Media Played
|
||||||
- [playlistsGetPlaylistContents](docs/sdks/playlists/README.md#getplaylistcontents)
|
- [`mediaMarkUnplayed`](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
|
||||||
- [playlistsGetPlaylist](docs/sdks/playlists/README.md#getplaylist)
|
- [`mediaUpdatePlayProgress`](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress
|
||||||
- [playlistsGetPlaylists](docs/sdks/playlists/README.md#getplaylists)
|
- [`playlistsAddPlaylistContents`](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a Playlist
|
||||||
- [playlistsUpdatePlaylist](docs/sdks/playlists/README.md#updateplaylist)
|
- [`playlistsClearPlaylistContents`](docs/sdks/playlists/README.md#clearplaylistcontents) - Delete Playlist Contents
|
||||||
- [playlistsUploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist)
|
- [`playlistsCreatePlaylist`](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
|
||||||
- [plexGetCompanionsData](docs/sdks/plex/README.md#getcompanionsdata)
|
- [`playlistsDeletePlaylist`](docs/sdks/playlists/README.md#deleteplaylist) - Deletes a Playlist
|
||||||
- [plexGetGeoData](docs/sdks/plex/README.md#getgeodata)
|
- [`playlistsGetPlaylist`](docs/sdks/playlists/README.md#getplaylist) - Retrieve Playlist
|
||||||
- [plexGetHomeData](docs/sdks/plex/README.md#gethomedata)
|
- [`playlistsGetPlaylistContents`](docs/sdks/playlists/README.md#getplaylistcontents) - Retrieve Playlist Contents
|
||||||
- [plexGetPin](docs/sdks/plex/README.md#getpin)
|
- [`playlistsGetPlaylists`](docs/sdks/playlists/README.md#getplaylists) - Get All Playlists
|
||||||
- [plexGetServerResources](docs/sdks/plex/README.md#getserverresources)
|
- [`playlistsUpdatePlaylist`](docs/sdks/playlists/README.md#updateplaylist) - Update a Playlist
|
||||||
- [plexGetTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid)
|
- [`playlistsUploadPlaylist`](docs/sdks/playlists/README.md#uploadplaylist) - Upload Playlist
|
||||||
- [plexGetUserFriends](docs/sdks/plex/README.md#getuserfriends)
|
- [`plexGetCompanionsData`](docs/sdks/plex/README.md#getcompanionsdata) - Get Companions Data
|
||||||
- [searchGetSearchResults](docs/sdks/search/README.md#getsearchresults)
|
- [`plexGetGeoData`](docs/sdks/plex/README.md#getgeodata) - Get Geo Data
|
||||||
- [searchPerformSearch](docs/sdks/search/README.md#performsearch)
|
- [`plexGetHomeData`](docs/sdks/plex/README.md#gethomedata) - Get Plex Home Data
|
||||||
- [searchPerformVoiceSearch](docs/sdks/search/README.md#performvoicesearch)
|
- [`plexGetPin`](docs/sdks/plex/README.md#getpin) - Get a Pin
|
||||||
- [serverGetAvailableClients](docs/sdks/server/README.md#getavailableclients)
|
- [`plexGetServerResources`](docs/sdks/plex/README.md#getserverresources) - Get Server Resources
|
||||||
- [serverGetDevices](docs/sdks/server/README.md#getdevices)
|
- [`plexGetTokenByPinId`](docs/sdks/plex/README.md#gettokenbypinid) - Get Access Token by PinId
|
||||||
- [serverGetMediaProviders](docs/sdks/server/README.md#getmediaproviders)
|
- [`plexGetUserFriends`](docs/sdks/plex/README.md#getuserfriends) - Get list of friends of the user logged in
|
||||||
- [serverGetMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount)
|
- [`searchGetSearchResults`](docs/sdks/search/README.md#getsearchresults) - Get Search Results
|
||||||
- [serverGetResizedPhoto](docs/sdks/server/README.md#getresizedphoto)
|
- [`searchPerformSearch`](docs/sdks/search/README.md#performsearch) - Perform a search
|
||||||
- [serverGetServerCapabilities](docs/sdks/server/README.md#getservercapabilities)
|
- [`searchPerformVoiceSearch`](docs/sdks/search/README.md#performvoicesearch) - Perform a voice search
|
||||||
- [serverGetServerIdentity](docs/sdks/server/README.md#getserveridentity)
|
- [`serverGetAvailableClients`](docs/sdks/server/README.md#getavailableclients) - Get Available Clients
|
||||||
- [serverGetServerList](docs/sdks/server/README.md#getserverlist)
|
- [`serverGetDevices`](docs/sdks/server/README.md#getdevices) - Get Devices
|
||||||
- [serverGetServerPreferences](docs/sdks/server/README.md#getserverpreferences)
|
- [`serverGetMediaProviders`](docs/sdks/server/README.md#getmediaproviders) - Get Media Providers
|
||||||
- [sessionsGetSessionHistory](docs/sdks/sessions/README.md#getsessionhistory)
|
- [`serverGetMyPlexAccount`](docs/sdks/server/README.md#getmyplexaccount) - Get MyPlex Account
|
||||||
- [sessionsGetSessions](docs/sdks/sessions/README.md#getsessions)
|
- [`serverGetResizedPhoto`](docs/sdks/server/README.md#getresizedphoto) - Get a Resized Photo
|
||||||
- [sessionsGetTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions)
|
- [`serverGetServerCapabilities`](docs/sdks/server/README.md#getservercapabilities) - Get Server Capabilities
|
||||||
- [sessionsStopTranscodeSession](docs/sdks/sessions/README.md#stoptranscodesession)
|
- [`serverGetServerIdentity`](docs/sdks/server/README.md#getserveridentity) - Get Server Identity
|
||||||
- [statisticsGetBandwidthStatistics](docs/sdks/statistics/README.md#getbandwidthstatistics)
|
- [`serverGetServerList`](docs/sdks/server/README.md#getserverlist) - Get Server List
|
||||||
- [statisticsGetResourcesStatistics](docs/sdks/statistics/README.md#getresourcesstatistics)
|
- [`serverGetServerPreferences`](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
|
||||||
- [statisticsGetStatistics](docs/sdks/statistics/README.md#getstatistics)
|
- [`sessionsGetSessionHistory`](docs/sdks/sessions/README.md#getsessionhistory) - Get Session History
|
||||||
- [updaterApplyUpdates](docs/sdks/updater/README.md#applyupdates)
|
- [`sessionsGetSessions`](docs/sdks/sessions/README.md#getsessions) - Get Active Sessions
|
||||||
- [updaterCheckForUpdates](docs/sdks/updater/README.md#checkforupdates)
|
- [`sessionsGetTranscodeSessions`](docs/sdks/sessions/README.md#gettranscodesessions) - Get Transcode Sessions
|
||||||
- [updaterGetUpdateStatus](docs/sdks/updater/README.md#getupdatestatus)
|
- [`sessionsStopTranscodeSession`](docs/sdks/sessions/README.md#stoptranscodesession) - Stop a Transcode Session
|
||||||
- [videoGetTimeline](docs/sdks/video/README.md#gettimeline)
|
- [`statisticsGetBandwidthStatistics`](docs/sdks/statistics/README.md#getbandwidthstatistics) - Get Bandwidth Statistics
|
||||||
- [videoStartUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode)
|
- [`statisticsGetResourcesStatistics`](docs/sdks/statistics/README.md#getresourcesstatistics) - Get Resources Statistics
|
||||||
- [watchlistGetWatchList](docs/sdks/watchlist/README.md#getwatchlist)
|
- [`statisticsGetStatistics`](docs/sdks/statistics/README.md#getstatistics) - Get Media Statistics
|
||||||
|
- [`updaterApplyUpdates`](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
||||||
|
- [`updaterCheckForUpdates`](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
||||||
|
- [`updaterGetUpdateStatus`](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
|
||||||
|
- [`usersGetUsers`](docs/sdks/users/README.md#getusers) - Get list of all connected users
|
||||||
|
- [`videoGetTimeline`](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
||||||
|
- [`videoStartUniversalTranscode`](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
|
||||||
|
- [`watchlistGetWatchList`](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
<!-- End Standalone functions [standalone-funcs] -->
|
<!-- End Standalone functions [standalone-funcs] -->
|
||||||
|
|
||||||
<!-- Start Global Parameters [global-parameters] -->
|
|
||||||
## Global Parameters
|
|
||||||
|
|
||||||
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
|
|
||||||
|
|
||||||
For example, you can set `X-Plex-Client-Identifier` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getServerResources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
|
||||||
|
|
||||||
|
|
||||||
### Available Globals
|
|
||||||
|
|
||||||
The following global parameter is available.
|
|
||||||
|
|
||||||
| Name | Type | Required | Description |
|
|
||||||
| ---- | ---- |:--------:| ----------- |
|
|
||||||
| xPlexClientIdentifier | string | | The unique identifier for the client application
|
|
||||||
This is used to track the client application and its usage
|
|
||||||
(UUID, serial number, or other number unique per device)
|
|
||||||
|
|
|
||||||
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
|
||||||
import {
|
|
||||||
IncludeHttps,
|
|
||||||
IncludeIPv6,
|
|
||||||
IncludeRelay,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
|
||||||
});
|
|
||||||
|
|
||||||
async function run() {
|
|
||||||
const result = await plexAPI.plex.getServerResources(
|
|
||||||
"gcgzw5rz2xovp84b4vha3a40",
|
|
||||||
IncludeHttps.One,
|
|
||||||
IncludeRelay.One,
|
|
||||||
IncludeIPv6.One,
|
|
||||||
);
|
|
||||||
|
|
||||||
// Handle the result
|
|
||||||
console.log(result);
|
|
||||||
}
|
|
||||||
|
|
||||||
run();
|
|
||||||
|
|
||||||
```
|
|
||||||
<!-- End Global Parameters [global-parameters] -->
|
|
||||||
|
|
||||||
<!-- Start Retries [retries] -->
|
<!-- Start Retries [retries] -->
|
||||||
## Retries
|
## Retries
|
||||||
|
|
||||||
@@ -616,7 +617,6 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
|||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
@@ -657,7 +657,6 @@ const plexAPI = new PlexAPI({
|
|||||||
retryConnectionErrors: false,
|
retryConnectionErrors: false,
|
||||||
},
|
},
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
|
|||||||
210
RELEASES.md
210
RELEASES.md
@@ -1029,3 +1029,213 @@ Based on:
|
|||||||
- [typescript v0.23.1] .
|
- [typescript v0.23.1] .
|
||||||
### Releases
|
### Releases
|
||||||
- [NPM v0.23.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.1 - .
|
- [NPM v0.23.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.1 - .
|
||||||
|
|
||||||
|
## 2024-09-15 00:10:25
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.396.9 (2.415.7) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.23.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.23.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.2 - .
|
||||||
|
|
||||||
|
## 2024-09-16 00:09:42
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.396.9 (2.415.7) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.23.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.23.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.3 - .
|
||||||
|
|
||||||
|
## 2024-09-16 17:59:12
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.397.2 (2.415.8) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.23.4] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.23.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.4 - .
|
||||||
|
|
||||||
|
## 2024-09-17 00:08:25
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.398.0 (2.415.8) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.23.5] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.23.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.5 - .
|
||||||
|
|
||||||
|
## 2024-10-01 00:10:47
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.24.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.24.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.0 - .
|
||||||
|
|
||||||
|
## 2024-10-01 15:35:33
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.24.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.24.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.1 - .
|
||||||
|
|
||||||
|
## 2024-10-02 02:28:25
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.24.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.24.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.2 - .
|
||||||
|
|
||||||
|
## 2024-10-03 00:09:30
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.25.1] .
|
||||||
|
### Releases
|
||||||
|
- [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 - .
|
||||||
|
|
||||||
|
## 2025-02-07 00:09:41
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.487.0 (2.506.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.33.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.33.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.33.0 - .
|
||||||
|
|
||||||
|
## 2025-02-10 00:10:04
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.487.1 (2.506.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.34.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.34.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.34.0 - .
|
||||||
|
|
||||||
|
## 2025-03-07 00:09:55
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.513.2 (2.545.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.35.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.35.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.0 - .
|
||||||
28
RUNTIMES.md
28
RUNTIMES.md
@@ -1,6 +1,6 @@
|
|||||||
# Supported JavaScript runtimes
|
# Supported JavaScript runtimes
|
||||||
|
|
||||||
This SDK is intended to be used in JavaScript runtimes that support the following features:
|
This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
|
||||||
|
|
||||||
* [Web Fetch API][web-fetch]
|
* [Web Fetch API][web-fetch]
|
||||||
* [Web Streams API][web-streams] and in particular `ReadableStream`
|
* [Web Streams API][web-streams] and in particular `ReadableStream`
|
||||||
@@ -20,3 +20,29 @@ Runtime environments that are explicitly supported are:
|
|||||||
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
|
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
|
||||||
|
|
||||||
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
|
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
|
||||||
|
|
||||||
|
## Recommended TypeScript compiler options
|
||||||
|
|
||||||
|
The following `tsconfig.json` options are recommended for projects using this
|
||||||
|
SDK in order to get static type support for features like async iterables,
|
||||||
|
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
|
||||||
|
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
|
||||||
|
so on):
|
||||||
|
|
||||||
|
[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
|
||||||
|
[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
|
||||||
|
[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
|
||||||
|
[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"target": "es2020", // or higher
|
||||||
|
"lib": ["es2020", "dom", "dom.iterable"],
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
While `target` can be set to older ECMAScript versions, it may result in extra,
|
||||||
|
unnecessary compatibility code being generated if you are not targeting old
|
||||||
|
runtimes.
|
||||||
1
USAGE.md
1
USAGE.md
@@ -4,7 +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>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
|
|||||||
1511
codeSamples.yaml
1511
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
@@ -1,11 +1,11 @@
|
|||||||
# GetRecentlyAddedBadRequest
|
# GetActorsLibraryBadRequest
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetRecentlyAddedBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetActorsLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
// No examples available for this model
|
// No examples available for this model
|
||||||
```
|
```
|
||||||
@@ -14,5 +14,5 @@ import { GetRecentlyAddedBadRequest } from "@lukehagar/plexjs/sdk/models/errors"
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||||
| `errors` | [errors.GetRecentlyAddedErrors](../../../sdk/models/errors/getrecentlyaddederrors.md)[] | :heavy_minus_sign: | N/A |
|
| `errors` | [errors.GetActorsLibraryErrors](../../../sdk/models/errors/getactorslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetRecentlyAddedErrors
|
# GetActorsLibraryErrors
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetRecentlyAddedErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetActorsLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetRecentlyAddedErrors = {
|
let value: GetActorsLibraryErrors = {
|
||||||
code: 1000,
|
code: 1000,
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 400,
|
status: 400,
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetMetaDataByRatingKeyLibraryErrors
|
# GetActorsLibraryLibraryErrors
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetMetaDataByRatingKeyLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetActorsLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetMetaDataByRatingKeyLibraryErrors = {
|
let value: GetActorsLibraryLibraryErrors = {
|
||||||
code: 1001,
|
code: 1001,
|
||||||
message: "User could not be authenticated",
|
message: "User could not be authenticated",
|
||||||
status: 401,
|
status: 401,
|
||||||
18
docs/sdk/models/errors/getactorslibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getactorslibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetActorsLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetActorsLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetActorsLibraryLibraryErrors](../../../sdk/models/errors/getactorslibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
18
docs/sdk/models/errors/getallmedialibrarybadrequest.md
Normal file
18
docs/sdk/models/errors/getallmedialibrarybadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetAllMediaLibraryBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllMediaLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetAllMediaLibraryErrors](../../../sdk/models/errors/getallmedialibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetMetaDataByRatingKeyErrors
|
# GetAllMediaLibraryErrors
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetMetaDataByRatingKeyErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetAllMediaLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetMetaDataByRatingKeyErrors = {
|
let value: GetAllMediaLibraryErrors = {
|
||||||
code: 1000,
|
code: 1000,
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 400,
|
status: 400,
|
||||||
21
docs/sdk/models/errors/getallmedialibrarylibraryerrors.md
Normal file
21
docs/sdk/models/errors/getallmedialibrarylibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetAllMediaLibraryLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllMediaLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibraryLibraryErrors = {
|
||||||
|
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/getallmedialibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getallmedialibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetAllMediaLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllMediaLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetAllMediaLibraryLibraryErrors](../../../sdk/models/errors/getallmedialibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
18
docs/sdk/models/errors/getcountrieslibrarybadrequest.md
Normal file
18
docs/sdk/models/errors/getcountrieslibrarybadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetCountriesLibraryBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetCountriesLibraryErrors](../../../sdk/models/errors/getcountrieslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
21
docs/sdk/models/errors/getcountrieslibraryerrors.md
Normal file
21
docs/sdk/models/errors/getcountrieslibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetCountriesLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetCountriesLibraryErrors = {
|
||||||
|
code: 1000,
|
||||||
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
|
status: 400,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/getcountrieslibrarylibraryerrors.md
Normal file
21
docs/sdk/models/errors/getcountrieslibrarylibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetCountriesLibraryLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetCountriesLibraryLibraryErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/getcountrieslibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getcountrieslibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetCountriesLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCountriesLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetCountriesLibraryLibraryErrors](../../../sdk/models/errors/getcountrieslibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
18
docs/sdk/models/errors/getgenreslibrarybadrequest.md
Normal file
18
docs/sdk/models/errors/getgenreslibrarybadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetGenresLibraryBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetGenresLibraryErrors](../../../sdk/models/errors/getgenreslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
21
docs/sdk/models/errors/getgenreslibraryerrors.md
Normal file
21
docs/sdk/models/errors/getgenreslibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetGenresLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetGenresLibraryErrors = {
|
||||||
|
code: 1000,
|
||||||
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
|
status: 400,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/getgenreslibrarylibraryerrors.md
Normal file
21
docs/sdk/models/errors/getgenreslibrarylibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetGenresLibraryLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetGenresLibraryLibraryErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/getgenreslibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getgenreslibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetGenresLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGenresLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetGenresLibraryLibraryErrors](../../../sdk/models/errors/getgenreslibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
18
docs/sdk/models/errors/getmediametadatabadrequest.md
Normal file
18
docs/sdk/models/errors/getmediametadatabadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetMediaMetaDataBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetMediaMetaDataBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetMediaMetaDataErrors](../../../sdk/models/errors/getmediametadataerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
21
docs/sdk/models/errors/getmediametadataerrors.md
Normal file
21
docs/sdk/models/errors/getmediametadataerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetMediaMetaDataErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetMediaMetaDataErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetMediaMetaDataErrors = {
|
||||||
|
code: 1000,
|
||||||
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
|
status: 400,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/getmediametadatalibraryerrors.md
Normal file
21
docs/sdk/models/errors/getmediametadatalibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetMediaMetaDataLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetMediaMetaDataLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetMediaMetaDataLibraryErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/getmediametadataunauthorized.md
Normal file
18
docs/sdk/models/errors/getmediametadataunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetMediaMetaDataUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetMediaMetaDataUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetMediaMetaDataLibraryErrors](../../../sdk/models/errors/getmediametadatalibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# GetMetaDataByRatingKeyBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetMetaDataByRatingKeyBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetMetaDataByRatingKeyErrors](../../../sdk/models/errors/getmetadatabyratingkeyerrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# GetMetaDataByRatingKeyUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetMetaDataByRatingKeyUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetMetaDataByRatingKeyLibraryErrors](../../../sdk/models/errors/getmetadatabyratingkeylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetRecentlyAddedUnauthorized
|
# GetRecentlyAddedLibraryBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetRecentlyAddedUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetRecentlyAddedLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
// No examples available for this model
|
// No examples available for this model
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { GetRecentlyAddedLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetRecentlyAddedLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetRecentlyAddedLibraryErrors = {
|
let value: GetRecentlyAddedLibraryErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
# GetRecentlyAddedLibraryLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetRecentlyAddedLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetRecentlyAddedLibraryLibraryErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
# GetRecentlyAddedLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetRecentlyAddedLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetRecentlyAddedLibraryLibraryErrors](../../../sdk/models/errors/getrecentlyaddedlibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
18
docs/sdk/models/errors/getsearchalllibrariesbadrequest.md
Normal file
18
docs/sdk/models/errors/getsearchalllibrariesbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetSearchAllLibrariesBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetSearchAllLibrariesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetSearchAllLibrariesErrors](../../../sdk/models/errors/getsearchalllibrarieserrors.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/getsearchalllibrarieserrors.md
Normal file
21
docs/sdk/models/errors/getsearchalllibrarieserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetSearchAllLibrariesErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetSearchAllLibrariesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetSearchAllLibrariesErrors = {
|
||||||
|
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/getsearchalllibrarieslibraryerrors.md
Normal file
21
docs/sdk/models/errors/getsearchalllibrarieslibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetSearchAllLibrariesLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetSearchAllLibrariesLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetSearchAllLibrariesLibraryErrors = {
|
||||||
|
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/getsearchalllibrariesunauthorized.md
Normal file
18
docs/sdk/models/errors/getsearchalllibrariesunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetSearchAllLibrariesUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetSearchAllLibrariesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetSearchAllLibrariesLibraryErrors](../../../sdk/models/errors/getsearchalllibrarieslibraryerrors.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 |
|
||||||
19
docs/sdk/models/operations/action.md
Normal file
19
docs/sdk/models/operations/action.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# Action
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Action } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: Action = {
|
||||||
|
id: "addToContinueWatching",
|
||||||
|
key: "/actions/addToContinueWatching",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||||
|
| `id` | *string* | :heavy_check_mark: | N/A | addToContinueWatching |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | N/A | /actions/addToContinueWatching |
|
||||||
19
docs/sdk/models/operations/activedirection.md
Normal file
19
docs/sdk/models/operations/activedirection.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# ActiveDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ActiveDirection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: ActiveDirection = ActiveDirection.Ascending;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
@@ -6,7 +6,7 @@
|
|||||||
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: AddPlaylistContentsRequest = {
|
let value: AddPlaylistContentsRequest = {
|
||||||
playlistID: 8209.94,
|
playlistID: 3741.7,
|
||||||
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
||||||
playQueueID: 123,
|
playQueueID: 123,
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { AddPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operat
|
|||||||
|
|
||||||
let value: AddPlaylistContentsResponse = {
|
let value: AddPlaylistContentsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 13571,
|
statusCode: 302,
|
||||||
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: 667411,
|
statusCode: 428,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,12 +7,12 @@ The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign aud
|
|||||||
```typescript
|
```typescript
|
||||||
import { AutoSelectSubtitle } from "@lukehagar/plexjs/sdk/models/operations";
|
import { AutoSelectSubtitle } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: AutoSelectSubtitle = AutoSelectSubtitle.One;
|
let value: AutoSelectSubtitle = AutoSelectSubtitle.Enable;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| ------ | ------ |
|
| --------- | --------- |
|
||||||
| `Zero` | 0 |
|
| `Disable` | 0 |
|
||||||
| `One` | 1 |
|
| `Enable` | 1 |
|
||||||
@@ -7,7 +7,7 @@ import { Billing } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: Billing = {
|
let value: Billing = {
|
||||||
internalPaymentMethod: {},
|
internalPaymentMethod: {},
|
||||||
paymentMethodId: 414263,
|
paymentMethodId: 765326,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { CancelServerActivitiesResponse } from "@lukehagar/plexjs/sdk/models/ope
|
|||||||
|
|
||||||
let value: CancelServerActivitiesResponse = {
|
let value: CancelServerActivitiesResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 812169,
|
statusCode: 417,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { CheckForUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations
|
|||||||
|
|
||||||
let value: CheckForUpdatesResponse = {
|
let value: CheckForUpdatesResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 9356,
|
statusCode: 508,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: ClearPlaylistContentsRequest = {
|
let value: ClearPlaylistContentsRequest = {
|
||||||
playlistID: 3687.25,
|
playlistID: 256.62,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { ClearPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/oper
|
|||||||
|
|
||||||
let value: ClearPlaylistContentsResponse = {
|
let value: ClearPlaylistContentsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 662527,
|
statusCode: 204,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
17
docs/sdk/models/operations/collection.md
Normal file
17
docs/sdk/models/operations/collection.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# Collection
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Collection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: Collection = {
|
||||||
|
tag: "Working NL Subs",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `tag` | *string* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||||
@@ -3,13 +3,13 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { Connections } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Connections, Protocol } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: Connections = {
|
let value: Connections = {
|
||||||
protocol: "<value>",
|
protocol: Protocol.Http,
|
||||||
address: "718 Wolff Light",
|
address: "21611 Schuster Cliffs",
|
||||||
port: 7991.59,
|
port: 54915,
|
||||||
uri: "https://jumbo-lobotomy.net",
|
uri: "https://wobbly-instance.org/",
|
||||||
local: false,
|
local: false,
|
||||||
relay: false,
|
relay: false,
|
||||||
iPv6: false,
|
iPv6: false,
|
||||||
@@ -18,12 +18,12 @@ let value: Connections = {
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||||
| `protocol` | *string* | :heavy_check_mark: | N/A |
|
| `protocol` | [operations.Protocol](../../../sdk/models/operations/protocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) | http |
|
||||||
| `address` | *string* | :heavy_check_mark: | N/A |
|
| `address` | *string* | :heavy_check_mark: | The (ip) address or domain name used for the connection | |
|
||||||
| `port` | *number* | :heavy_check_mark: | N/A |
|
| `port` | *number* | :heavy_check_mark: | The port used for the connection | |
|
||||||
| `uri` | *string* | :heavy_check_mark: | N/A |
|
| `uri` | *string* | :heavy_check_mark: | The full URI of the connection | |
|
||||||
| `local` | *boolean* | :heavy_check_mark: | N/A |
|
| `local` | *boolean* | :heavy_check_mark: | If the connection is local address | |
|
||||||
| `relay` | *boolean* | :heavy_check_mark: | N/A |
|
| `relay` | *boolean* | :heavy_check_mark: | If the connection is relayed through plex.direct | |
|
||||||
| `iPv6` | *boolean* | :heavy_check_mark: | N/A |
|
| `iPv6` | *boolean* | :heavy_check_mark: | If the connection is using IPv6 | |
|
||||||
@@ -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.Video,
|
type: CreatePlaylistQueryParamType.Photo,
|
||||||
smart: Smart.One,
|
smart: Smart.One,
|
||||||
uri: "http://immediate-instructor.info",
|
uri: "https://radiant-dividend.com/",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { CreatePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
|||||||
|
|
||||||
let value: CreatePlaylistResponse = {
|
let value: CreatePlaylistResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 244425,
|
statusCode: 409,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
19
docs/sdk/models/operations/defaultdirection.md
Normal file
19
docs/sdk/models/operations/defaultdirection.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# DefaultDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DefaultDirection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: DefaultDirection = DefaultDirection.Ascending;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
@@ -1,18 +1,18 @@
|
|||||||
# DefaultSubtitleAccessibility
|
# DefaultSubtitleAccessibility
|
||||||
|
|
||||||
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles)
|
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only show non-SDH subtitles)
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { DefaultSubtitleAccessibility } from "@lukehagar/plexjs/sdk/models/operations";
|
import { DefaultSubtitleAccessibility } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: DefaultSubtitleAccessibility = DefaultSubtitleAccessibility.One;
|
let value: DefaultSubtitleAccessibility = DefaultSubtitleAccessibility.Enable;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| ------ | ------ |
|
| --------- | --------- |
|
||||||
| `Zero` | 0 |
|
| `Disable` | 0 |
|
||||||
| `One` | 1 |
|
| `Enable` | 1 |
|
||||||
@@ -7,12 +7,12 @@ The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer
|
|||||||
```typescript
|
```typescript
|
||||||
import { DefaultSubtitleForced } from "@lukehagar/plexjs/sdk/models/operations";
|
import { DefaultSubtitleForced } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: DefaultSubtitleForced = DefaultSubtitleForced.Zero;
|
let value: DefaultSubtitleForced = DefaultSubtitleForced.Enable;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| ------ | ------ |
|
| --------- | --------- |
|
||||||
| `Zero` | 0 |
|
| `Disable` | 0 |
|
||||||
| `One` | 1 |
|
| `Enable` | 1 |
|
||||||
@@ -7,7 +7,7 @@ import { DeleteLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: DeleteLibraryResponse = {
|
let value: DeleteLibraryResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 99280,
|
statusCode: 507,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: DeletePlaylistRequest = {
|
let value: DeletePlaylistRequest = {
|
||||||
playlistID: 6563.3,
|
playlistID: 1856.36,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { DeletePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
|||||||
|
|
||||||
let value: DeletePlaylistResponse = {
|
let value: DeletePlaylistResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 317202,
|
statusCode: 507,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
import { Director } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Director } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: Director = {
|
let value: Director = {
|
||||||
tag: "Peyton Reed",
|
tag: "James Cameron",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -14,4 +14,4 @@ let value: Director = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Peyton Reed |
|
| `tag` | *string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||||
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: 635059,
|
statusCode: 102,
|
||||||
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 |
|
||||||
@@ -5,13 +5,28 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { Feature } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Feature } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: Feature = {};
|
let value: Feature = {
|
||||||
|
type: "<value>",
|
||||||
|
flavor: "global",
|
||||||
|
scrobbleKey: "/:/scrobble/new",
|
||||||
|
unscrobbleKey: "/:/unscrobble/new",
|
||||||
|
action: [
|
||||||
|
{
|
||||||
|
id: "addToContinueWatching",
|
||||||
|
key: "/actions/addToContinueWatching",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||||
| `key` | *string* | :heavy_minus_sign: | N/A |
|
| `key` | *string* | :heavy_minus_sign: | N/A | |
|
||||||
| `type` | *string* | :heavy_minus_sign: | N/A |
|
| `type` | *string* | :heavy_check_mark: | N/A | |
|
||||||
| `directory` | [operations.GetMediaProvidersDirectory](../../../sdk/models/operations/getmediaprovidersdirectory.md)[] | :heavy_minus_sign: | N/A |
|
| `flavor` | *string* | :heavy_minus_sign: | N/A | global |
|
||||||
|
| `scrobbleKey` | *string* | :heavy_minus_sign: | N/A | /:/scrobble/new |
|
||||||
|
| `unscrobbleKey` | *string* | :heavy_minus_sign: | N/A | /:/unscrobble/new |
|
||||||
|
| `directory` | [operations.GetMediaProvidersDirectory](../../../sdk/models/operations/getmediaprovidersdirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `action` | [operations.Action](../../../sdk/models/operations/action.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
@@ -1,73 +0,0 @@
|
|||||||
# Features
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { Features } from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: Features = Features.LiveTvSupportIncompleteSegments;
|
|
||||||
```
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| --------------------------------------- | --------------------------------------- |
|
|
||||||
| `AndroidDolbyVision` | Android - Dolby Vision |
|
|
||||||
| `AndroidPiP` | Android - PiP |
|
|
||||||
| `CUSunset` | CU Sunset |
|
|
||||||
| `HRKEnableEUR` | HRK_enable_EUR |
|
|
||||||
| `TREBLEShowFeatures` | TREBLE-show-features |
|
|
||||||
| `AdCountdownTimer` | ad-countdown-timer |
|
|
||||||
| `AdaptiveBitrate` | adaptive_bitrate |
|
|
||||||
| `AmazonLoopDebug` | amazon-loop-debug |
|
|
||||||
| `AvodAdAnalysis` | avod-ad-analysis |
|
|
||||||
| `AvodNewMedia` | avod-new-media |
|
|
||||||
| `BlacklistGetSignin` | blacklist_get_signin |
|
|
||||||
| `ClientRadioStations` | client-radio-stations |
|
|
||||||
| `CloudflareTurnstileRequired` | cloudflare-turnstile-required |
|
|
||||||
| `Collections` | collections |
|
|
||||||
| `CommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications |
|
|
||||||
| `CommunityAccessPlexTv` | community_access_plex_tv |
|
|
||||||
| `CompanionsSonos` | companions_sonos |
|
|
||||||
| `CustomHomeRemoval` | custom-home-removal |
|
|
||||||
| `DisableHomeUserFriendships` | disable_home_user_friendships |
|
|
||||||
| `DisableSharingFriendships` | disable_sharing_friendships |
|
|
||||||
| `DrmSupport` | drm_support |
|
|
||||||
| `ExcludeRestrictions` | exclude restrictions |
|
|
||||||
| `FederatedAuth` | federated-auth |
|
|
||||||
| `FriendRequestPushNotifications` | friend_request_push_notifications |
|
|
||||||
| `GuidedUpgrade` | guided-upgrade |
|
|
||||||
| `Home` | home |
|
|
||||||
| `IncreasePasswordComplexity` | increase-password-complexity |
|
|
||||||
| `Ios14PrivacyBanner` | ios14-privacy-banner |
|
|
||||||
| `IterableNotificationTokens` | iterable-notification-tokens |
|
|
||||||
| `KeepPaymentMethod` | keep-payment-method |
|
|
||||||
| `KevinBacon` | kevin-bacon |
|
|
||||||
| `KoreaConsent` | korea-consent |
|
|
||||||
| `LeIsrgRootX1` | le_isrg_root_x1 |
|
|
||||||
| `LetsEncrypt` | lets_encrypt |
|
|
||||||
| `LightningDvrPivot` | lightning-dvr-pivot |
|
|
||||||
| `LiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments |
|
|
||||||
| `Livetv` | livetv |
|
|
||||||
| `MetadataSearch` | metadata_search |
|
|
||||||
| `NewPlexPassPrices` | new_plex_pass_prices |
|
|
||||||
| `NewsProviderSunsetModal` | news-provider-sunset-modal |
|
|
||||||
| `PhotosFavorites` | photos-favorites |
|
|
||||||
| `PhotosMetadataEdition` | photos-metadata-edition |
|
|
||||||
| `PmsHealth` | pms_health |
|
|
||||||
| `Radio` | radio |
|
|
||||||
| `RateLimitClientToken` | rate-limit-client-token |
|
|
||||||
| `ScrobblingServicePlexTv` | scrobbling-service-plex-tv |
|
|
||||||
| `SharedServerNotification` | shared_server_notification |
|
|
||||||
| `SharedSourceNotification` | shared_source_notification |
|
|
||||||
| `SigninWithApple` | signin_with_apple |
|
|
||||||
| `SpringServeAdProvider` | spring_serve_ad_provider |
|
|
||||||
| `TranscoderCache` | transcoder_cache |
|
|
||||||
| `TunerSharing` | tuner-sharing |
|
|
||||||
| `TwoFactorAuthentication` | two-factor-authentication |
|
|
||||||
| `Unsupportedtuners` | unsupportedtuners |
|
|
||||||
| `Upgrade3ds2` | upgrade-3ds2 |
|
|
||||||
| `VodSchema` | vod-schema |
|
|
||||||
| `VodCloudflare` | vod_cloudflare |
|
|
||||||
| `WatchTogetherInvite` | watch-together-invite |
|
|
||||||
| `WebServerDashboard` | web_server_dashboard |
|
|
||||||
@@ -6,10 +6,10 @@
|
|||||||
import { Field } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Field } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: Field = {
|
let value: Field = {
|
||||||
key: "label",
|
key: "show.title",
|
||||||
title: "Label",
|
title: "Show Title",
|
||||||
type: "tag",
|
type: "string",
|
||||||
subType: "bitrate",
|
subType: "rating",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -17,7 +17,7 @@ let value: Field = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
| `key` | *string* | :heavy_minus_sign: | N/A | label |
|
| `key` | *string* | :heavy_check_mark: | N/A | show.title |
|
||||||
| `title` | *string* | :heavy_minus_sign: | N/A | Label |
|
| `title` | *string* | :heavy_check_mark: | N/A | Show Title |
|
||||||
| `type` | *string* | :heavy_minus_sign: | N/A | tag |
|
| `type` | *string* | :heavy_check_mark: | N/A | string |
|
||||||
| `subType` | *string* | :heavy_minus_sign: | N/A | bitrate |
|
| `subType` | *string* | :heavy_minus_sign: | N/A | rating |
|
||||||
@@ -6,7 +6,7 @@
|
|||||||
import { FieldType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { FieldType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: FieldType = {
|
let value: FieldType = {
|
||||||
type: "resolution",
|
type: "tag",
|
||||||
operator: [
|
operator: [
|
||||||
{
|
{
|
||||||
key: "=",
|
key: "=",
|
||||||
@@ -20,5 +20,5 @@ let value: FieldType = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||||
| `type` | *string* | :heavy_minus_sign: | N/A | resolution |
|
| `type` | *string* | :heavy_check_mark: | N/A | tag |
|
||||||
| `operator` | [operations.Operator](../../../sdk/models/operations/operator.md)[] | :heavy_minus_sign: | N/A | |
|
| `operator` | [operations.Operator](../../../sdk/models/operations/operator.md)[] | :heavy_check_mark: | N/A | |
|
||||||
19
docs/sdk/models/operations/flattenseasons.md
Normal file
19
docs/sdk/models/operations/flattenseasons.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# FlattenSeasons
|
||||||
|
|
||||||
|
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { FlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: FlattenSeasons = FlattenSeasons.Show;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------- | ---------------- |
|
||||||
|
| `LibraryDefault` | -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",
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
import { Genre } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Genre } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: Genre = {
|
let value: Genre = {
|
||||||
tag: "Comedy",
|
tag: "Adventure",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -14,4 +14,4 @@ let value: Genre = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Comedy |
|
| `tag` | *string* | :heavy_minus_sign: | N/A | Adventure |
|
||||||
@@ -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",
|
||||||
};
|
};
|
||||||
@@ -32,7 +29,7 @@ let value: GeoData = {
|
|||||||
| `city` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam |
|
| `city` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam |
|
||||||
| `europeanUnionMember` | *boolean* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
|
| `europeanUnionMember` | *boolean* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
|
||||||
| `timeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
|
| `timeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
|
||||||
| `postalCode` | *number* | :heavy_check_mark: | The postal code of the location. | 802 |
|
| `postalCode` | *string* | :heavy_check_mark: | The postal code of the location. | 802 |
|
||||||
| `inPrivacyRestrictedCountry` | *boolean* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
|
| `inPrivacyRestrictedCountry` | *boolean* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
|
||||||
| `inPrivacyRestrictedRegion` | *boolean* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
|
| `inPrivacyRestrictedRegion` | *boolean* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
|
||||||
| `subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
|
| `subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
|
||||||
|
|||||||
24
docs/sdk/models/operations/getactorslibrarydirectory.md
Normal file
24
docs/sdk/models/operations/getactorslibrarydirectory.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# GetActorsLibraryDirectory
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetActorsLibraryDirectory } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetActorsLibraryDirectory = {
|
||||||
|
fastKey: "/library/sections/2/all?actor=134671",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
|
||||||
|
key: "134671",
|
||||||
|
title: "Aaron Paul",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
|
| `fastKey` | *string* | :heavy_check_mark: | A fast lookup key for the actor relative url. | /library/sections/2/all?actor=134671 |
|
||||||
|
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the actor. | https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | A unique key representing the actor. | 134671 |
|
||||||
|
| `title` | *string* | :heavy_check_mark: | The name of the actor. | Aaron Paul |
|
||||||
49
docs/sdk/models/operations/getactorslibrarymediacontainer.md
Normal file
49
docs/sdk/models/operations/getactorslibrarymediacontainer.md
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
# GetActorsLibraryMediaContainer
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetActorsLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetActorsLibraryMediaContainer = {
|
||||||
|
size: 50,
|
||||||
|
allowSync: false,
|
||||||
|
art: "/:/resources/show-fanart.jpg",
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
|
mediaTagVersion: 1734362201,
|
||||||
|
nocache: true,
|
||||||
|
thumb: "/:/resources/show.png",
|
||||||
|
title1: "TV Series",
|
||||||
|
title2: "By Starring Actor",
|
||||||
|
viewGroup: "secondary",
|
||||||
|
viewMode: "131131",
|
||||||
|
directory: [
|
||||||
|
{
|
||||||
|
fastKey: "/library/sections/2/all?actor=134671",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
|
||||||
|
key: "134671",
|
||||||
|
title: "Aaron Paul",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
|
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
|
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
|
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
|
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
|
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||||
|
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
|
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
|
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||||
|
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||||
|
| `viewMode` | *string* | :heavy_check_mark: | Identifier for the view mode. | 131131 |
|
||||||
|
| `directory` | [operations.GetActorsLibraryDirectory](../../../sdk/models/operations/getactorslibrarydirectory.md)[] | :heavy_minus_sign: | An array of actor entries for media items. | |
|
||||||
30
docs/sdk/models/operations/getactorslibraryqueryparamtype.md
Normal file
30
docs/sdk/models/operations/getactorslibraryqueryparamtype.md
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
# GetActorsLibraryQueryParamType
|
||||||
|
|
||||||
|
The type of media to retrieve or filter by.
|
||||||
|
1 = movie
|
||||||
|
2 = show
|
||||||
|
3 = season
|
||||||
|
4 = episode
|
||||||
|
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||||
|
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetActorsLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetActorsLibraryQueryParamType =
|
||||||
|
GetActorsLibraryQueryParamType.TvShow;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Movie` | 1 |
|
||||||
|
| `TvShow` | 2 |
|
||||||
|
| `Season` | 3 |
|
||||||
|
| `Episode` | 4 |
|
||||||
|
| `Audio` | 8 |
|
||||||
|
| `Album` | 9 |
|
||||||
|
| `Track` | 10 |
|
||||||
19
docs/sdk/models/operations/getactorslibraryrequest.md
Normal file
19
docs/sdk/models/operations/getactorslibraryrequest.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# GetActorsLibraryRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetActorsLibraryQueryParamType, GetActorsLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetActorsLibraryRequest = {
|
||||||
|
sectionKey: 9518,
|
||||||
|
type: GetActorsLibraryQueryParamType.TvShow,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
|
| `type` | [operations.GetActorsLibraryQueryParamType](../../../sdk/models/operations/getactorslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||||
49
docs/sdk/models/operations/getactorslibraryresponse.md
Normal file
49
docs/sdk/models/operations/getactorslibraryresponse.md
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
# GetActorsLibraryResponse
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetActorsLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetActorsLibraryResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 101,
|
||||||
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
}),
|
||||||
|
object: {
|
||||||
|
mediaContainer: {
|
||||||
|
size: 50,
|
||||||
|
allowSync: false,
|
||||||
|
art: "/:/resources/show-fanart.jpg",
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
|
mediaTagVersion: 1734362201,
|
||||||
|
nocache: true,
|
||||||
|
thumb: "/:/resources/show.png",
|
||||||
|
title1: "TV Series",
|
||||||
|
title2: "By Starring Actor",
|
||||||
|
viewGroup: "secondary",
|
||||||
|
viewMode: "131131",
|
||||||
|
directory: [
|
||||||
|
{
|
||||||
|
fastKey: "/library/sections/2/all?actor=134671",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
|
||||||
|
key: "134671",
|
||||||
|
title: "Aaron Paul",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [operations.GetActorsLibraryResponseBody](../../../sdk/models/operations/getactorslibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||||
41
docs/sdk/models/operations/getactorslibraryresponsebody.md
Normal file
41
docs/sdk/models/operations/getactorslibraryresponsebody.md
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
# GetActorsLibraryResponseBody
|
||||||
|
|
||||||
|
Successful response containing media container data.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetActorsLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetActorsLibraryResponseBody = {
|
||||||
|
mediaContainer: {
|
||||||
|
size: 50,
|
||||||
|
allowSync: false,
|
||||||
|
art: "/:/resources/show-fanart.jpg",
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
|
mediaTagVersion: 1734362201,
|
||||||
|
nocache: true,
|
||||||
|
thumb: "/:/resources/show.png",
|
||||||
|
title1: "TV Series",
|
||||||
|
title2: "By Starring Actor",
|
||||||
|
viewGroup: "secondary",
|
||||||
|
viewMode: "131131",
|
||||||
|
directory: [
|
||||||
|
{
|
||||||
|
fastKey: "/library/sections/2/all?actor=134671",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
|
||||||
|
key: "134671",
|
||||||
|
title: "Aaron Paul",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `mediaContainer` | [operations.GetActorsLibraryMediaContainer](../../../sdk/models/operations/getactorslibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -24,7 +24,7 @@ let value: GetAllLibrariesDirectory = {
|
|||||||
scannedAt: 1556281940,
|
scannedAt: 1556281940,
|
||||||
content: true,
|
content: true,
|
||||||
directory: true,
|
directory: true,
|
||||||
contentChangedAt: 3192854,
|
contentChangedAt: 1556281940,
|
||||||
hidden: 0,
|
hidden: 0,
|
||||||
location: [
|
location: [
|
||||||
{
|
{
|
||||||
@@ -38,25 +38,25 @@ let value: GetAllLibrariesDirectory = {
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
|
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||||
| `art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||||
| `composite` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/composite/1705615584 |
|
| `composite` | *string* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
|
||||||
| `filters` | *boolean* | :heavy_minus_sign: | N/A | true |
|
| `filters` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||||
| `refreshing` | *boolean* | :heavy_minus_sign: | N/A | false |
|
| `refreshing` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
||||||
| `key` | *string* | :heavy_minus_sign: | N/A | 1 |
|
| `key` | *string* | :heavy_check_mark: | N/A | 1 |
|
||||||
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
| `type` | *string* | :heavy_check_mark: | N/A | movie |
|
||||||
| `title` | *string* | :heavy_minus_sign: | N/A | Movies |
|
| `title` | *string* | :heavy_check_mark: | N/A | Movies |
|
||||||
| `agent` | *string* | :heavy_minus_sign: | N/A | tv.plex.agents.movie |
|
| `agent` | *string* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
|
||||||
| `scanner` | *string* | :heavy_minus_sign: | N/A | Plex Movie |
|
| `scanner` | *string* | :heavy_check_mark: | N/A | Plex Movie |
|
||||||
| `language` | *string* | :heavy_minus_sign: | N/A | en-US |
|
| `language` | *string* | :heavy_check_mark: | N/A | en-US |
|
||||||
| `uuid` | *string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
| `uuid` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||||
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
| `updatedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `createdAt` | *number* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
| `createdAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `scannedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
| `scannedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `content` | *boolean* | :heavy_minus_sign: | N/A | true |
|
| `content` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||||
| `directory` | *boolean* | :heavy_minus_sign: | N/A | true |
|
| `directory` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||||
| `contentChangedAt` | *number* | :heavy_minus_sign: | N/A | 3192854 |
|
| `contentChangedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `hidden` | *number* | :heavy_minus_sign: | N/A | 0 |
|
| `hidden` | *number* | :heavy_check_mark: | N/A | 0 |
|
||||||
| `location` | [operations.Location](../../../sdk/models/operations/location.md)[] | :heavy_minus_sign: | N/A | |
|
| `location` | [operations.GetAllLibrariesLocation](../../../sdk/models/operations/getalllibrarieslocation.md)[] | :heavy_check_mark: | N/A | |
|
||||||
19
docs/sdk/models/operations/getalllibrarieslocation.md
Normal file
19
docs/sdk/models/operations/getalllibrarieslocation.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# GetAllLibrariesLocation
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllLibrariesLocation } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetAllLibrariesLocation = {
|
||||||
|
id: 1,
|
||||||
|
path: "/movies",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A | 1 |
|
||||||
|
| `path` | *string* | :heavy_check_mark: | N/A | /movies |
|
||||||
@@ -29,7 +29,7 @@ let value: GetAllLibrariesMediaContainer = {
|
|||||||
scannedAt: 1556281940,
|
scannedAt: 1556281940,
|
||||||
content: true,
|
content: true,
|
||||||
directory: true,
|
directory: true,
|
||||||
contentChangedAt: 3192854,
|
contentChangedAt: 1556281940,
|
||||||
hidden: 0,
|
hidden: 0,
|
||||||
location: [
|
location: [
|
||||||
{
|
{
|
||||||
@@ -49,4 +49,4 @@ let value: GetAllLibrariesMediaContainer = {
|
|||||||
| `size` | *number* | :heavy_check_mark: | N/A | 5 |
|
| `size` | *number* | :heavy_check_mark: | N/A | 5 |
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||||
| `title1` | *string* | :heavy_check_mark: | N/A | Plex Library |
|
| `title1` | *string* | :heavy_check_mark: | N/A | Plex Library |
|
||||||
| `directory` | [operations.GetAllLibrariesDirectory](../../../sdk/models/operations/getalllibrariesdirectory.md)[] | :heavy_minus_sign: | N/A | |
|
| `directory` | [operations.GetAllLibrariesDirectory](../../../sdk/models/operations/getalllibrariesdirectory.md)[] | :heavy_check_mark: | N/A | |
|
||||||
@@ -7,7 +7,7 @@ import { GetAllLibrariesResponse } from "@lukehagar/plexjs/sdk/models/operations
|
|||||||
|
|
||||||
let value: GetAllLibrariesResponse = {
|
let value: GetAllLibrariesResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 437032,
|
statusCode: 308,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
@@ -36,7 +36,7 @@ let value: GetAllLibrariesResponse = {
|
|||||||
scannedAt: 1556281940,
|
scannedAt: 1556281940,
|
||||||
content: true,
|
content: true,
|
||||||
directory: true,
|
directory: true,
|
||||||
contentChangedAt: 3192854,
|
contentChangedAt: 1556281940,
|
||||||
hidden: 0,
|
hidden: 0,
|
||||||
location: [
|
location: [
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -32,7 +32,7 @@ let value: GetAllLibrariesResponseBody = {
|
|||||||
scannedAt: 1556281940,
|
scannedAt: 1556281940,
|
||||||
content: true,
|
content: true,
|
||||||
directory: true,
|
directory: true,
|
||||||
contentChangedAt: 3192854,
|
contentChangedAt: 1556281940,
|
||||||
hidden: 0,
|
hidden: 0,
|
||||||
location: [
|
location: [
|
||||||
{
|
{
|
||||||
@@ -50,4 +50,4 @@ let value: GetAllLibrariesResponseBody = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
| `mediaContainer` | [operations.GetAllLibrariesMediaContainer](../../../sdk/models/operations/getalllibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
| `mediaContainer` | [operations.GetAllLibrariesMediaContainer](../../../sdk/models/operations/getalllibrariesmediacontainer.md) | :heavy_check_mark: | N/A |
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
# GetAllMediaLibraryActiveDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllMediaLibraryActiveDirection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibraryActiveDirection =
|
||||||
|
GetAllMediaLibraryActiveDirection.Ascending;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
17
docs/sdk/models/operations/getallmedialibrarycollection.md
Normal file
17
docs/sdk/models/operations/getallmedialibrarycollection.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetAllMediaLibraryCollection
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllMediaLibraryCollection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibraryCollection = {
|
||||||
|
tag: "My Awesome Collection",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||||
|
| `tag` | *string* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user