mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 20:47:46 +00:00
Compare commits
37 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
a7ec77cd04 | ||
|
|
2b38478255 | ||
|
|
6bd12d8759 | ||
|
|
891a7d39a1 | ||
|
|
763aa8e800 | ||
|
|
7a950ea773 | ||
|
|
379a408d74 | ||
|
|
2712820397 | ||
|
|
c895213ae8 | ||
|
|
c473c9d326 | ||
|
|
3c13bba9de | ||
|
|
650c5043ef | ||
|
|
0234804578 | ||
|
|
60d913c8f9 | ||
|
|
8d9f4bbaf1 | ||
|
|
5d57cd7c34 | ||
|
|
1a8e227874 | ||
|
|
8360d057ab | ||
|
|
18b64727c3 | ||
|
|
3152372037 | ||
|
|
13cd8a7fe5 | ||
|
|
cdcdc0ca8e | ||
|
|
b03cc6a609 | ||
|
|
4e989e0de3 | ||
|
|
c10e011a68 | ||
|
|
7e3dca8466 | ||
|
|
8a2d3e04ab | ||
|
|
6c8a73ae84 | ||
|
|
c839d9f6c7 | ||
|
|
77b0ef9507 | ||
|
|
1cfbd17f28 | ||
|
|
2492807c65 | ||
|
|
ead0a8773c | ||
|
|
e254f82e06 | ||
|
|
a4369c999a | ||
|
|
c50b85f29a | ||
|
|
496ebda695 |
@@ -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",
|
||||
},
|
||||
};
|
||||
9
.gitignore
vendored
9
.gitignore
vendored
@@ -1,3 +1,12 @@
|
||||
.DS_Store
|
||||
**/.speakeasy/temp/
|
||||
**/.speakeasy/logs/
|
||||
.DS_Store
|
||||
/mcp-server
|
||||
/bin
|
||||
/.eslintcache
|
||||
/.speakeasy/reports
|
||||
/react-query
|
||||
/sdk/models/errors
|
||||
/sdk/types
|
||||
/__tests__
|
||||
|
||||
@@ -1,9 +1,14 @@
|
||||
**/*
|
||||
!/FUNCTIONS.md
|
||||
!/RUNTIMES.md
|
||||
!/REACT_QUERY.md
|
||||
!/**/*.ts
|
||||
!/**/*.js
|
||||
!/**/*.mjs
|
||||
!/**/*.json
|
||||
!/**/*.map
|
||||
|
||||
/.eslintrc.js
|
||||
/eslint.config.mjs
|
||||
/cjs
|
||||
/.tshy
|
||||
/.tshy-*
|
||||
|
||||
1243
.speakeasy/gen.lock
1243
.speakeasy/gen.lock
File diff suppressed because one or more lines are too long
@@ -4,24 +4,35 @@ generation:
|
||||
maintainOpenAPIOrder: true
|
||||
usageSnippets:
|
||||
optionalPropertyRendering: withExample
|
||||
sdkInitStyle: constructor
|
||||
useClassNamesForArrayFields: true
|
||||
fixes:
|
||||
nameResolutionDec2023: true
|
||||
nameResolutionFeb2025: false
|
||||
parameterOrderingFeb2024: true
|
||||
requestResponseComponentNamesFeb2024: true
|
||||
securityFeb2025: false
|
||||
sharedErrorComponentsApr2025: false
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
oAuth2PasswordEnabled: false
|
||||
typescript:
|
||||
version: 0.23.3
|
||||
version: 0.39.0
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies: {}
|
||||
peerDependencies: {}
|
||||
additionalPackageJSON: {}
|
||||
author: LukeHagar
|
||||
baseErrorName: PlexAPIError
|
||||
clientServerStatusCodesAsErrors: true
|
||||
defaultErrorName: SDKError
|
||||
enableCustomCodeRegions: false
|
||||
enableMCPServer: true
|
||||
enableReactQuery: false
|
||||
enumFormat: enum
|
||||
flattenGlobalSecurity: true
|
||||
flatteningOrder: body-first
|
||||
imports:
|
||||
option: openapi
|
||||
paths:
|
||||
@@ -31,6 +42,7 @@ typescript:
|
||||
shared: sdk/models/shared
|
||||
webhooks: sdk/models/webhooks
|
||||
inputModelSuffix: input
|
||||
jsonpath: legacy
|
||||
maxMethodParams: 4
|
||||
methodArguments: require-security-and-request
|
||||
moduleFormat: commonjs
|
||||
|
||||
@@ -1,35 +1,47 @@
|
||||
speakeasyVersion: 1.396.9
|
||||
speakeasyVersion: 1.557.0
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
sourceRevisionDigest: sha256:92a2a2049bfbf67bea601a6b1b77d274e83a2d3b6968a0bc02dc290b21c7689d
|
||||
sourceRevisionDigest: sha256:1b8840d540c66b58d1009ec2581fb18464158ec9aa00464eac05ba737f31207e
|
||||
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
||||
tags:
|
||||
- latest
|
||||
- main
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:dafcc1192236829b85bc924e0462432c0eb7318a17c542f46e3dd05a9a6265df
|
||||
sourceBlobDigest: sha256:bc072115d585e1695cb8393db901a3d36be1dcd57a69bad2b91a1ba7ac3c9c4b
|
||||
tags:
|
||||
- latest
|
||||
- speakeasy-sdk-regen-1749427947
|
||||
- 0.0.3
|
||||
targets:
|
||||
plexjs:
|
||||
source: my-source
|
||||
sourceNamespace: my-source
|
||||
sourceRevisionDigest: sha256:92a2a2049bfbf67bea601a6b1b77d274e83a2d3b6968a0bc02dc290b21c7689d
|
||||
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:dafcc1192236829b85bc924e0462432c0eb7318a17c542f46e3dd05a9a6265df
|
||||
sourceBlobDigest: sha256:bc072115d585e1695cb8393db901a3d36be1dcd57a69bad2b91a1ba7ac3c9c4b
|
||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||
codeSamplesRevisionDigest: sha256:0629cc7de460e272e162d660f403f38656e466953368d07e5b6b81a332f32e10
|
||||
codeSamplesRevisionDigest: sha256:a072e24cc6ba68e95422b17fb50672ce9d87d17794f824301314d9c7a6c772b6
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
sources:
|
||||
my-source:
|
||||
plexapi:
|
||||
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:
|
||||
plexjs:
|
||||
target: typescript
|
||||
source: my-source
|
||||
source: plexapi
|
||||
publish:
|
||||
npm:
|
||||
token: $npm_token
|
||||
codeSamples:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-typescript-plexjs
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||
labelOverride:
|
||||
fixedValue: PlexJS
|
||||
|
||||
@@ -1,17 +1,21 @@
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
sources:
|
||||
my-source:
|
||||
plexapi:
|
||||
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:
|
||||
plexjs:
|
||||
target: typescript
|
||||
source: my-source
|
||||
source: plexapi
|
||||
publish:
|
||||
npm:
|
||||
token: $npm_token
|
||||
codeSamples:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-typescript-plexjs
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||
labelOverride:
|
||||
fixedValue: PlexJS
|
||||
|
||||
28
FUNCTIONS.md
28
FUNCTIONS.md
@@ -21,39 +21,21 @@ specific category of applications.
|
||||
```typescript
|
||||
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
|
||||
import { serverGetServerCapabilities } from "@lukehagar/plexjs/funcs/serverGetServerCapabilities.js";
|
||||
import { SDKValidationError } from "@lukehagar/plexjs/sdk/models/errors/sdkvalidationerror.js";
|
||||
|
||||
// Use `PlexAPICore` for best tree-shaking performance.
|
||||
// You can create one instance of it to use across an application.
|
||||
const plexAPI = new PlexAPICore({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const res = await serverGetServerCapabilities(plexAPI);
|
||||
|
||||
switch (true) {
|
||||
case res.ok:
|
||||
// The success case will be handled outside of the switch block
|
||||
break;
|
||||
case res.error instanceof SDKValidationError:
|
||||
// Pretty-print validation errors.
|
||||
return console.log(res.error.pretty());
|
||||
case res.error instanceof Error:
|
||||
return console.log(res.error);
|
||||
default:
|
||||
// TypeScript's type checking will fail on the following line if the above
|
||||
// cases were not exhaustive.
|
||||
res.error satisfies never;
|
||||
throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
|
||||
}
|
||||
|
||||
|
||||
if (res.ok) {
|
||||
const { value: result } = res;
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
console.log(result);
|
||||
} else {
|
||||
console.log("serverGetServerCapabilities failed:", res.error);
|
||||
}
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
560
README.md
560
README.md
@@ -11,23 +11,56 @@
|
||||
## Summary
|
||||
|
||||
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] -->
|
||||
|
||||
<!-- Start Table of Contents [toc] -->
|
||||
## 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)
|
||||
* [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)
|
||||
* [Requirements](#requirements)
|
||||
* [Standalone functions](#standalone-functions)
|
||||
* [File uploads](#file-uploads)
|
||||
* [Retries](#retries)
|
||||
* [Debugging](#debugging)
|
||||
* [Development](#development)
|
||||
* [Maturity](#maturity)
|
||||
* [Contributions](#contributions)
|
||||
|
||||
<!-- End Table of Contents [toc] -->
|
||||
|
||||
<!-- Start SDK Installation [installation] -->
|
||||
@@ -73,13 +106,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.server.getServerCapabilities();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
@@ -117,22 +148,31 @@ run();
|
||||
### [hubs](docs/sdks/hubs/README.md)
|
||||
|
||||
* [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
|
||||
|
||||
### [library](docs/sdks/library/README.md)
|
||||
|
||||
* [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
|
||||
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||
* [getLibrarySectionsAll](docs/sdks/library/README.md#getlibrarysectionsall) - Get Library section media by tag ALL
|
||||
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The 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
|
||||
* [getMediaArts](docs/sdks/library/README.md#getmediaarts) - Get Media Background Artwork
|
||||
* [postMediaArts](docs/sdks/library/README.md#postmediaarts) - Upload Media Background Artwork
|
||||
* [getMediaPosters](docs/sdks/library/README.md#getmediaposters) - Get Media Posters
|
||||
* [postMediaPoster](docs/sdks/library/README.md#postmediaposter) - Upload Media Poster
|
||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||
|
||||
### [log](docs/sdks/log/README.md)
|
||||
|
||||
@@ -208,6 +248,10 @@ run();
|
||||
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
||||
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
||||
|
||||
### [users](docs/sdks/users/README.md)
|
||||
|
||||
* [getUsers](docs/sdks/users/README.md#getusers) - Get list of all connected users
|
||||
|
||||
### [video](docs/sdks/video/README.md)
|
||||
|
||||
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
||||
@@ -223,58 +267,43 @@ run();
|
||||
<!-- Start Error Handling [errors] -->
|
||||
## 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.
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| errors.GetServerCapabilitiesBadRequest | 400 | application/json |
|
||||
| errors.GetServerCapabilitiesUnauthorized | 401 | application/json |
|
||||
| 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.
|
||||
[`PlexAPIError`](./src/sdk/models/errors/plexapierror.ts) is the base class for all HTTP error responses. It has the following properties:
|
||||
|
||||
| Property | Type | Description |
|
||||
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
|
||||
| `error.message` | `string` | Error message |
|
||||
| `error.statusCode` | `number` | HTTP response status code eg `404` |
|
||||
| `error.headers` | `Headers` | HTTP response headers |
|
||||
| `error.body` | `string` | HTTP body. Can be empty string if no body is returned. |
|
||||
| `error.rawResponse` | `Response` | Raw HTTP response |
|
||||
| `error.data$` | | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
|
||||
|
||||
### Example
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import {
|
||||
GetServerCapabilitiesBadRequest,
|
||||
GetServerCapabilitiesUnauthorized,
|
||||
SDKValidationError,
|
||||
} from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import * as errors from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
let result;
|
||||
try {
|
||||
result = await plexAPI.server.getServerCapabilities();
|
||||
const result = await plexAPI.server.getServerCapabilities();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
} catch (err) {
|
||||
switch (true) {
|
||||
case (err instanceof SDKValidationError): {
|
||||
// Validation errors can be pretty-printed
|
||||
console.error(err.pretty());
|
||||
// Raw value may also be inspected
|
||||
console.error(err.rawValue);
|
||||
return;
|
||||
}
|
||||
case (err instanceof GetServerCapabilitiesBadRequest): {
|
||||
// Handle err.data$: GetServerCapabilitiesBadRequestData
|
||||
console.error(err);
|
||||
return;
|
||||
}
|
||||
case (err instanceof GetServerCapabilitiesUnauthorized): {
|
||||
// Handle err.data$: GetServerCapabilitiesUnauthorizedData
|
||||
console.error(err);
|
||||
return;
|
||||
}
|
||||
default: {
|
||||
throw err;
|
||||
} catch (error) {
|
||||
// The base class for HTTP error responses
|
||||
if (error instanceof errors.PlexAPIError) {
|
||||
console.log(error.message);
|
||||
console.log(error.statusCode);
|
||||
console.log(error.body);
|
||||
console.log(error.headers);
|
||||
|
||||
// Depending on the method different errors may be thrown
|
||||
if (error instanceof errors.GetServerCapabilitiesBadRequest) {
|
||||
console.log(error.data$.errors); // Errors[]
|
||||
console.log(error.data$.rawResponse); // Response
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -283,32 +312,215 @@ async function run() {
|
||||
run();
|
||||
|
||||
```
|
||||
|
||||
### Error Classes
|
||||
**Primary error:**
|
||||
* [`PlexAPIError`](./src/sdk/models/errors/plexapierror.ts): The base class for HTTP error responses.
|
||||
|
||||
<details><summary>Less common errors (162)</summary>
|
||||
|
||||
<br />
|
||||
|
||||
**Network errors:**
|
||||
* [`ConnectionError`](./src/sdk/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
|
||||
* [`RequestTimeoutError`](./src/sdk/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
|
||||
* [`RequestAbortedError`](./src/sdk/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
|
||||
* [`InvalidRequestError`](./src/sdk/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
|
||||
* [`UnexpectedClientError`](./src/sdk/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
|
||||
|
||||
|
||||
**Inherit from [`PlexAPIError`](./src/sdk/models/errors/plexapierror.ts)**:
|
||||
* [`GetServerCapabilitiesBadRequest`](docs/sdk/models/errors/getservercapabilitiesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerPreferencesBadRequest`](docs/sdk/models/errors/getserverpreferencesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetAvailableClientsBadRequest`](docs/sdk/models/errors/getavailableclientsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetDevicesBadRequest`](docs/sdk/models/errors/getdevicesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetMyPlexAccountBadRequest`](docs/sdk/models/errors/getmyplexaccountbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetResizedPhotoBadRequest`](docs/sdk/models/errors/getresizedphotobadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetMediaProvidersBadRequest`](docs/sdk/models/errors/getmediaprovidersbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerListBadRequest`](docs/sdk/models/errors/getserverlistbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`MarkPlayedBadRequest`](docs/sdk/models/errors/markplayedbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`MarkUnplayedBadRequest`](docs/sdk/models/errors/markunplayedbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`UpdatePlayProgressBadRequest`](docs/sdk/models/errors/updateplayprogressbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetBannerImageBadRequest`](docs/sdk/models/errors/getbannerimagebadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetThumbImageBadRequest`](docs/sdk/models/errors/getthumbimagebadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTimelineBadRequest`](docs/sdk/models/errors/gettimelinebadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`StartUniversalTranscodeBadRequest`](docs/sdk/models/errors/startuniversaltranscodebadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerActivitiesBadRequest`](docs/sdk/models/errors/getserveractivitiesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`CancelServerActivitiesBadRequest`](docs/sdk/models/errors/cancelserveractivitiesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetButlerTasksBadRequest`](docs/sdk/models/errors/getbutlertasksbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`StartAllTasksBadRequest`](docs/sdk/models/errors/startalltasksbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`StopAllTasksBadRequest`](docs/sdk/models/errors/stopalltasksbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`StartTaskBadRequest`](docs/sdk/models/errors/starttaskbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`StopTaskBadRequest`](docs/sdk/models/errors/stoptaskbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetCompanionsDataBadRequest`](docs/sdk/models/errors/getcompanionsdatabadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetUserFriendsBadRequest`](docs/sdk/models/errors/getuserfriendsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetGeoDataBadRequest`](docs/sdk/models/errors/getgeodatabadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetHomeDataBadRequest`](docs/sdk/models/errors/gethomedatabadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerResourcesBadRequest`](docs/sdk/models/errors/getserverresourcesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetPinBadRequest`](docs/sdk/models/errors/getpinbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTokenByPinIdBadRequest`](docs/sdk/models/errors/gettokenbypinidbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetGlobalHubsBadRequest`](docs/sdk/models/errors/getglobalhubsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetLibraryHubsBadRequest`](docs/sdk/models/errors/getlibraryhubsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`PerformSearchBadRequest`](docs/sdk/models/errors/performsearchbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`PerformVoiceSearchBadRequest`](docs/sdk/models/errors/performvoicesearchbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSearchResultsBadRequest`](docs/sdk/models/errors/getsearchresultsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetFileHashBadRequest`](docs/sdk/models/errors/getfilehashbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetRecentlyAddedLibraryBadRequest`](docs/sdk/models/errors/getrecentlyaddedlibrarybadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetAllLibrariesBadRequest`](docs/sdk/models/errors/getalllibrariesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetLibraryDetailsBadRequest`](docs/sdk/models/errors/getlibrarydetailsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`DeleteLibraryBadRequest`](docs/sdk/models/errors/deletelibrarybadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetLibraryItemsBadRequest`](docs/sdk/models/errors/getlibraryitemsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetLibrarySectionsAllBadRequest`](docs/sdk/models/errors/getlibrarysectionsallbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetRefreshLibraryMetadataBadRequest`](docs/sdk/models/errors/getrefreshlibrarymetadatabadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSearchLibraryBadRequest`](docs/sdk/models/errors/getsearchlibrarybadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetGenresLibraryBadRequest`](docs/sdk/models/errors/getgenreslibrarybadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetCountriesLibraryBadRequest`](docs/sdk/models/errors/getcountrieslibrarybadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetActorsLibraryBadRequest`](docs/sdk/models/errors/getactorslibrarybadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSearchAllLibrariesBadRequest`](docs/sdk/models/errors/getsearchalllibrariesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetMediaMetaDataBadRequest`](docs/sdk/models/errors/getmediametadatabadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetMetadataChildrenBadRequest`](docs/sdk/models/errors/getmetadatachildrenbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTopWatchedContentBadRequest`](docs/sdk/models/errors/gettopwatchedcontentbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetWatchListBadRequest`](docs/sdk/models/errors/getwatchlistbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`LogLineBadRequest`](docs/sdk/models/errors/loglinebadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`LogMultiLineBadRequest`](docs/sdk/models/errors/logmultilinebadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`EnablePaperTrailBadRequest`](docs/sdk/models/errors/enablepapertrailbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`CreatePlaylistBadRequest`](docs/sdk/models/errors/createplaylistbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetPlaylistsBadRequest`](docs/sdk/models/errors/getplaylistsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetPlaylistBadRequest`](docs/sdk/models/errors/getplaylistbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`DeletePlaylistBadRequest`](docs/sdk/models/errors/deleteplaylistbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`UpdatePlaylistBadRequest`](docs/sdk/models/errors/updateplaylistbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetPlaylistContentsBadRequest`](docs/sdk/models/errors/getplaylistcontentsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`ClearPlaylistContentsBadRequest`](docs/sdk/models/errors/clearplaylistcontentsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`AddPlaylistContentsBadRequest`](docs/sdk/models/errors/addplaylistcontentsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`UploadPlaylistBadRequest`](docs/sdk/models/errors/uploadplaylistbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTransientTokenBadRequest`](docs/sdk/models/errors/gettransienttokenbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSourceConnectionInformationBadRequest`](docs/sdk/models/errors/getsourceconnectioninformationbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTokenDetailsBadRequest`](docs/sdk/models/errors/gettokendetailsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`PostUsersSignInDataBadRequest`](docs/sdk/models/errors/postuserssignindatabadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetStatisticsBadRequest`](docs/sdk/models/errors/getstatisticsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetResourcesStatisticsBadRequest`](docs/sdk/models/errors/getresourcesstatisticsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetBandwidthStatisticsBadRequest`](docs/sdk/models/errors/getbandwidthstatisticsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSessionsBadRequest`](docs/sdk/models/errors/getsessionsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSessionHistoryBadRequest`](docs/sdk/models/errors/getsessionhistorybadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTranscodeSessionsBadRequest`](docs/sdk/models/errors/gettranscodesessionsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`StopTranscodeSessionBadRequest`](docs/sdk/models/errors/stoptranscodesessionbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetUpdateStatusBadRequest`](docs/sdk/models/errors/getupdatestatusbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`CheckForUpdatesBadRequest`](docs/sdk/models/errors/checkforupdatesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`ApplyUpdatesBadRequest`](docs/sdk/models/errors/applyupdatesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetUsersBadRequest`](docs/sdk/models/errors/getusersbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerCapabilitiesUnauthorized`](docs/sdk/models/errors/getservercapabilitiesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerPreferencesUnauthorized`](docs/sdk/models/errors/getserverpreferencesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetAvailableClientsUnauthorized`](docs/sdk/models/errors/getavailableclientsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetDevicesUnauthorized`](docs/sdk/models/errors/getdevicesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetMyPlexAccountUnauthorized`](docs/sdk/models/errors/getmyplexaccountunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetResizedPhotoUnauthorized`](docs/sdk/models/errors/getresizedphotounauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetMediaProvidersUnauthorized`](docs/sdk/models/errors/getmediaprovidersunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerListUnauthorized`](docs/sdk/models/errors/getserverlistunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`MarkPlayedUnauthorized`](docs/sdk/models/errors/markplayedunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`MarkUnplayedUnauthorized`](docs/sdk/models/errors/markunplayedunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`UpdatePlayProgressUnauthorized`](docs/sdk/models/errors/updateplayprogressunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetBannerImageUnauthorized`](docs/sdk/models/errors/getbannerimageunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetThumbImageUnauthorized`](docs/sdk/models/errors/getthumbimageunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTimelineUnauthorized`](docs/sdk/models/errors/gettimelineunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`StartUniversalTranscodeUnauthorized`](docs/sdk/models/errors/startuniversaltranscodeunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerActivitiesUnauthorized`](docs/sdk/models/errors/getserveractivitiesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`CancelServerActivitiesUnauthorized`](docs/sdk/models/errors/cancelserveractivitiesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetButlerTasksUnauthorized`](docs/sdk/models/errors/getbutlertasksunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`StartAllTasksUnauthorized`](docs/sdk/models/errors/startalltasksunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`StopAllTasksUnauthorized`](docs/sdk/models/errors/stopalltasksunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`StartTaskUnauthorized`](docs/sdk/models/errors/starttaskunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`StopTaskUnauthorized`](docs/sdk/models/errors/stoptaskunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetCompanionsDataUnauthorized`](docs/sdk/models/errors/getcompanionsdataunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetUserFriendsUnauthorized`](docs/sdk/models/errors/getuserfriendsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetGeoDataUnauthorized`](docs/sdk/models/errors/getgeodataunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetHomeDataUnauthorized`](docs/sdk/models/errors/gethomedataunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerResourcesUnauthorized`](docs/sdk/models/errors/getserverresourcesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetGlobalHubsUnauthorized`](docs/sdk/models/errors/getglobalhubsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetLibraryHubsUnauthorized`](docs/sdk/models/errors/getlibraryhubsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`PerformSearchUnauthorized`](docs/sdk/models/errors/performsearchunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`PerformVoiceSearchUnauthorized`](docs/sdk/models/errors/performvoicesearchunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSearchResultsUnauthorized`](docs/sdk/models/errors/getsearchresultsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetFileHashUnauthorized`](docs/sdk/models/errors/getfilehashunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetRecentlyAddedLibraryUnauthorized`](docs/sdk/models/errors/getrecentlyaddedlibraryunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetAllLibrariesUnauthorized`](docs/sdk/models/errors/getalllibrariesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetLibraryDetailsUnauthorized`](docs/sdk/models/errors/getlibrarydetailsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`DeleteLibraryUnauthorized`](docs/sdk/models/errors/deletelibraryunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetLibraryItemsUnauthorized`](docs/sdk/models/errors/getlibraryitemsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetLibrarySectionsAllUnauthorized`](docs/sdk/models/errors/getlibrarysectionsallunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetRefreshLibraryMetadataUnauthorized`](docs/sdk/models/errors/getrefreshlibrarymetadataunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSearchLibraryUnauthorized`](docs/sdk/models/errors/getsearchlibraryunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetGenresLibraryUnauthorized`](docs/sdk/models/errors/getgenreslibraryunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetCountriesLibraryUnauthorized`](docs/sdk/models/errors/getcountrieslibraryunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetActorsLibraryUnauthorized`](docs/sdk/models/errors/getactorslibraryunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSearchAllLibrariesUnauthorized`](docs/sdk/models/errors/getsearchalllibrariesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetMediaMetaDataUnauthorized`](docs/sdk/models/errors/getmediametadataunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetMetadataChildrenUnauthorized`](docs/sdk/models/errors/getmetadatachildrenunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTopWatchedContentUnauthorized`](docs/sdk/models/errors/gettopwatchedcontentunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetWatchListUnauthorized`](docs/sdk/models/errors/getwatchlistunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`LogLineUnauthorized`](docs/sdk/models/errors/loglineunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`LogMultiLineUnauthorized`](docs/sdk/models/errors/logmultilineunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`EnablePaperTrailUnauthorized`](docs/sdk/models/errors/enablepapertrailunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`CreatePlaylistUnauthorized`](docs/sdk/models/errors/createplaylistunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetPlaylistsUnauthorized`](docs/sdk/models/errors/getplaylistsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetPlaylistUnauthorized`](docs/sdk/models/errors/getplaylistunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`DeletePlaylistUnauthorized`](docs/sdk/models/errors/deleteplaylistunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`UpdatePlaylistUnauthorized`](docs/sdk/models/errors/updateplaylistunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetPlaylistContentsUnauthorized`](docs/sdk/models/errors/getplaylistcontentsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`ClearPlaylistContentsUnauthorized`](docs/sdk/models/errors/clearplaylistcontentsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`AddPlaylistContentsUnauthorized`](docs/sdk/models/errors/addplaylistcontentsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`UploadPlaylistUnauthorized`](docs/sdk/models/errors/uploadplaylistunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTransientTokenUnauthorized`](docs/sdk/models/errors/gettransienttokenunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSourceConnectionInformationUnauthorized`](docs/sdk/models/errors/getsourceconnectioninformationunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTokenDetailsUnauthorized`](docs/sdk/models/errors/gettokendetailsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`PostUsersSignInDataUnauthorized`](docs/sdk/models/errors/postuserssignindataunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetStatisticsUnauthorized`](docs/sdk/models/errors/getstatisticsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetResourcesStatisticsUnauthorized`](docs/sdk/models/errors/getresourcesstatisticsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetBandwidthStatisticsUnauthorized`](docs/sdk/models/errors/getbandwidthstatisticsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSessionsUnauthorized`](docs/sdk/models/errors/getsessionsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSessionHistoryUnauthorized`](docs/sdk/models/errors/getsessionhistoryunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTranscodeSessionsUnauthorized`](docs/sdk/models/errors/gettranscodesessionsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`StopTranscodeSessionUnauthorized`](docs/sdk/models/errors/stoptranscodesessionunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetUpdateStatusUnauthorized`](docs/sdk/models/errors/getupdatestatusunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`CheckForUpdatesUnauthorized`](docs/sdk/models/errors/checkforupdatesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`ApplyUpdatesUnauthorized`](docs/sdk/models/errors/applyupdatesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetUsersUnauthorized`](docs/sdk/models/errors/getusersunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTokenByPinIdResponseBody`](docs/sdk/models/errors/gettokenbypinidresponsebody.md): Not Found or Expired. Status code `404`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerIdentityRequestTimeout`](docs/sdk/models/errors/getserveridentityrequesttimeout.md): Request Timeout. Status code `408`. Applicable to 1 of 84 methods.*
|
||||
* [`ResponseValidationError`](./src/sdk/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
|
||||
|
||||
</details>
|
||||
|
||||
\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
|
||||
<!-- End Error Handling [errors] -->
|
||||
|
||||
<!-- Start Server Selection [server] -->
|
||||
## Server Selection
|
||||
|
||||
### Select Server by Index
|
||||
### Server Variables
|
||||
|
||||
You can override the default server globally by passing a server index to the `serverIdx` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
|
||||
The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following parameters are available when initializing the SDK client instance:
|
||||
|
||||
| # | Server | Variables |
|
||||
| - | ------ | --------- |
|
||||
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `https`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
||||
| Variable | Parameter | Supported Values | Default | Description |
|
||||
| ---------- | --------------------------------- | -------------------------- | --------------- | ---------------------------------------------- |
|
||||
| `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
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
serverIdx: 0,
|
||||
protocol: "https",
|
||||
ip: "4982:bc2a:b4f8:efb5:2394:5bc3:ab4f:0e6d",
|
||||
port: "44765",
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.server.getServerCapabilities();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
@@ -316,54 +528,42 @@ 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
|
||||
|
||||
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
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
serverURL: "{protocol}://{ip}:{port}",
|
||||
serverURL: "https://10.10.10.47:32400",
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.server.getServerCapabilities();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
|
||||
### 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:
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.plex.getCompanionsData({
|
||||
serverURL: "https://plex.tv/api/v2/",
|
||||
serverURL: "https://plex.tv/api/v2",
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
@@ -429,7 +629,7 @@ const sdk = new PlexAPI({ httpClient });
|
||||
This SDK supports the following security scheme globally:
|
||||
|
||||
| Name | Type | Scheme |
|
||||
| ------------- | ------------- | ------------- |
|
||||
| ------------- | ------ | ------- |
|
||||
| `accessToken` | apiKey | API key |
|
||||
|
||||
To authenticate with the API the `accessToken` parameter must be set when initializing the SDK client instance. For example:
|
||||
@@ -438,13 +638,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.server.getServerCapabilities();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
@@ -474,136 +672,128 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
|
||||
<summary>Available standalone functions</summary>
|
||||
|
||||
- [activitiesCancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities)
|
||||
- [activitiesGetServerActivities](docs/sdks/activities/README.md#getserveractivities)
|
||||
- [authenticationGetSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation)
|
||||
- [authenticationGetTokenDetails](docs/sdks/authentication/README.md#gettokendetails)
|
||||
- [authenticationGetTransientToken](docs/sdks/authentication/README.md#gettransienttoken)
|
||||
- [authenticationPostUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata)
|
||||
- [butlerGetButlerTasks](docs/sdks/butler/README.md#getbutlertasks)
|
||||
- [butlerStartAllTasks](docs/sdks/butler/README.md#startalltasks)
|
||||
- [butlerStartTask](docs/sdks/butler/README.md#starttask)
|
||||
- [butlerStopAllTasks](docs/sdks/butler/README.md#stopalltasks)
|
||||
- [butlerStopTask](docs/sdks/butler/README.md#stoptask)
|
||||
- [hubsGetGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs)
|
||||
- [hubsGetLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs)
|
||||
- [libraryDeleteLibrary](docs/sdks/library/README.md#deletelibrary)
|
||||
- [libraryGetAllLibraries](docs/sdks/library/README.md#getalllibraries)
|
||||
- [libraryGetFileHash](docs/sdks/library/README.md#getfilehash)
|
||||
- [libraryGetLibraryDetails](docs/sdks/library/README.md#getlibrarydetails)
|
||||
- [libraryGetLibraryItems](docs/sdks/library/README.md#getlibraryitems)
|
||||
- [libraryGetMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey)
|
||||
- [libraryGetMetadataChildren](docs/sdks/library/README.md#getmetadatachildren)
|
||||
- [libraryGetOnDeck](docs/sdks/library/README.md#getondeck)
|
||||
- [libraryGetRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded)
|
||||
- [libraryGetRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata)
|
||||
- [libraryGetSearchLibrary](docs/sdks/library/README.md#getsearchlibrary)
|
||||
- [libraryGetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent)
|
||||
- [logEnablePaperTrail](docs/sdks/log/README.md#enablepapertrail)
|
||||
- [logLogLine](docs/sdks/log/README.md#logline)
|
||||
- [logLogMultiLine](docs/sdks/log/README.md#logmultiline)
|
||||
- [mediaGetBannerImage](docs/sdks/media/README.md#getbannerimage)
|
||||
- [mediaGetThumbImage](docs/sdks/media/README.md#getthumbimage)
|
||||
- [mediaMarkPlayed](docs/sdks/media/README.md#markplayed)
|
||||
- [mediaMarkUnplayed](docs/sdks/media/README.md#markunplayed)
|
||||
- [mediaUpdatePlayProgress](docs/sdks/media/README.md#updateplayprogress)
|
||||
- [playlistsAddPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents)
|
||||
- [playlistsClearPlaylistContents](docs/sdks/playlists/README.md#clearplaylistcontents)
|
||||
- [playlistsCreatePlaylist](docs/sdks/playlists/README.md#createplaylist)
|
||||
- [playlistsDeletePlaylist](docs/sdks/playlists/README.md#deleteplaylist)
|
||||
- [playlistsGetPlaylistContents](docs/sdks/playlists/README.md#getplaylistcontents)
|
||||
- [playlistsGetPlaylist](docs/sdks/playlists/README.md#getplaylist)
|
||||
- [playlistsGetPlaylists](docs/sdks/playlists/README.md#getplaylists)
|
||||
- [playlistsUpdatePlaylist](docs/sdks/playlists/README.md#updateplaylist)
|
||||
- [playlistsUploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist)
|
||||
- [plexGetCompanionsData](docs/sdks/plex/README.md#getcompanionsdata)
|
||||
- [plexGetGeoData](docs/sdks/plex/README.md#getgeodata)
|
||||
- [plexGetHomeData](docs/sdks/plex/README.md#gethomedata)
|
||||
- [plexGetPin](docs/sdks/plex/README.md#getpin)
|
||||
- [plexGetServerResources](docs/sdks/plex/README.md#getserverresources)
|
||||
- [plexGetTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid)
|
||||
- [plexGetUserFriends](docs/sdks/plex/README.md#getuserfriends)
|
||||
- [searchGetSearchResults](docs/sdks/search/README.md#getsearchresults)
|
||||
- [searchPerformSearch](docs/sdks/search/README.md#performsearch)
|
||||
- [searchPerformVoiceSearch](docs/sdks/search/README.md#performvoicesearch)
|
||||
- [serverGetAvailableClients](docs/sdks/server/README.md#getavailableclients)
|
||||
- [serverGetDevices](docs/sdks/server/README.md#getdevices)
|
||||
- [serverGetMediaProviders](docs/sdks/server/README.md#getmediaproviders)
|
||||
- [serverGetMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount)
|
||||
- [serverGetResizedPhoto](docs/sdks/server/README.md#getresizedphoto)
|
||||
- [serverGetServerCapabilities](docs/sdks/server/README.md#getservercapabilities)
|
||||
- [serverGetServerIdentity](docs/sdks/server/README.md#getserveridentity)
|
||||
- [serverGetServerList](docs/sdks/server/README.md#getserverlist)
|
||||
- [serverGetServerPreferences](docs/sdks/server/README.md#getserverpreferences)
|
||||
- [sessionsGetSessionHistory](docs/sdks/sessions/README.md#getsessionhistory)
|
||||
- [sessionsGetSessions](docs/sdks/sessions/README.md#getsessions)
|
||||
- [sessionsGetTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions)
|
||||
- [sessionsStopTranscodeSession](docs/sdks/sessions/README.md#stoptranscodesession)
|
||||
- [statisticsGetBandwidthStatistics](docs/sdks/statistics/README.md#getbandwidthstatistics)
|
||||
- [statisticsGetResourcesStatistics](docs/sdks/statistics/README.md#getresourcesstatistics)
|
||||
- [statisticsGetStatistics](docs/sdks/statistics/README.md#getstatistics)
|
||||
- [updaterApplyUpdates](docs/sdks/updater/README.md#applyupdates)
|
||||
- [updaterCheckForUpdates](docs/sdks/updater/README.md#checkforupdates)
|
||||
- [updaterGetUpdateStatus](docs/sdks/updater/README.md#getupdatestatus)
|
||||
- [videoGetTimeline](docs/sdks/video/README.md#gettimeline)
|
||||
- [videoStartUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode)
|
||||
- [watchlistGetWatchList](docs/sdks/watchlist/README.md#getwatchlist)
|
||||
|
||||
- [`activitiesCancelServerActivities`](docs/sdks/activities/README.md#cancelserveractivities) - Cancel Server Activities
|
||||
- [`activitiesGetServerActivities`](docs/sdks/activities/README.md#getserveractivities) - Get Server Activities
|
||||
- [`authenticationGetSourceConnectionInformation`](docs/sdks/authentication/README.md#getsourceconnectioninformation) - Get Source Connection Information
|
||||
- [`authenticationGetTokenDetails`](docs/sdks/authentication/README.md#gettokendetails) - Get Token Details
|
||||
- [`authenticationGetTransientToken`](docs/sdks/authentication/README.md#gettransienttoken) - Get a Transient Token
|
||||
- [`authenticationPostUsersSignInData`](docs/sdks/authentication/README.md#postuserssignindata) - Get User Sign In Data
|
||||
- [`butlerGetButlerTasks`](docs/sdks/butler/README.md#getbutlertasks) - Get Butler tasks
|
||||
- [`butlerStartAllTasks`](docs/sdks/butler/README.md#startalltasks) - Start all Butler tasks
|
||||
- [`butlerStartTask`](docs/sdks/butler/README.md#starttask) - Start a single Butler task
|
||||
- [`butlerStopAllTasks`](docs/sdks/butler/README.md#stopalltasks) - Stop all Butler tasks
|
||||
- [`butlerStopTask`](docs/sdks/butler/README.md#stoptask) - Stop a single Butler task
|
||||
- [`hubsGetGlobalHubs`](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
|
||||
- [`hubsGetLibraryHubs`](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
||||
- [`hubsGetRecentlyAdded`](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
|
||||
- [`libraryDeleteLibrary`](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||
- [`libraryGetActorsLibrary`](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
|
||||
- [`libraryGetAllLibraries`](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
||||
- [`libraryGetCountriesLibrary`](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
|
||||
- [`libraryGetFileHash`](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||
- [`libraryGetGenresLibrary`](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
||||
- [`libraryGetLibraryDetails`](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||
- [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||
- [`libraryGetLibrarySectionsAll`](docs/sdks/library/README.md#getlibrarysectionsall) - Get Library section media by tag ALL
|
||||
- [`libraryGetMediaArts`](docs/sdks/library/README.md#getmediaarts) - Get Media Background Artwork
|
||||
- [`libraryGetMediaMetaData`](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
||||
- [`libraryGetMediaPosters`](docs/sdks/library/README.md#getmediaposters) - Get Media Posters
|
||||
- [`libraryGetMetadataChildren`](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||
- [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
|
||||
- [`libraryGetRefreshLibraryMetadata`](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||
- [`libraryGetSearchAllLibraries`](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||
- [`libraryGetSearchLibrary`](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||
- [`libraryGetTopWatchedContent`](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||
- [`libraryPostMediaArts`](docs/sdks/library/README.md#postmediaarts) - Upload Media Background Artwork
|
||||
- [`libraryPostMediaPoster`](docs/sdks/library/README.md#postmediaposter) - Upload Media Poster
|
||||
- [`logEnablePaperTrail`](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
|
||||
- [`logLogLine`](docs/sdks/log/README.md#logline) - Logging a single line message.
|
||||
- [`logLogMultiLine`](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
|
||||
- [`mediaGetBannerImage`](docs/sdks/media/README.md#getbannerimage) - Get Banner Image
|
||||
- [`mediaGetThumbImage`](docs/sdks/media/README.md#getthumbimage) - Get Thumb Image
|
||||
- [`mediaMarkPlayed`](docs/sdks/media/README.md#markplayed) - Mark Media Played
|
||||
- [`mediaMarkUnplayed`](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
|
||||
- [`mediaUpdatePlayProgress`](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress
|
||||
- [`playlistsAddPlaylistContents`](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a Playlist
|
||||
- [`playlistsClearPlaylistContents`](docs/sdks/playlists/README.md#clearplaylistcontents) - Delete Playlist Contents
|
||||
- [`playlistsCreatePlaylist`](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
|
||||
- [`playlistsDeletePlaylist`](docs/sdks/playlists/README.md#deleteplaylist) - Deletes a Playlist
|
||||
- [`playlistsGetPlaylist`](docs/sdks/playlists/README.md#getplaylist) - Retrieve Playlist
|
||||
- [`playlistsGetPlaylistContents`](docs/sdks/playlists/README.md#getplaylistcontents) - Retrieve Playlist Contents
|
||||
- [`playlistsGetPlaylists`](docs/sdks/playlists/README.md#getplaylists) - Get All Playlists
|
||||
- [`playlistsUpdatePlaylist`](docs/sdks/playlists/README.md#updateplaylist) - Update a Playlist
|
||||
- [`playlistsUploadPlaylist`](docs/sdks/playlists/README.md#uploadplaylist) - Upload Playlist
|
||||
- [`plexGetCompanionsData`](docs/sdks/plex/README.md#getcompanionsdata) - Get Companions Data
|
||||
- [`plexGetGeoData`](docs/sdks/plex/README.md#getgeodata) - Get Geo Data
|
||||
- [`plexGetHomeData`](docs/sdks/plex/README.md#gethomedata) - Get Plex Home Data
|
||||
- [`plexGetPin`](docs/sdks/plex/README.md#getpin) - Get a Pin
|
||||
- [`plexGetServerResources`](docs/sdks/plex/README.md#getserverresources) - Get Server Resources
|
||||
- [`plexGetTokenByPinId`](docs/sdks/plex/README.md#gettokenbypinid) - Get Access Token by PinId
|
||||
- [`plexGetUserFriends`](docs/sdks/plex/README.md#getuserfriends) - Get list of friends of the user logged in
|
||||
- [`searchGetSearchResults`](docs/sdks/search/README.md#getsearchresults) - Get Search Results
|
||||
- [`searchPerformSearch`](docs/sdks/search/README.md#performsearch) - Perform a search
|
||||
- [`searchPerformVoiceSearch`](docs/sdks/search/README.md#performvoicesearch) - Perform a voice search
|
||||
- [`serverGetAvailableClients`](docs/sdks/server/README.md#getavailableclients) - Get Available Clients
|
||||
- [`serverGetDevices`](docs/sdks/server/README.md#getdevices) - Get Devices
|
||||
- [`serverGetMediaProviders`](docs/sdks/server/README.md#getmediaproviders) - Get Media Providers
|
||||
- [`serverGetMyPlexAccount`](docs/sdks/server/README.md#getmyplexaccount) - Get MyPlex Account
|
||||
- [`serverGetResizedPhoto`](docs/sdks/server/README.md#getresizedphoto) - Get a Resized Photo
|
||||
- [`serverGetServerCapabilities`](docs/sdks/server/README.md#getservercapabilities) - Get Server Capabilities
|
||||
- [`serverGetServerIdentity`](docs/sdks/server/README.md#getserveridentity) - Get Server Identity
|
||||
- [`serverGetServerList`](docs/sdks/server/README.md#getserverlist) - Get Server List
|
||||
- [`serverGetServerPreferences`](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
|
||||
- [`sessionsGetSessionHistory`](docs/sdks/sessions/README.md#getsessionhistory) - Get Session History
|
||||
- [`sessionsGetSessions`](docs/sdks/sessions/README.md#getsessions) - Get Active Sessions
|
||||
- [`sessionsGetTranscodeSessions`](docs/sdks/sessions/README.md#gettranscodesessions) - Get Transcode Sessions
|
||||
- [`sessionsStopTranscodeSession`](docs/sdks/sessions/README.md#stoptranscodesession) - Stop a Transcode Session
|
||||
- [`statisticsGetBandwidthStatistics`](docs/sdks/statistics/README.md#getbandwidthstatistics) - Get Bandwidth Statistics
|
||||
- [`statisticsGetResourcesStatistics`](docs/sdks/statistics/README.md#getresourcesstatistics) - Get Resources Statistics
|
||||
- [`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>
|
||||
<!-- End Standalone functions [standalone-funcs] -->
|
||||
|
||||
<!-- Start Global Parameters [global-parameters] -->
|
||||
## Global Parameters
|
||||
<!-- Start File uploads [file-upload] -->
|
||||
## File uploads
|
||||
|
||||
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.
|
||||
Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
|
||||
|
||||
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
|
||||
> [!TIP]
|
||||
>
|
||||
> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
|
||||
>
|
||||
> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
|
||||
> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.
|
||||
> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `<input type="file">` element.
|
||||
> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).
|
||||
|
||||
```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,
|
||||
const result = await plexAPI.library.postMediaArts(
|
||||
2268,
|
||||
"https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b",
|
||||
);
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End Global Parameters [global-parameters] -->
|
||||
<!-- End File uploads [file-upload] -->
|
||||
|
||||
<!-- Start Retries [retries] -->
|
||||
## Retries
|
||||
@@ -616,7 +806,6 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -633,7 +822,6 @@ async function run() {
|
||||
},
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
@@ -657,13 +845,11 @@ const plexAPI = new PlexAPI({
|
||||
retryConnectionErrors: false,
|
||||
},
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.server.getServerCapabilities();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
|
||||
310
RELEASES.md
310
RELEASES.md
@@ -1049,3 +1049,313 @@ Based on:
|
||||
- [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 - .
|
||||
|
||||
## 2025-03-09 00:09:12
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.513.4 (2.545.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.35.1] .
|
||||
### Releases
|
||||
- [NPM v0.35.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.1 - .
|
||||
|
||||
## 2025-03-31 16:31:46
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.35.2] .
|
||||
### Releases
|
||||
- [NPM v0.35.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.2 - .
|
||||
|
||||
## 2025-03-31 19:33:46
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.35.3] .
|
||||
### Releases
|
||||
- [NPM v0.35.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.3 - .
|
||||
|
||||
## 2025-03-31 19:42:25
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.35.4] .
|
||||
### Releases
|
||||
- [NPM v0.35.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.4 - .
|
||||
|
||||
## 2025-04-03 00:10:29
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.528.1 (2.565.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.36.0] .
|
||||
### Releases
|
||||
- [NPM v0.36.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.36.0 - .
|
||||
|
||||
## 2025-04-06 00:11:19
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.529.1 (2.566.5) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.36.1] .
|
||||
### Releases
|
||||
- [NPM v0.36.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.36.1 - .
|
||||
|
||||
## 2025-04-14 00:11:23
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.531.4 (2.570.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.36.2] .
|
||||
### Releases
|
||||
- [NPM v0.36.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.36.2 - .
|
||||
|
||||
## 2025-04-19 00:10:19
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.535.1 (2.585.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.37.0] .
|
||||
### Releases
|
||||
- [NPM v0.37.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.37.0 - .
|
||||
|
||||
## 2025-05-01 00:12:16
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.541.2 (2.595.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.37.1] .
|
||||
### Releases
|
||||
- [NPM v0.37.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.37.1 - .
|
||||
|
||||
## 2025-05-05 00:11:37
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.542.1 (2.597.9) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.37.2] .
|
||||
### Releases
|
||||
- [NPM v0.37.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.37.2 - .
|
||||
|
||||
## 2025-06-04 00:11:21
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.555.2 (2.620.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.38.0] .
|
||||
### Releases
|
||||
- [NPM v0.38.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.38.0 - .
|
||||
|
||||
## 2025-06-09 00:12:06
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.557.0 (2.623.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.39.0] .
|
||||
### Releases
|
||||
- [NPM v0.39.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.39.0 - .
|
||||
28
RUNTIMES.md
28
RUNTIMES.md
@@ -1,6 +1,6 @@
|
||||
# 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 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])
|
||||
|
||||
[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.
|
||||
2
USAGE.md
2
USAGE.md
@@ -4,13 +4,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.server.getServerCapabilities();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
|
||||
1641
codeSamples.yaml
1641
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.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetRecentlyAddedBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetActorsLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -14,5 +14,5 @@ import { GetRecentlyAddedBadRequest } from "@lukehagar/plexjs/sdk/models/errors"
|
||||
|
||||
| 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 |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetRecentlyAddedErrors
|
||||
# GetActorsLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```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,
|
||||
message: "X-Plex-Client-Identifier is missing",
|
||||
status: 400,
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMetaDataByRatingKeyLibraryErrors
|
||||
# GetActorsLibraryLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```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,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
18
docs/sdk/models/errors/getactorslibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getactorslibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetActorsLibraryUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetActorsLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetActorsLibraryLibraryErrors](../../../sdk/models/errors/getactorslibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
18
docs/sdk/models/errors/getcountrieslibrarybadrequest.md
Normal file
18
docs/sdk/models/errors/getcountrieslibrarybadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetCountriesLibraryBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetCountriesLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetCountriesLibraryErrors](../../../sdk/models/errors/getcountrieslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMetaDataByRatingKeyErrors
|
||||
# GetCountriesLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetaDataByRatingKeyErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetCountriesLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetMetaDataByRatingKeyErrors = {
|
||||
let value: GetCountriesLibraryErrors = {
|
||||
code: 1000,
|
||||
message: "X-Plex-Client-Identifier is missing",
|
||||
status: 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 |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetOnDeckUnauthorized
|
||||
# GetGenresLibraryBadRequest
|
||||
|
||||
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
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetGenresLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -14,5 +14,5 @@ import { GetOnDeckUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetOnDeckLibraryErrors](../../../sdk/models/errors/getondecklibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `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/getlibrarysectionsallbadrequest.md
Normal file
18
docs/sdk/models/errors/getlibrarysectionsallbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetLibrarySectionsAllBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibrarySectionsAllBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetLibrarySectionsAllErrors](../../../sdk/models/errors/getlibrarysectionsallerrors.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/getlibrarysectionsallerrors.md
Normal file
21
docs/sdk/models/errors/getlibrarysectionsallerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetLibrarySectionsAllErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibrarySectionsAllErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetLibrarySectionsAllErrors = {
|
||||
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/getlibrarysectionsalllibraryerrors.md
Normal file
21
docs/sdk/models/errors/getlibrarysectionsalllibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetLibrarySectionsAllLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibrarySectionsAllLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetLibrarySectionsAllLibraryErrors = {
|
||||
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/getlibrarysectionsallunauthorized.md
Normal file
18
docs/sdk/models/errors/getlibrarysectionsallunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetLibrarySectionsAllUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibrarySectionsAllUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetLibrarySectionsAllLibraryErrors](../../../sdk/models/errors/getlibrarysectionsalllibraryerrors.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,18 +0,0 @@
|
||||
# GetOnDeckBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetOnDeckErrors](../../../sdk/models/errors/getondeckerrors.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
|
||||
|
||||
```typescript
|
||||
import { GetRecentlyAddedUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetRecentlyAddedLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { GetRecentlyAddedLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetRecentlyAddedLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
code: 1000,
|
||||
message: "X-Plex-Client-Identifier is missing",
|
||||
status: 400,
|
||||
};
|
||||
```
|
||||
|
||||
## 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 |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `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 |
|
||||
@@ -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 |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetOnDeckErrors
|
||||
# GetUsersErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetUsersErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetOnDeckErrors = {
|
||||
let value: GetUsersErrors = {
|
||||
code: 1000,
|
||||
message: "X-Plex-Client-Identifier is missing",
|
||||
status: 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 |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetOnDeckLibraryErrors
|
||||
# GetUsersUsersErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetUsersUsersErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetOnDeckLibraryErrors = {
|
||||
let value: GetUsersUsersErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 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";
|
||||
|
||||
let value: AddPlaylistContentsRequest = {
|
||||
playlistID: 8209.94,
|
||||
playlistID: 1207.42,
|
||||
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
||||
playQueueID: 123,
|
||||
};
|
||||
|
||||
@@ -5,38 +5,7 @@
|
||||
```typescript
|
||||
import { AddPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 13571,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 1,
|
||||
leafCountAdded: 1,
|
||||
leafCountRequested: 1,
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "94",
|
||||
key: "/playlists/94/items",
|
||||
guid:
|
||||
"com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2",
|
||||
type: "playlist",
|
||||
title: "A great playlist",
|
||||
summary: "One of my great playlists",
|
||||
smart: false,
|
||||
playlistType: "video",
|
||||
composite: "/playlists/94/composite/1705800070",
|
||||
duration: 423000,
|
||||
leafCount: 3,
|
||||
addedAt: 1705716458,
|
||||
updatedAt: 1705800070,
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
let value: AddPlaylistContentsResponse = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
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 |
|
||||
@@ -5,13 +5,7 @@
|
||||
```typescript
|
||||
import { ApplyUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ApplyUpdatesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 667411,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
};
|
||||
let value: ApplyUpdatesResponse = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
21
docs/sdk/models/operations/attributes.md
Normal file
21
docs/sdk/models/operations/attributes.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Attributes
|
||||
|
||||
Attributes associated with the marker.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Attributes } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Attributes = {
|
||||
id: 306970,
|
||||
version: 4,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | The identifier for the attributes. | 306970 |
|
||||
| `version` | *number* | :heavy_minus_sign: | The version number of the marker attributes. | 4 |
|
||||
@@ -7,12 +7,12 @@ The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign aud
|
||||
```typescript
|
||||
import { AutoSelectSubtitle } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AutoSelectSubtitle = AutoSelectSubtitle.One;
|
||||
let value: AutoSelectSubtitle = AutoSelectSubtitle.Enable;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
@@ -7,7 +7,7 @@ import { Billing } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Billing = {
|
||||
internalPaymentMethod: {},
|
||||
paymentMethodId: 414263,
|
||||
paymentMethodId: 575569,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -5,13 +5,7 @@
|
||||
```typescript
|
||||
import { CancelServerActivitiesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CancelServerActivitiesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 812169,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
};
|
||||
let value: CancelServerActivitiesResponse = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
29
docs/sdk/models/operations/chapter.md
Normal file
29
docs/sdk/models/operations/chapter.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Chapter
|
||||
|
||||
The thumbnail for the chapter
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Chapter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Chapter = {
|
||||
id: 4,
|
||||
filter: "thumb=4",
|
||||
index: 1,
|
||||
startTimeOffset: 0,
|
||||
endTimeOffset: 100100,
|
||||
thumb: "/library/media/46883/chapterImages/1",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 4 |
|
||||
| `filter` | *string* | :heavy_check_mark: | N/A | thumb=4 |
|
||||
| `index` | *number* | :heavy_check_mark: | N/A | 1 |
|
||||
| `startTimeOffset` | *number* | :heavy_check_mark: | N/A | 0 |
|
||||
| `endTimeOffset` | *number* | :heavy_check_mark: | N/A | 100100 |
|
||||
| `thumb` | *string* | :heavy_check_mark: | N/A | /library/media/46883/chapterImages/1 |
|
||||
@@ -5,13 +5,7 @@
|
||||
```typescript
|
||||
import { CheckForUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CheckForUpdatesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 9356,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
};
|
||||
let value: CheckForUpdatesResponse = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ClearPlaylistContentsRequest = {
|
||||
playlistID: 3687.25,
|
||||
playlistID: 5077.01,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -5,13 +5,7 @@
|
||||
```typescript
|
||||
import { ClearPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ClearPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 662527,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
};
|
||||
let value: ClearPlaylistContentsResponse = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
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: "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 |
|
||||
@@ -3,27 +3,27 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Connections } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { Connections, Protocol } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Connections = {
|
||||
protocol: "<value>",
|
||||
address: "718 Wolff Light",
|
||||
port: 7991.59,
|
||||
uri: "https://jumbo-lobotomy.net",
|
||||
local: false,
|
||||
relay: false,
|
||||
iPv6: false,
|
||||
protocol: Protocol.Http,
|
||||
address: "84577 W 9th Street",
|
||||
port: 610910,
|
||||
uri: "https://dearest-custom.net",
|
||||
local: true,
|
||||
relay: true,
|
||||
iPv6: true,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `protocol` | *string* | :heavy_check_mark: | N/A |
|
||||
| `address` | *string* | :heavy_check_mark: | N/A |
|
||||
| `port` | *number* | :heavy_check_mark: | N/A |
|
||||
| `uri` | *string* | :heavy_check_mark: | N/A |
|
||||
| `local` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `relay` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `iPv6` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `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: | The (ip) address or domain name used for the connection | |
|
||||
| `port` | *number* | :heavy_check_mark: | The port used for the connection | |
|
||||
| `uri` | *string* | :heavy_check_mark: | The full URI of the connection | |
|
||||
| `local` | *boolean* | :heavy_check_mark: | If the connection is local address | |
|
||||
| `relay` | *boolean* | :heavy_check_mark: | If the connection is relayed through plex.direct | |
|
||||
| `iPv6` | *boolean* | :heavy_check_mark: | If the connection is using IPv6 | |
|
||||
@@ -1,17 +1,23 @@
|
||||
# Country
|
||||
|
||||
The filter query string for country media items.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Country } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Country = {
|
||||
id: 259,
|
||||
tag: "United States of America",
|
||||
filter: "country=19",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||
| `filter` | *string* | :heavy_check_mark: | N/A | country=19 |
|
||||
@@ -7,13 +7,16 @@ type of playlist to create
|
||||
```typescript
|
||||
import { CreatePlaylistQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Audio;
|
||||
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Photo;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Audio` | audio |
|
||||
| `Video` | video |
|
||||
| `Photo` | photo |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -7,9 +7,9 @@ import { CreatePlaylistQueryParamType, CreatePlaylistRequest, Smart } from "@luk
|
||||
|
||||
let value: CreatePlaylistRequest = {
|
||||
title: "<value>",
|
||||
type: CreatePlaylistQueryParamType.Video,
|
||||
smart: Smart.One,
|
||||
uri: "http://immediate-instructor.info",
|
||||
type: CreatePlaylistQueryParamType.Audio,
|
||||
smart: Smart.Zero,
|
||||
uri: "https://courageous-futon.net",
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -5,39 +5,7 @@
|
||||
```typescript
|
||||
import { CreatePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CreatePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 244425,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 7,
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "96",
|
||||
key: "/playlists/96/items",
|
||||
guid:
|
||||
"com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55",
|
||||
type: "playlist",
|
||||
title: "A Great Playlist",
|
||||
summary: "What a great playlist",
|
||||
smart: false,
|
||||
playlistType: "video",
|
||||
icon: "playlist://image.smart",
|
||||
viewCount: 1,
|
||||
lastViewedAt: 1705719589,
|
||||
leafCount: 1,
|
||||
addedAt: 1705719589,
|
||||
updatedAt: 1705724593,
|
||||
composite: "/playlists/96/composite/1705724593",
|
||||
duration: 141000,
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
let value: CreatePlaylistResponse = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
```typescript
|
||||
import { DefaultSubtitleAccessibility } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: DefaultSubtitleAccessibility = DefaultSubtitleAccessibility.One;
|
||||
let value: DefaultSubtitleAccessibility = DefaultSubtitleAccessibility.Enable;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
@@ -7,12 +7,12 @@ The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer
|
||||
```typescript
|
||||
import { DefaultSubtitleForced } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: DefaultSubtitleForced = DefaultSubtitleForced.Zero;
|
||||
let value: DefaultSubtitleForced = DefaultSubtitleForced.Enable;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
@@ -5,13 +5,7 @@
|
||||
```typescript
|
||||
import { DeleteLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: DeleteLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 99280,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
};
|
||||
let value: DeleteLibraryResponse = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: DeletePlaylistRequest = {
|
||||
playlistID: 6563.3,
|
||||
playlistID: 5840.32,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -5,13 +5,7 @@
|
||||
```typescript
|
||||
import { DeletePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: DeletePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 317202,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
};
|
||||
let value: DeletePlaylistResponse = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -6,12 +6,21 @@
|
||||
import { Director } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Director = {
|
||||
tag: "Peyton Reed",
|
||||
id: 126522,
|
||||
filter: "director=235876",
|
||||
tag: "Danny Boyle",
|
||||
tagKey: "5d776831151a60001f24d031",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Peyton Reed |
|
||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
|
||||
| `filter` | *string* | :heavy_check_mark: | The filter string used to query this director. | director=235876 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||
| `tagKey` | *string* | :heavy_check_mark: | A unique 24-character hexadecimal key associated with the director's tag, used for internal identification. | 5d776831151a60001f24d031 |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||
@@ -5,13 +5,7 @@
|
||||
```typescript
|
||||
import { EnablePaperTrailResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: EnablePaperTrailResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 635059,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
};
|
||||
let value: EnablePaperTrailResponse = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
17
docs/sdk/models/operations/extras.md
Normal file
17
docs/sdk/models/operations/extras.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Extras
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Extras } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Extras = {
|
||||
size: 1,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | The size of the extras. | 1 |
|
||||
@@ -5,13 +5,28 @@
|
||||
```typescript
|
||||
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
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `directory` | [operations.GetMediaProvidersDirectory](../../../sdk/models/operations/getmediaprovidersdirectory.md)[] | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | |
|
||||
| `type` | *string* | :heavy_check_mark: | 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";
|
||||
|
||||
let value: Field = {
|
||||
key: "label",
|
||||
title: "Label",
|
||||
type: "tag",
|
||||
subType: "bitrate",
|
||||
key: "show.title",
|
||||
title: "Show Title",
|
||||
type: "string",
|
||||
subType: "rating",
|
||||
};
|
||||
```
|
||||
|
||||
@@ -17,7 +17,7 @@ let value: Field = {
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | label |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Label |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | tag |
|
||||
| `subType` | *string* | :heavy_minus_sign: | N/A | bitrate |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | show.title |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Show Title |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | string |
|
||||
| `subType` | *string* | :heavy_minus_sign: | N/A | rating |
|
||||
@@ -6,7 +6,7 @@
|
||||
import { FieldType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: FieldType = {
|
||||
type: "resolution",
|
||||
type: "tag",
|
||||
operator: [
|
||||
{
|
||||
key: "=",
|
||||
@@ -20,5 +20,5 @@ let value: FieldType = {
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | resolution |
|
||||
| `operator` | [operations.Operator](../../../sdk/models/operations/operator.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | tag |
|
||||
| `operator` | [operations.Operator](../../../sdk/models/operations/operator.md)[] | :heavy_check_mark: | N/A | |
|
||||
@@ -7,13 +7,16 @@ Filter
|
||||
```typescript
|
||||
import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Filter = Filter.All;
|
||||
let value: Filter = Filter.Available;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `All` | all |
|
||||
| `Available` | available |
|
||||
| `Released` | released |
|
||||
| - | `Unrecognized<string>` |
|
||||
23
docs/sdk/models/operations/flattenseasons.md
Normal file
23
docs/sdk/models/operations/flattenseasons.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# 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
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Hide` | 0 |
|
||||
| `Show` | 1 |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -7,7 +7,7 @@ Force the refresh even if the library is already being refreshed.
|
||||
```typescript
|
||||
import { Force } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Force = Force.One;
|
||||
let value: Force = Force.Zero;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -10,13 +10,8 @@ let value: Friend = {
|
||||
friendlyName: "exampleUser",
|
||||
home: true,
|
||||
id: 0,
|
||||
restricted: false,
|
||||
sharedServers: [
|
||||
{},
|
||||
],
|
||||
sharedSources: [
|
||||
{},
|
||||
],
|
||||
sharedServers: [],
|
||||
sharedSources: [],
|
||||
status: Status.Accepted,
|
||||
thumb: "https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578",
|
||||
title: "username123",
|
||||
|
||||
@@ -1,17 +1,23 @@
|
||||
# Genre
|
||||
|
||||
The filter query string for similar items.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Genre } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Genre = {
|
||||
tag: "Comedy",
|
||||
id: 259,
|
||||
filter: "genre=19",
|
||||
tag: "Crime",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Comedy |
|
||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | The unique identifier for the genre.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||
| `filter` | *string* | :heavy_check_mark: | N/A | genre=19 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||
@@ -14,7 +14,7 @@ let value: GeoData = {
|
||||
city: "Amsterdam",
|
||||
europeanUnionMember: true,
|
||||
timeZone: "America/St_Thomas",
|
||||
postalCode: 802,
|
||||
postalCode: "802",
|
||||
inPrivacyRestrictedCountry: true,
|
||||
inPrivacyRestrictedRegion: true,
|
||||
subdivisions: "Saint Thomas",
|
||||
@@ -32,7 +32,7 @@ let value: GeoData = {
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
|
||||
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_minus_sign: | 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. | |
|
||||
35
docs/sdk/models/operations/getactorslibraryqueryparamtype.md
Normal file
35
docs/sdk/models/operations/getactorslibraryqueryparamtype.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# 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
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Artist` | 5 |
|
||||
| `Album` | 6 |
|
||||
| `Track` | 7 |
|
||||
| `PhotoAlbum` | 8 |
|
||||
| `Photo` | 9 |
|
||||
| - | `Unrecognized<number>` |
|
||||
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 |
|
||||
18
docs/sdk/models/operations/getactorslibraryresponse.md
Normal file
18
docs/sdk/models/operations/getactorslibraryresponse.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetActorsLibraryResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetActorsLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetActorsLibraryResponse = {};
|
||||
```
|
||||
|
||||
## 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 |
|
||||
@@ -3,60 +3,55 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllLibrariesDirectory } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetAllLibrariesDirectory, GetAllLibrariesType, Hidden } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllLibrariesDirectory = {
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1705615584",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1743824484",
|
||||
filters: true,
|
||||
refreshing: false,
|
||||
thumb: "/:/resources/movie.png",
|
||||
refreshing: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
key: "1",
|
||||
type: "movie",
|
||||
type: GetAllLibrariesType.Movie,
|
||||
title: "Movies",
|
||||
agent: "tv.plex.agents.movie",
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
uuid: "e69655a2-ef48-4aba-bb19-01e7d3cc34d6",
|
||||
updatedAt: 1556281940,
|
||||
createdAt: 1556281940,
|
||||
scannedAt: 1556281940,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 3192854,
|
||||
hidden: 0,
|
||||
location: [
|
||||
{
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
},
|
||||
],
|
||||
contentChangedAt: 9173960,
|
||||
hidden: Hidden.ExcludeHomeScreen,
|
||||
location: [],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `composite` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/composite/1705615584 |
|
||||
| `filters` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `refreshing` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `agent` | *string* | :heavy_minus_sign: | N/A | tv.plex.agents.movie |
|
||||
| `scanner` | *string* | :heavy_minus_sign: | N/A | Plex Movie |
|
||||
| `language` | *string* | :heavy_minus_sign: | N/A | en-US |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
||||
| `createdAt` | *number* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
||||
| `scannedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
||||
| `content` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `directory` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `contentChangedAt` | *number* | :heavy_minus_sign: | N/A | 3192854 |
|
||||
| `hidden` | *number* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `location` | [operations.Location](../../../sdk/models/operations/location.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `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 |
|
||||
| `composite` | *string* | :heavy_check_mark: | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
|
||||
| `filters` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `refreshing` | *boolean* | :heavy_check_mark: | Indicates whether the library is currently being refreshed or updated | true |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `key` | *string* | :heavy_check_mark: | The library key representing the unique identifier | 1 |
|
||||
| `type` | [operations.GetAllLibrariesType](../../../sdk/models/operations/getalllibrariestype.md) | :heavy_check_mark: | N/A | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | The title of the library | Movies |
|
||||
| `agent` | *string* | :heavy_check_mark: | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
|
||||
| `scanner` | *string* | :heavy_check_mark: | UNKNOWN | Plex Movie |
|
||||
| `language` | *string* | :heavy_check_mark: | The Plex library language that has been set | en-US |
|
||||
| `uuid` | *string* | :heavy_check_mark: | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-01e7d3cc34d6 |
|
||||
| `updatedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `createdAt` | *number* | :heavy_minus_sign: | N/A | 1556281940 |
|
||||
| `scannedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `content` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `directory` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `contentChangedAt` | *number* | :heavy_check_mark: | Timestamp (in seconds) representing the last time the content was modified.<br/>NOTE: Some Plex server have some absurd values for this field, like 8457612157633039800 so it should be int64<br/> | 9173960 |
|
||||
| `hidden` | [operations.Hidden](../../../sdk/models/operations/hidden.md) | :heavy_minus_sign: | The Plex library visibility setting | 1 |
|
||||
| `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: | The ID of the location. | 1 |
|
||||
| `path` | *string* | :heavy_check_mark: | The path to the media item. | /Movies |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user