Compare commits

..

35 Commits

Author SHA1 Message Date
speakeasybot
3c13bba9de ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.526.6 2025-03-31 19:35:21 +00:00
speakeasybot
650c5043ef ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.526.6 2025-03-31 16:33:24 +00:00
Luke Hagar
0234804578 correcting label override key value 2025-03-31 11:30:53 -05:00
Luke Hagar
60d913c8f9 adjusting codesample labels 2025-03-28 16:58:29 -05:00
speakeasybot
8d9f4bbaf1 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.513.4 2025-03-09 00:10:48 +00:00
speakeasybot
5d57cd7c34 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.513.2 2025-03-07 00:11:26 +00:00
speakeasybot
1a8e227874 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.487.1 2025-02-10 00:11:39 +00:00
speakeasybot
8360d057ab ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.487.0 2025-02-07 00:11:14 +00:00
speakeasybot
18b64727c3 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.484.1 2025-02-06 00:11:16 +00:00
speakeasybot
3152372037 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.484.1 2025-02-05 00:11:28 +00:00
speakeasybot
13cd8a7fe5 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.476.1 2025-01-27 00:11:19 +00:00
speakeasybot
cdcdc0ca8e ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.474.0 2025-01-24 00:11:07 +00:00
speakeasybot
b03cc6a609 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.459.2 2024-12-22 00:12:06 +00:00
speakeasybot
4e989e0de3 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.456.1 2024-12-20 16:02:41 +00:00
Luke Hagar
c10e011a68 adjusted workflow 2024-12-20 09:59:40 -06:00
speakeasybot
7e3dca8466 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6 2024-12-16 22:20:26 +00:00
speakeasybot
8a2d3e04ab ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6 2024-11-14 00:11:57 +00:00
speakeasybot
6c8a73ae84 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6 2024-11-11 20:30:45 +00:00
speakeasybot
c839d9f6c7 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.406.0 2024-10-03 12:29:09 +00:00
speakeasybot
77b0ef9507 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.406.0 2024-10-03 00:11:46 +00:00
speakeasybot
1cfbd17f28 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6 2024-10-02 02:30:07 +00:00
speakeasybot
2492807c65 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6 2024-10-01 15:37:08 +00:00
speakeasybot
ead0a8773c ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6 2024-10-01 00:12:18 +00:00
speakeasybot
e254f82e06 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.398.0 2024-09-17 00:10:26 +00:00
Luke Hagar
a4369c999a Update workflow.yaml 2024-09-16 13:14:07 -05:00
speakeasybot
c50b85f29a ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.397.2 2024-09-16 18:01:31 +00:00
Luke Hagar
496ebda695 Update workflow.yaml 2024-09-16 12:57:23 -05:00
speakeasybot
d436fc3452 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.396.9 2024-09-16 00:11:44 +00:00
speakeasybot
99cdf6effe ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.396.9 2024-09-15 00:12:31 +00:00
speakeasybot
fa2ba82f62 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.396.9 2024-09-14 00:10:58 +00:00
speakeasybot
fd8095a8df ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.396.6 2024-09-13 00:11:18 +00:00
speakeasybot
9911164ab0 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.396.2 2024-09-12 00:11:23 +00:00
speakeasybot
ffedf47cad ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.395.1 2024-09-11 00:11:04 +00:00
speakeasybot
39d3a40524 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.394.0 2024-09-10 00:11:07 +00:00
speakeasybot
8dc802ca50 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.392.1 2024-09-09 00:13:27 +00:00
1213 changed files with 101764 additions and 61881 deletions

View File

@@ -1,28 +0,0 @@
/* eslint-env node */
module.exports = {
root: true,
extends: [
"eslint:recommended",
"plugin:@typescript-eslint/recommended",
"plugin:import/recommended",
"plugin:import/typescript",
],
parser: "@typescript-eslint/parser",
plugins: ["@typescript-eslint"],
settings: {
"import/resolver": {
typescript: true,
node: true,
},
},
rules: {
// Handled by typescript compiler
"@typescript-eslint/no-unused-vars": "off",
"@typescript-eslint/ban-types": "off",
"@typescript-eslint/no-namespace": "off",
"@typescript-eslint/no-explicit-any": "off",
"import/no-named-as-default-member": "off",
"import/no-default-export": "error",
},
};

5
.gitignore vendored
View File

@@ -1,3 +1,8 @@
/mcp-server
/bin
/.eslintcache
/.speakeasy/reports
/react-query
/sdk/models/errors /sdk/models/errors
/sdk/types /sdk/types
/__tests__ /__tests__

View File

@@ -1,9 +1,14 @@
**/* **/*
!/FUNCTIONS.md
!/RUNTIMES.md
!/REACT_QUERY.md
!/**/*.ts !/**/*.ts
!/**/*.js !/**/*.js
!/**/*.mjs
!/**/*.json
!/**/*.map !/**/*.map
/.eslintrc.js /eslint.config.mjs
/cjs /cjs
/.tshy /.tshy
/.tshy-* /.tshy-*

File diff suppressed because one or more lines are too long

View File

@@ -7,12 +7,15 @@ generation:
useClassNamesForArrayFields: true useClassNamesForArrayFields: true
fixes: fixes:
nameResolutionDec2023: true nameResolutionDec2023: true
nameResolutionFeb2025: false
parameterOrderingFeb2024: true parameterOrderingFeb2024: true
requestResponseComponentNamesFeb2024: true requestResponseComponentNamesFeb2024: true
securityFeb2025: false
auth: auth:
oAuth2ClientCredentialsEnabled: true oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
typescript: typescript:
version: 0.21.0 version: 0.35.3
additionalDependencies: additionalDependencies:
dependencies: {} dependencies: {}
devDependencies: {} devDependencies: {}
@@ -20,8 +23,13 @@ typescript:
additionalPackageJSON: {} additionalPackageJSON: {}
author: LukeHagar author: LukeHagar
clientServerStatusCodesAsErrors: true clientServerStatusCodesAsErrors: true
defaultErrorName: SDKError
enableCustomCodeRegions: false
enableMCPServer: true
enableReactQuery: false
enumFormat: enum enumFormat: enum
flattenGlobalSecurity: true flattenGlobalSecurity: true
flatteningOrder: body-first
imports: imports:
option: openapi option: openapi
paths: paths:
@@ -31,6 +39,7 @@ typescript:
shared: sdk/models/shared shared: sdk/models/shared
webhooks: sdk/models/webhooks webhooks: sdk/models/webhooks
inputModelSuffix: input inputModelSuffix: input
jsonpath: legacy
maxMethodParams: 4 maxMethodParams: 4
methodArguments: require-security-and-request methodArguments: require-security-and-request
moduleFormat: commonjs moduleFormat: commonjs

View File

@@ -1,36 +1,48 @@
speakeasyVersion: 1.392.1 speakeasyVersion: 1.526.6
sources: sources:
my-source: my-source:
sourceNamespace: my-source sourceNamespace: my-source
sourceRevisionDigest: sha256:06d2bc8083f30b9af5d98573735dcbe4b08efb34abd1829f8ce5d8a4a54f2a7c sourceRevisionDigest: sha256:1b8840d540c66b58d1009ec2581fb18464158ec9aa00464eac05ba737f31207e
sourceBlobDigest: sha256:ce28f3e6f2abc18cde6fb9e41093952eac55be5ad46b47b6f44fcdee1ca77eb2 sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
tags: tags:
- latest - latest
- main - main
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:277010613dd132c4b785bacddcba720038318ae87b0ce5e1eea3887cf8f22df4
sourceBlobDigest: sha256:1737023e29cd9cf36c07ccd8c8c48c47e14f47ce22b4d6ba9ee241afbbd8f351
tags:
- latest
- speakeasy-sdk-regen-1743449645
- 0.0.3
targets: targets:
plexjs: plexjs:
source: my-source source: plexapi
sourceNamespace: my-source sourceNamespace: plexapi
sourceRevisionDigest: sha256:06d2bc8083f30b9af5d98573735dcbe4b08efb34abd1829f8ce5d8a4a54f2a7c sourceRevisionDigest: sha256:277010613dd132c4b785bacddcba720038318ae87b0ce5e1eea3887cf8f22df4
sourceBlobDigest: sha256:ce28f3e6f2abc18cde6fb9e41093952eac55be5ad46b47b6f44fcdee1ca77eb2 sourceBlobDigest: sha256:1737023e29cd9cf36c07ccd8c8c48c47e14f47ce22b4d6ba9ee241afbbd8f351
codeSamplesNamespace: code-samples-typescript-plexjs codeSamplesNamespace: code-samples-typescript-plexjs
codeSamplesRevisionDigest: sha256:0c01bede320a98337e05b7238a83fd5c86c385267b494116f034aac2236f4f31 codeSamplesRevisionDigest: sha256:f99618862675a8c5993740b2acb9b573110d9b506d2bc70e3180f0f7f393798f
outLocation: /github/workspace/repo
workflow: workflow:
workflowVersion: 1.0.0 workflowVersion: 1.0.0
speakeasyVersion: latest speakeasyVersion: latest
sources: sources:
my-source: plexapi:
inputs: inputs:
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main - location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/output/plex-media-server-spec-dereferenced.yaml
registry:
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
targets: targets:
plexjs: plexjs:
target: typescript target: typescript
source: my-source source: plexapi
publish: publish:
npm: npm:
token: $npm_token token: $npm_token
codeSamples: codeSamples:
output: codeSamples.yaml output: codeSamples.yaml
registry: registry:
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-typescript-plexjs location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
langOverride: TypeScript
labelOverride:
fixedValue: PlexJS

View File

@@ -1,17 +1,22 @@
workflowVersion: 1.0.0 workflowVersion: 1.0.0
speakeasyVersion: latest speakeasyVersion: latest
sources: sources:
my-source: plexapi:
inputs: inputs:
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main - location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/output/plex-media-server-spec-dereferenced.yaml
registry:
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
targets: targets:
plexjs: plexjs:
target: typescript target: typescript
source: my-source source: plexapi
publish: publish:
npm: npm:
token: $npm_token token: $npm_token
codeSamples: codeSamples:
output: codeSamples.yaml output: codeSamples.yaml
registry: registry:
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-typescript-plexjs location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
langOverride: TypeScript
labelOverride:
fixedValue: PlexJS

View File

@@ -27,7 +27,6 @@ import { SDKValidationError } from "@lukehagar/plexjs/sdk/models/errors/sdkvalid
// You can create one instance of it to use across an application. // You can create one instance of it to use across an application.
const plexAPI = new PlexAPICore({ const plexAPI = new PlexAPICore({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
}); });
async function run() { async function run() {
@@ -53,7 +52,7 @@ async function run() {
const { value: result } = res; const { value: result } = res;
// Handle the result // Handle the result
console.log(result) console.log(result);
} }
run(); run();

625
README.md
View File

@@ -11,23 +11,55 @@
## Summary ## Summary
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
# Plex Media Server OpenAPI Specification
An Open Source OpenAPI Specification for Plex Media Server
Automation and SDKs provided by [Speakeasy](https://speakeasyapi.dev/)
## Documentation
[API Documentation](https://plexapi.dev)
## SDKs
The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the [main specification Repository](https://github.com/LukeHagar/plex-api-spec).
| Language | Repository | Releases | Other |
| --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
| Python | [GitHub](https://github.com/LukeHagar/plexpy) | [PyPI](https://pypi.org/project/plex-api-client/) | - |
| JavaScript/TypeScript | [GitHub](https://github.com/LukeHagar/plexjs) | [NPM](https://www.npmjs.com/package/@lukehagar/plexjs) \ [JSR](https://jsr.io/@lukehagar/plexjs) | - |
| Go | [GitHub](https://github.com/LukeHagar/plexgo) | [Releases](https://github.com/LukeHagar/plexgo/releases) | [GoDoc](https://pkg.go.dev/github.com/LukeHagar/plexgo) |
| Ruby | [GitHub](https://github.com/LukeHagar/plexruby) | [Releases](https://github.com/LukeHagar/plexruby/releases) | - |
| Swift | [GitHub](https://github.com/LukeHagar/plexswift) | [Releases](https://github.com/LukeHagar/plexswift/releases) | - |
| PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - |
| Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - |
| C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -
<!-- End Summary [summary] --> <!-- End Summary [summary] -->
<!-- Start Table of Contents [toc] --> <!-- Start Table of Contents [toc] -->
## Table of Contents ## Table of Contents
<!-- $toc-max-depth=2 -->
* [@lukehagar/plexjs](#lukehagarplexjs)
* [Plex Media Server OpenAPI Specification](#plex-media-server-openapi-specification)
* [Documentation](#documentation)
* [SDKs](#sdks)
* [SDK Installation](#sdk-installation)
* [SDK Example Usage](#sdk-example-usage)
* [Available Resources and Operations](#available-resources-and-operations)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Custom HTTP Client](#custom-http-client)
* [Authentication](#authentication)
* [Requirements](#requirements)
* [Standalone functions](#standalone-functions)
* [Retries](#retries)
* [Debugging](#debugging)
* [Development](#development)
* [Maturity](#maturity)
* [Contributions](#contributions)
* [SDK Installation](#sdk-installation)
* [Requirements](#requirements)
* [SDK Example Usage](#sdk-example-usage)
* [Available Resources and Operations](#available-resources-and-operations)
* [Standalone functions](#standalone-functions)
* [Global Parameters](#global-parameters)
* [Retries](#retries)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Custom HTTP Client](#custom-http-client)
* [Authentication](#authentication)
* [Debugging](#debugging)
<!-- End Table of Contents [toc] --> <!-- End Table of Contents [toc] -->
<!-- Start SDK Installation [installation] --> <!-- Start SDK Installation [installation] -->
@@ -72,15 +104,14 @@ yarn add @lukehagar/plexjs zod
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
}); });
async function run() { async function run() {
const result = await plexAPI.server.getServerCapabilities(); const result = await plexAPI.server.getServerCapabilities();
// Handle the result // Handle the result
console.log(result); console.log(result);
} }
run(); run();
@@ -91,36 +122,21 @@ run();
<!-- Start Available Resources and Operations [operations] --> <!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations ## Available Resources and Operations
### [server](docs/sdks/server/README.md) <details open>
<summary>Available methods</summary>
* [getServerCapabilities](docs/sdks/server/README.md#getservercapabilities) - Get Server Capabilities
* [getServerPreferences](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
* [getAvailableClients](docs/sdks/server/README.md#getavailableclients) - Get Available Clients
* [getDevices](docs/sdks/server/README.md#getdevices) - Get Devices
* [getServerIdentity](docs/sdks/server/README.md#getserveridentity) - Get Server Identity
* [getMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount) - Get MyPlex Account
* [getResizedPhoto](docs/sdks/server/README.md#getresizedphoto) - Get a Resized Photo
* [getMediaProviders](docs/sdks/server/README.md#getmediaproviders) - Get Media Providers
* [getServerList](docs/sdks/server/README.md#getserverlist) - Get Server List
### [media](docs/sdks/media/README.md)
* [markPlayed](docs/sdks/media/README.md#markplayed) - Mark Media Played
* [markUnplayed](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
* [updatePlayProgress](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress
* [getBannerImage](docs/sdks/media/README.md#getbannerimage) - Get Banner Image
* [getThumbImage](docs/sdks/media/README.md#getthumbimage) - Get Thumb Image
### [video](docs/sdks/video/README.md)
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
* [startUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
### [activities](docs/sdks/activities/README.md) ### [activities](docs/sdks/activities/README.md)
* [getServerActivities](docs/sdks/activities/README.md#getserveractivities) - Get Server Activities * [getServerActivities](docs/sdks/activities/README.md#getserveractivities) - Get Server Activities
* [cancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities) - Cancel Server Activities * [cancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities) - Cancel Server Activities
### [authentication](docs/sdks/authentication/README.md)
* [getTransientToken](docs/sdks/authentication/README.md#gettransienttoken) - Get a Transient Token
* [getSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation) - Get Source Connection Information
* [getTokenDetails](docs/sdks/authentication/README.md#gettokendetails) - Get Token Details
* [postUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata) - Get User Sign In Data
### [butler](docs/sdks/butler/README.md) ### [butler](docs/sdks/butler/README.md)
* [getButlerTasks](docs/sdks/butler/README.md#getbutlertasks) - Get Butler tasks * [getButlerTasks](docs/sdks/butler/README.md#getbutlertasks) - Get Butler tasks
@@ -129,45 +145,30 @@ run();
* [startTask](docs/sdks/butler/README.md#starttask) - Start a single Butler task * [startTask](docs/sdks/butler/README.md#starttask) - Start a single Butler task
* [stopTask](docs/sdks/butler/README.md#stoptask) - Stop a single Butler task * [stopTask](docs/sdks/butler/README.md#stoptask) - Stop a single Butler task
### [plex](docs/sdks/plex/README.md)
* [getCompanionsData](docs/sdks/plex/README.md#getcompanionsdata) - Get Companions Data
* [getUserFriends](docs/sdks/plex/README.md#getuserfriends) - Get list of friends of the user logged in
* [getGeoData](docs/sdks/plex/README.md#getgeodata) - Get Geo Data
* [getHomeData](docs/sdks/plex/README.md#gethomedata) - Get Plex Home Data
* [getServerResources](docs/sdks/plex/README.md#getserverresources) - Get Server Resources
* [getPin](docs/sdks/plex/README.md#getpin) - Get a Pin
* [getTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid) - Get Access Token by PinId
### [hubs](docs/sdks/hubs/README.md) ### [hubs](docs/sdks/hubs/README.md)
* [getGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs * [getGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
* [getRecentlyAdded](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
* [getLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs * [getLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
### [search](docs/sdks/search/README.md)
* [performSearch](docs/sdks/search/README.md#performsearch) - Perform a search
* [performVoiceSearch](docs/sdks/search/README.md#performvoicesearch) - Perform a voice search
* [getSearchResults](docs/sdks/search/README.md#getsearchresults) - Get Search Results
### [library](docs/sdks/library/README.md) ### [library](docs/sdks/library/README.md)
* [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value * [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
* [getRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded) - Get Recently Added * [getRecentlyAddedLibrary](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
* [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries * [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details * [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section * [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items * [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
* [getAllMediaLibrary](docs/sdks/library/README.md#getallmedialibrary) - Get all media of library
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library * [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library * [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey * [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
* [getCountriesLibrary](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
* [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children * [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content * [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
### [watchlist](docs/sdks/watchlist/README.md)
* [getWatchList](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
### [log](docs/sdks/log/README.md) ### [log](docs/sdks/log/README.md)
@@ -175,6 +176,14 @@ run();
* [logMultiLine](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message * [logMultiLine](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
* [enablePaperTrail](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail * [enablePaperTrail](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
### [media](docs/sdks/media/README.md)
* [markPlayed](docs/sdks/media/README.md#markplayed) - Mark Media Played
* [markUnplayed](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
* [updatePlayProgress](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress
* [getBannerImage](docs/sdks/media/README.md#getbannerimage) - Get Banner Image
* [getThumbImage](docs/sdks/media/README.md#getthumbimage) - Get Thumb Image
### [playlists](docs/sdks/playlists/README.md) ### [playlists](docs/sdks/playlists/README.md)
* [createPlaylist](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist * [createPlaylist](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
@@ -187,18 +196,34 @@ run();
* [addPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a Playlist * [addPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a Playlist
* [uploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist) - Upload Playlist * [uploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist) - Upload Playlist
### [authentication](docs/sdks/authentication/README.md) ### [plex](docs/sdks/plex/README.md)
* [getTransientToken](docs/sdks/authentication/README.md#gettransienttoken) - Get a Transient Token. * [getCompanionsData](docs/sdks/plex/README.md#getcompanionsdata) - Get Companions Data
* [getSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation) - Get Source Connection Information * [getUserFriends](docs/sdks/plex/README.md#getuserfriends) - Get list of friends of the user logged in
* [getUserDetails](docs/sdks/authentication/README.md#getuserdetails) - Get User Data By Token * [getGeoData](docs/sdks/plex/README.md#getgeodata) - Get Geo Data
* [postUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata) - Get User Sign In Data * [getHomeData](docs/sdks/plex/README.md#gethomedata) - Get Plex Home Data
* [getServerResources](docs/sdks/plex/README.md#getserverresources) - Get Server Resources
* [getPin](docs/sdks/plex/README.md#getpin) - Get a Pin
* [getTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid) - Get Access Token by PinId
### [statistics](docs/sdks/statistics/README.md)
* [getStatistics](docs/sdks/statistics/README.md#getstatistics) - Get Media Statistics ### [search](docs/sdks/search/README.md)
* [getResourcesStatistics](docs/sdks/statistics/README.md#getresourcesstatistics) - Get Resources Statistics
* [getBandwidthStatistics](docs/sdks/statistics/README.md#getbandwidthstatistics) - Get Bandwidth Statistics * [performSearch](docs/sdks/search/README.md#performsearch) - Perform a search
* [performVoiceSearch](docs/sdks/search/README.md#performvoicesearch) - Perform a voice search
* [getSearchResults](docs/sdks/search/README.md#getsearchresults) - Get Search Results
### [server](docs/sdks/server/README.md)
* [getServerCapabilities](docs/sdks/server/README.md#getservercapabilities) - Get Server Capabilities
* [getServerPreferences](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
* [getAvailableClients](docs/sdks/server/README.md#getavailableclients) - Get Available Clients
* [getDevices](docs/sdks/server/README.md#getdevices) - Get Devices
* [getServerIdentity](docs/sdks/server/README.md#getserveridentity) - Get Server Identity
* [getMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount) - Get MyPlex Account
* [getResizedPhoto](docs/sdks/server/README.md#getresizedphoto) - Get a Resized Photo
* [getMediaProviders](docs/sdks/server/README.md#getmediaproviders) - Get Media Providers
* [getServerList](docs/sdks/server/README.md#getserverlist) - Get Server List
### [sessions](docs/sdks/sessions/README.md) ### [sessions](docs/sdks/sessions/README.md)
@@ -207,158 +232,186 @@ run();
* [getTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions) - Get Transcode Sessions * [getTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions) - Get Transcode Sessions
* [stopTranscodeSession](docs/sdks/sessions/README.md#stoptranscodesession) - Stop a Transcode Session * [stopTranscodeSession](docs/sdks/sessions/README.md#stoptranscodesession) - Stop a Transcode Session
### [statistics](docs/sdks/statistics/README.md)
* [getStatistics](docs/sdks/statistics/README.md#getstatistics) - Get Media Statistics
* [getResourcesStatistics](docs/sdks/statistics/README.md#getresourcesstatistics) - Get Resources Statistics
* [getBandwidthStatistics](docs/sdks/statistics/README.md#getbandwidthstatistics) - Get Bandwidth Statistics
### [updater](docs/sdks/updater/README.md) ### [updater](docs/sdks/updater/README.md)
* [getUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates * [getUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates * [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates * [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
### [users](docs/sdks/users/README.md)
* [getUsers](docs/sdks/users/README.md#getusers) - Get list of all connected users
### [video](docs/sdks/video/README.md)
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
* [startUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
### [watchlist](docs/sdks/watchlist/README.md)
* [getWatchList](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
</details>
<!-- End Available Resources and Operations [operations] --> <!-- End Available Resources and Operations [operations] -->
<!-- Start Error Handling [errors] --> <!-- Start Error Handling [errors] -->
## Error Handling ## Error Handling
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type. Some methods specify known errors which can be thrown. All the known errors are enumerated in the `sdk/models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `getServerCapabilities` method may throw the following errors:
| Error Object | Status Code | Content Type | | Error Type | Status Code | Content Type |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | | ---------------------------------------- | ----------- | ---------------- |
| errors.GetServerCapabilitiesResponseBody | 400 | application/json | | errors.GetServerCapabilitiesBadRequest | 400 | application/json |
| errors.GetServerCapabilitiesServerResponseBody | 401 | application/json | | errors.GetServerCapabilitiesUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* | | errors.SDKError | 4XX, 5XX | \*/\* |
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
If the method throws an error and it is not captured by the known errors, it will default to throwing a `SDKError`.
```typescript ```typescript
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { import {
GetServerCapabilitiesResponseBody, GetServerCapabilitiesBadRequest,
GetServerCapabilitiesServerResponseBody, GetServerCapabilitiesUnauthorized,
SDKValidationError, SDKValidationError,
} from "@lukehagar/plexjs/sdk/models/errors"; } from "@lukehagar/plexjs/sdk/models/errors";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
}); });
async function run() { async function run() {
let result; let result;
try { try {
result = await plexAPI.server.getServerCapabilities(); result = await plexAPI.server.getServerCapabilities();
// Handle the result // Handle the result
console.log(result); console.log(result);
} catch (err) { } catch (err) {
switch (true) { switch (true) {
case err instanceof SDKValidationError: { // The server response does not match the expected SDK schema
// Validation errors can be pretty-printed case (err instanceof SDKValidationError): {
console.error(err.pretty()); // Pretty-print will provide a human-readable multi-line error message
// Raw value may also be inspected console.error(err.pretty());
console.error(err.rawValue); // Raw value may also be inspected
return; console.error(err.rawValue);
} return;
case err instanceof GetServerCapabilitiesResponseBody: { }
// Handle err.data$: GetServerCapabilitiesResponseBodyData case (err instanceof GetServerCapabilitiesBadRequest): {
console.error(err); // Handle err.data$: GetServerCapabilitiesBadRequestData
return; console.error(err);
} return;
case err instanceof GetServerCapabilitiesServerResponseBody: { }
// Handle err.data$: GetServerCapabilitiesServerResponseBodyData case (err instanceof GetServerCapabilitiesUnauthorized): {
console.error(err); // Handle err.data$: GetServerCapabilitiesUnauthorizedData
return; console.error(err);
} return;
default: { }
throw err; default: {
} // Other errors such as network errors, see HTTPClientErrors for more details
} throw err;
}
} }
}
} }
run(); run();
``` ```
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `sdk/models/errors/httpclienterrors.ts` module:
| HTTP Client Error | Description |
| ---------------------------------------------------- | ---------------------------------------------------- |
| RequestAbortedError | HTTP request was aborted by the client |
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
| ConnectionError | HTTP client was unable to make a request to a server |
| InvalidRequestError | Any input used to create a request is invalid |
| UnexpectedClientError | Unrecognised or unexpected error |
<!-- End Error Handling [errors] --> <!-- End Error Handling [errors] -->
<!-- Start Server Selection [server] --> <!-- Start Server Selection [server] -->
## Server Selection ## Server Selection
### Select Server by Index ### Server Variables
You can override the default server globally by passing a server index to the `serverIdx` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers: The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following parameters are available when initializing the SDK client instance:
| # | Server | Variables | | Variable | Parameter | Supported Values | Default | Description |
| - | ------ | --------- | | ---------- | --------------------------------- | -------------------------- | --------------- | ---------------------------------------------- |
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `https`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) | | `protocol` | `protocol: models.ServerProtocol` | - `"http"`<br/>- `"https"` | `"https"` | The protocol to use for the server connection |
| `ip` | `ip: string` | string | `"10.10.10.47"` | The IP address or hostname of your Plex Server |
| `port` | `port: string` | string | `"32400"` | The port of your Plex Server |
#### Example
```typescript ```typescript
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
serverIdx: 0, protocol: "https",
accessToken: "<YOUR_API_KEY_HERE>", ip: "e0c3:bcc0:6bac:dccc:c4ec:34b1:ca98:4cb9",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40", port: "40311",
accessToken: "<YOUR_API_KEY_HERE>",
}); });
async function run() { async function run() {
const result = await plexAPI.server.getServerCapabilities(); const result = await plexAPI.server.getServerCapabilities();
// Handle the result // Handle the result
console.log(result); console.log(result);
} }
run(); run();
``` ```
#### Variables
Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
* `protocol: models.ServerProtocol`
* `ip: string`
* `port: string`
### Override Server URL Per-Client ### Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example: The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
```typescript ```typescript
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
serverURL: "{protocol}://{ip}:{port}", serverURL: "https://10.10.10.47:32400",
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
}); });
async function run() { async function run() {
const result = await plexAPI.server.getServerCapabilities(); const result = await plexAPI.server.getServerCapabilities();
// Handle the result // Handle the result
console.log(result); console.log(result);
} }
run(); run();
``` ```
### Override Server URL Per-Operation ### Override Server URL Per-Operation
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example: The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
```typescript ```typescript
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
}); });
async function run() { async function run() {
const result = await plexAPI.plex.getCompanionsData({ const result = await plexAPI.plex.getCompanionsData({
serverURL: "https://plex.tv/api/v2/", serverURL: "https://plex.tv/api/v2",
}); });
// Handle the result // Handle the result
console.log(result); console.log(result);
} }
run(); run();
@@ -422,24 +475,23 @@ const sdk = new PlexAPI({ httpClient });
This SDK supports the following security scheme globally: This SDK supports the following security scheme globally:
| Name | Type | Scheme | | Name | Type | Scheme |
| ------------- | ------------- | ------------- | | ------------- | ------ | ------- |
| `accessToken` | apiKey | API key | | `accessToken` | apiKey | API key |
To authenticate with the API the `accessToken` parameter must be set when initializing the SDK client instance. For example: To authenticate with the API the `accessToken` parameter must be set when initializing the SDK client instance. For example:
```typescript ```typescript
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
}); });
async function run() { async function run() {
const result = await plexAPI.server.getServerCapabilities(); const result = await plexAPI.server.getServerCapabilities();
// Handle the result // Handle the result
console.log(result); console.log(result);
} }
run(); run();
@@ -468,133 +520,90 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
<summary>Available standalone functions</summary> <summary>Available standalone functions</summary>
- [activitiesCancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities) - [`activitiesCancelServerActivities`](docs/sdks/activities/README.md#cancelserveractivities) - Cancel Server Activities
- [activitiesGetServerActivities](docs/sdks/activities/README.md#getserveractivities) - [`activitiesGetServerActivities`](docs/sdks/activities/README.md#getserveractivities) - Get Server Activities
- [authenticationGetSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation) - [`authenticationGetSourceConnectionInformation`](docs/sdks/authentication/README.md#getsourceconnectioninformation) - Get Source Connection Information
- [authenticationGetTransientToken](docs/sdks/authentication/README.md#gettransienttoken) - [`authenticationGetTokenDetails`](docs/sdks/authentication/README.md#gettokendetails) - Get Token Details
- [authenticationGetUserDetails](docs/sdks/authentication/README.md#getuserdetails) - [`authenticationGetTransientToken`](docs/sdks/authentication/README.md#gettransienttoken) - Get a Transient Token
- [authenticationPostUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata) - [`authenticationPostUsersSignInData`](docs/sdks/authentication/README.md#postuserssignindata) - Get User Sign In Data
- [butlerGetButlerTasks](docs/sdks/butler/README.md#getbutlertasks) - [`butlerGetButlerTasks`](docs/sdks/butler/README.md#getbutlertasks) - Get Butler tasks
- [butlerStartAllTasks](docs/sdks/butler/README.md#startalltasks) - [`butlerStartAllTasks`](docs/sdks/butler/README.md#startalltasks) - Start all Butler tasks
- [butlerStartTask](docs/sdks/butler/README.md#starttask) - [`butlerStartTask`](docs/sdks/butler/README.md#starttask) - Start a single Butler task
- [butlerStopAllTasks](docs/sdks/butler/README.md#stopalltasks) - [`butlerStopAllTasks`](docs/sdks/butler/README.md#stopalltasks) - Stop all Butler tasks
- [butlerStopTask](docs/sdks/butler/README.md#stoptask) - [`butlerStopTask`](docs/sdks/butler/README.md#stoptask) - Stop a single Butler task
- [hubsGetGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - [`hubsGetGlobalHubs`](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
- [hubsGetLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - [`hubsGetLibraryHubs`](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
- [libraryDeleteLibrary](docs/sdks/library/README.md#deletelibrary) - [`hubsGetRecentlyAdded`](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
- [libraryGetAllLibraries](docs/sdks/library/README.md#getalllibraries) - [`libraryDeleteLibrary`](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
- [libraryGetFileHash](docs/sdks/library/README.md#getfilehash) - [`libraryGetActorsLibrary`](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
- [libraryGetLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - [`libraryGetAllLibraries`](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
- [libraryGetLibraryItems](docs/sdks/library/README.md#getlibraryitems) - [`libraryGetAllMediaLibrary`](docs/sdks/library/README.md#getallmedialibrary) - Get all media of library
- [libraryGetMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - [`libraryGetCountriesLibrary`](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
- [libraryGetMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - [`libraryGetFileHash`](docs/sdks/library/README.md#getfilehash) - Get Hash Value
- [libraryGetOnDeck](docs/sdks/library/README.md#getondeck) - [`libraryGetGenresLibrary`](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
- [libraryGetRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded) - [`libraryGetLibraryDetails`](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
- [libraryGetRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
- [libraryGetSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - [`libraryGetMediaMetaData`](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
- [libraryGetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - [`libraryGetMetadataChildren`](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
- [logEnablePaperTrail](docs/sdks/log/README.md#enablepapertrail) - [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
- [logLogLine](docs/sdks/log/README.md#logline) - [`libraryGetRefreshLibraryMetadata`](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
- [logLogMultiLine](docs/sdks/log/README.md#logmultiline) - [`libraryGetSearchAllLibraries`](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
- [mediaGetBannerImage](docs/sdks/media/README.md#getbannerimage) - [`libraryGetSearchLibrary`](docs/sdks/library/README.md#getsearchlibrary) - Search Library
- [mediaGetThumbImage](docs/sdks/media/README.md#getthumbimage) - [`libraryGetTopWatchedContent`](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
- [mediaMarkPlayed](docs/sdks/media/README.md#markplayed) - [`logEnablePaperTrail`](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
- [mediaMarkUnplayed](docs/sdks/media/README.md#markunplayed) - [`logLogLine`](docs/sdks/log/README.md#logline) - Logging a single line message.
- [mediaUpdatePlayProgress](docs/sdks/media/README.md#updateplayprogress) - [`logLogMultiLine`](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
- [playlistsAddPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents) - [`mediaGetBannerImage`](docs/sdks/media/README.md#getbannerimage) - Get Banner Image
- [playlistsClearPlaylistContents](docs/sdks/playlists/README.md#clearplaylistcontents) - [`mediaGetThumbImage`](docs/sdks/media/README.md#getthumbimage) - Get Thumb Image
- [playlistsCreatePlaylist](docs/sdks/playlists/README.md#createplaylist) - [`mediaMarkPlayed`](docs/sdks/media/README.md#markplayed) - Mark Media Played
- [playlistsDeletePlaylist](docs/sdks/playlists/README.md#deleteplaylist) - [`mediaMarkUnplayed`](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
- [playlistsGetPlaylistContents](docs/sdks/playlists/README.md#getplaylistcontents) - [`mediaUpdatePlayProgress`](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress
- [playlistsGetPlaylist](docs/sdks/playlists/README.md#getplaylist) - [`playlistsAddPlaylistContents`](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a Playlist
- [playlistsGetPlaylists](docs/sdks/playlists/README.md#getplaylists) - [`playlistsClearPlaylistContents`](docs/sdks/playlists/README.md#clearplaylistcontents) - Delete Playlist Contents
- [playlistsUpdatePlaylist](docs/sdks/playlists/README.md#updateplaylist) - [`playlistsCreatePlaylist`](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
- [playlistsUploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist) - [`playlistsDeletePlaylist`](docs/sdks/playlists/README.md#deleteplaylist) - Deletes a Playlist
- [plexGetCompanionsData](docs/sdks/plex/README.md#getcompanionsdata) - [`playlistsGetPlaylist`](docs/sdks/playlists/README.md#getplaylist) - Retrieve Playlist
- [plexGetGeoData](docs/sdks/plex/README.md#getgeodata) - [`playlistsGetPlaylistContents`](docs/sdks/playlists/README.md#getplaylistcontents) - Retrieve Playlist Contents
- [plexGetHomeData](docs/sdks/plex/README.md#gethomedata) - [`playlistsGetPlaylists`](docs/sdks/playlists/README.md#getplaylists) - Get All Playlists
- [plexGetPin](docs/sdks/plex/README.md#getpin) - [`playlistsUpdatePlaylist`](docs/sdks/playlists/README.md#updateplaylist) - Update a Playlist
- [plexGetServerResources](docs/sdks/plex/README.md#getserverresources) - [`playlistsUploadPlaylist`](docs/sdks/playlists/README.md#uploadplaylist) - Upload Playlist
- [plexGetTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid) - [`plexGetCompanionsData`](docs/sdks/plex/README.md#getcompanionsdata) - Get Companions Data
- [plexGetUserFriends](docs/sdks/plex/README.md#getuserfriends) - [`plexGetGeoData`](docs/sdks/plex/README.md#getgeodata) - Get Geo Data
- [searchGetSearchResults](docs/sdks/search/README.md#getsearchresults) - [`plexGetHomeData`](docs/sdks/plex/README.md#gethomedata) - Get Plex Home Data
- [searchPerformSearch](docs/sdks/search/README.md#performsearch) - [`plexGetPin`](docs/sdks/plex/README.md#getpin) - Get a Pin
- [searchPerformVoiceSearch](docs/sdks/search/README.md#performvoicesearch) - [`plexGetServerResources`](docs/sdks/plex/README.md#getserverresources) - Get Server Resources
- [serverGetAvailableClients](docs/sdks/server/README.md#getavailableclients) - [`plexGetTokenByPinId`](docs/sdks/plex/README.md#gettokenbypinid) - Get Access Token by PinId
- [serverGetDevices](docs/sdks/server/README.md#getdevices) - [`plexGetUserFriends`](docs/sdks/plex/README.md#getuserfriends) - Get list of friends of the user logged in
- [serverGetMediaProviders](docs/sdks/server/README.md#getmediaproviders) - [`searchGetSearchResults`](docs/sdks/search/README.md#getsearchresults) - Get Search Results
- [serverGetMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount) - [`searchPerformSearch`](docs/sdks/search/README.md#performsearch) - Perform a search
- [serverGetResizedPhoto](docs/sdks/server/README.md#getresizedphoto) - [`searchPerformVoiceSearch`](docs/sdks/search/README.md#performvoicesearch) - Perform a voice search
- [serverGetServerCapabilities](docs/sdks/server/README.md#getservercapabilities) - [`serverGetAvailableClients`](docs/sdks/server/README.md#getavailableclients) - Get Available Clients
- [serverGetServerIdentity](docs/sdks/server/README.md#getserveridentity) - [`serverGetDevices`](docs/sdks/server/README.md#getdevices) - Get Devices
- [serverGetServerList](docs/sdks/server/README.md#getserverlist) - [`serverGetMediaProviders`](docs/sdks/server/README.md#getmediaproviders) - Get Media Providers
- [serverGetServerPreferences](docs/sdks/server/README.md#getserverpreferences) - [`serverGetMyPlexAccount`](docs/sdks/server/README.md#getmyplexaccount) - Get MyPlex Account
- [sessionsGetSessionHistory](docs/sdks/sessions/README.md#getsessionhistory) - [`serverGetResizedPhoto`](docs/sdks/server/README.md#getresizedphoto) - Get a Resized Photo
- [sessionsGetSessions](docs/sdks/sessions/README.md#getsessions) - [`serverGetServerCapabilities`](docs/sdks/server/README.md#getservercapabilities) - Get Server Capabilities
- [sessionsGetTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions) - [`serverGetServerIdentity`](docs/sdks/server/README.md#getserveridentity) - Get Server Identity
- [sessionsStopTranscodeSession](docs/sdks/sessions/README.md#stoptranscodesession) - [`serverGetServerList`](docs/sdks/server/README.md#getserverlist) - Get Server List
- [statisticsGetBandwidthStatistics](docs/sdks/statistics/README.md#getbandwidthstatistics) - [`serverGetServerPreferences`](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
- [statisticsGetResourcesStatistics](docs/sdks/statistics/README.md#getresourcesstatistics) - [`sessionsGetSessionHistory`](docs/sdks/sessions/README.md#getsessionhistory) - Get Session History
- [statisticsGetStatistics](docs/sdks/statistics/README.md#getstatistics) - [`sessionsGetSessions`](docs/sdks/sessions/README.md#getsessions) - Get Active Sessions
- [updaterApplyUpdates](docs/sdks/updater/README.md#applyupdates) - [`sessionsGetTranscodeSessions`](docs/sdks/sessions/README.md#gettranscodesessions) - Get Transcode Sessions
- [updaterCheckForUpdates](docs/sdks/updater/README.md#checkforupdates) - [`sessionsStopTranscodeSession`](docs/sdks/sessions/README.md#stoptranscodesession) - Stop a Transcode Session
- [updaterGetUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - [`statisticsGetBandwidthStatistics`](docs/sdks/statistics/README.md#getbandwidthstatistics) - Get Bandwidth Statistics
- [videoGetTimeline](docs/sdks/video/README.md#gettimeline) - [`statisticsGetResourcesStatistics`](docs/sdks/statistics/README.md#getresourcesstatistics) - Get Resources Statistics
- [videoStartUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode) - [`statisticsGetStatistics`](docs/sdks/statistics/README.md#getstatistics) - Get Media Statistics
- [watchlistGetWatchList](docs/sdks/watchlist/README.md#getwatchlist) - [`updaterApplyUpdates`](docs/sdks/updater/README.md#applyupdates) - Apply Updates
- [`updaterCheckForUpdates`](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
- [`updaterGetUpdateStatus`](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
- [`usersGetUsers`](docs/sdks/users/README.md#getusers) - Get list of all connected users
- [`videoGetTimeline`](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
- [`videoStartUniversalTranscode`](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
- [`watchlistGetWatchList`](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
</details> </details>
<!-- End Standalone functions [standalone-funcs] --> <!-- End Standalone functions [standalone-funcs] -->
<!-- Start Global Parameters [global-parameters] -->
## Global Parameters
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set `X-Plex-Client-Identifier` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getServerResources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
### Available Globals
The following global parameter is available.
| Name | Type | Required | Description |
| ---- | ---- |:--------:| ----------- |
| xPlexClientIdentifier | string | | The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
|
### Example
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { IncludeHttps, IncludeIPv6, IncludeRelay } from "@lukehagar/plexjs/sdk/models/operations";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
});
async function run() {
const result = await plexAPI.plex.getServerResources({
xPlexToken: "CV5xoxjTpFKUzBTShsaf",
includeHttps: IncludeHttps.One,
includeRelay: IncludeRelay.One,
includeIPv6: IncludeIPv6.One,
});
// Handle the result
console.log(result);
}
run();
```
<!-- End Global Parameters [global-parameters] -->
<!-- Start Retries [retries] --> <!-- Start Retries [retries] -->
## Retries ## Retries
@@ -605,26 +614,25 @@ To change the default retry strategy for a single API call, simply provide a ret
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
}); });
async function run() { async function run() {
const result = await plexAPI.server.getServerCapabilities({ const result = await plexAPI.server.getServerCapabilities({
retries: { retries: {
strategy: "backoff", strategy: "backoff",
backoff: { backoff: {
initialInterval: 1, initialInterval: 1,
maxInterval: 50, maxInterval: 50,
exponent: 1.1, exponent: 1.1,
maxElapsedTime: 100, maxElapsedTime: 100,
}, },
retryConnectionErrors: false, retryConnectionErrors: false,
}, },
}); });
// Handle the result // Handle the result
console.log(result); console.log(result);
} }
run(); run();
@@ -636,25 +644,24 @@ If you'd like to override the default retry strategy for all operations that sup
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
retryConfig: { retryConfig: {
strategy: "backoff", strategy: "backoff",
backoff: { backoff: {
initialInterval: 1, initialInterval: 1,
maxInterval: 50, maxInterval: 50,
exponent: 1.1, exponent: 1.1,
maxElapsedTime: 100, maxElapsedTime: 100,
},
retryConnectionErrors: false,
}, },
accessToken: "<YOUR_API_KEY_HERE>", retryConnectionErrors: false,
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40", },
accessToken: "<YOUR_API_KEY_HERE>",
}); });
async function run() { async function run() {
const result = await plexAPI.server.getServerCapabilities(); const result = await plexAPI.server.getServerCapabilities();
// Handle the result // Handle the result
console.log(result); console.log(result);
} }
run(); run();

View File

@@ -968,4 +968,304 @@ Based on:
### Generated ### Generated
- [typescript v0.21.0] . - [typescript v0.21.0] .
### Releases ### Releases
- [NPM v0.21.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.21.0 - . - [NPM v0.21.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.21.0 - .
## 2024-09-09 00:09:42
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.392.1 (2.411.9) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.21.1] .
### Releases
- [NPM v0.21.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.21.1 - .
## 2024-09-10 00:09:01
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.394.0 (2.413.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.22.0] .
### Releases
- [NPM v0.22.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.22.0 - .
## 2024-09-11 00:09:01
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.395.1 (2.415.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.22.1] .
### Releases
- [NPM v0.22.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.22.1 - .
## 2024-09-12 00:09:10
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.396.2 (2.415.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.22.2] .
### Releases
- [NPM v0.22.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.22.2 - .
## 2024-09-13 00:09:09
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.396.6 (2.415.6) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.23.0] .
### Releases
- [NPM v0.23.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.0 - .
## 2024-09-14 00:08:56
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.396.9 (2.415.7) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.23.1] .
### Releases
- [NPM v0.23.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.1 - .
## 2024-09-15 00:10:25
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.396.9 (2.415.7) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.23.2] .
### Releases
- [NPM v0.23.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.2 - .
## 2024-09-16 00:09:42
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.396.9 (2.415.7) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.23.3] .
### Releases
- [NPM v0.23.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.3 - .
## 2024-09-16 17:59:12
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.397.2 (2.415.8) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.23.4] .
### Releases
- [NPM v0.23.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.4 - .
## 2024-09-17 00:08:25
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.398.0 (2.415.8) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.23.5] .
### Releases
- [NPM v0.23.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.5 - .
## 2024-10-01 00:10:47
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.24.0] .
### Releases
- [NPM v0.24.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.0 - .
## 2024-10-01 15:35:33
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.24.1] .
### Releases
- [NPM v0.24.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.1 - .
## 2024-10-02 02:28:25
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.24.2] .
### Releases
- [NPM v0.24.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.2 - .
## 2024-10-03 00:09:30
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.25.1] .
### Releases
- [NPM v0.25.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.25.1 - .
## 2024-10-03 12:26:50
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.26.1] .
### Releases
- [NPM v0.26.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.26.1 - .
## 2024-11-11 20:28:21
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.28.0] .
### Releases
- [NPM v0.28.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.28.0 - .
## 2024-11-14 00:09:39
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.30.0] .
### Releases
- [NPM v0.30.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.30.0 - .
## 2024-12-16 22:17:52
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.31.1] .
### Releases
- [NPM v0.31.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.31.1 - .
## 2024-12-20 16:01:16
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.456.1 (2.481.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.32.0] .
### Releases
- [NPM v0.32.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.0 - .
## 2024-12-22 00:10:48
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.459.2 (2.483.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.32.1] .
### Releases
- [NPM v0.32.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.1 - .
## 2025-01-24 00:09:35
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.474.0 (2.495.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.32.2] .
### Releases
- [NPM v0.32.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.2 - .
## 2025-01-27 00:09:48
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.476.1 (2.495.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.32.3] .
### Releases
- [NPM v0.32.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.3 - .
## 2025-02-05 00:09:58
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.32.4] .
### Releases
- [NPM v0.32.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.4 - .
## 2025-02-06 00:09:46
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.32.5] .
### Releases
- [NPM v0.32.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.5 - .
## 2025-02-07 00:09:41
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.487.0 (2.506.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.33.0] .
### Releases
- [NPM v0.33.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.33.0 - .
## 2025-02-10 00:10:04
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.487.1 (2.506.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.34.0] .
### Releases
- [NPM v0.34.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.34.0 - .
## 2025-03-07 00:09:55
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.513.2 (2.545.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.35.0] .
### Releases
- [NPM v0.35.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.0 - .
## 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 - .

View File

@@ -1,6 +1,6 @@
# Supported JavaScript runtimes # Supported JavaScript runtimes
This SDK is intended to be used in JavaScript runtimes that support the following features: This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
* [Web Fetch API][web-fetch] * [Web Fetch API][web-fetch]
* [Web Streams API][web-streams] and in particular `ReadableStream` * [Web Streams API][web-streams] and in particular `ReadableStream`
@@ -20,3 +20,29 @@ Runtime environments that are explicitly supported are:
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming]) - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018 [deno-file-streaming]: https://github.com/denoland/deno/issues/11018
## Recommended TypeScript compiler options
The following `tsconfig.json` options are recommended for projects using this
SDK in order to get static type support for features like async iterables,
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
so on):
[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
```jsonc
{
"compilerOptions": {
"target": "es2020", // or higher
"lib": ["es2020", "dom", "dom.iterable"],
}
}
```
While `target` can be set to older ECMAScript versions, it may result in extra,
unnecessary compatibility code being generated if you are not targeting old
runtimes.

View File

@@ -3,15 +3,14 @@
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
}); });
async function run() { async function run() {
const result = await plexAPI.server.getServerCapabilities(); const result = await plexAPI.server.getServerCapabilities();
// Handle the result // Handle the result
console.log(result); console.log(result);
} }
run(); run();

File diff suppressed because it is too large Load Diff

View File

@@ -1,11 +1,11 @@
# AddPlaylistContentsResponseBody # AddPlaylistContentsBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { AddPlaylistContentsResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { AddPlaylistContentsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { AddPlaylistContentsErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { AddPlaylistContentsErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: AddPlaylistContentsErrors = { let value: AddPlaylistContentsErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -6,9 +6,9 @@
import { AddPlaylistContentsPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { AddPlaylistContentsPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: AddPlaylistContentsPlaylistsErrors = { let value: AddPlaylistContentsPlaylistsErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# AddPlaylistContentsPlaylistsResponseBody # AddPlaylistContentsUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage ## Example Usage
```typescript ```typescript
import { AddPlaylistContentsPlaylistsResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { AddPlaylistContentsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -1,11 +1,11 @@
# ApplyUpdatesResponseBody # ApplyUpdatesBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { ApplyUpdatesResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { ApplyUpdatesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { ApplyUpdatesErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { ApplyUpdatesErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: ApplyUpdatesErrors = { let value: ApplyUpdatesErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# ApplyUpdatesUpdaterResponseBody # ApplyUpdatesUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage ## Example Usage
```typescript ```typescript
import { ApplyUpdatesUpdaterResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { ApplyUpdatesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { ApplyUpdatesUpdaterErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { ApplyUpdatesUpdaterErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: ApplyUpdatesUpdaterErrors = { let value: ApplyUpdatesUpdaterErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,
}; };
``` ```

View File

@@ -6,9 +6,9 @@
import { CancelServerActivitiesActivitiesErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { CancelServerActivitiesActivitiesErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: CancelServerActivitiesActivitiesErrors = { let value: CancelServerActivitiesActivitiesErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# CancelServerActivitiesResponseBody # CancelServerActivitiesBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { CancelServerActivitiesResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { CancelServerActivitiesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { CancelServerActivitiesErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { CancelServerActivitiesErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: CancelServerActivitiesErrors = { let value: CancelServerActivitiesErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# CancelServerActivitiesActivitiesResponseBody # CancelServerActivitiesUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage ## Example Usage
```typescript ```typescript
import { CancelServerActivitiesActivitiesResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { CancelServerActivitiesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -1,11 +1,11 @@
# CheckForUpdatesResponseBody # CheckForUpdatesBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { CheckForUpdatesResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { CheckForUpdatesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { CheckForUpdatesErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { CheckForUpdatesErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: CheckForUpdatesErrors = { let value: CheckForUpdatesErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# CheckForUpdatesUpdaterResponseBody # CheckForUpdatesUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage ## Example Usage
```typescript ```typescript
import { CheckForUpdatesUpdaterResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { CheckForUpdatesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { CheckForUpdatesUpdaterErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { CheckForUpdatesUpdaterErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: CheckForUpdatesUpdaterErrors = { let value: CheckForUpdatesUpdaterErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# ClearPlaylistContentsResponseBody # ClearPlaylistContentsBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { ClearPlaylistContentsResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { ClearPlaylistContentsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { ClearPlaylistContentsErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { ClearPlaylistContentsErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: ClearPlaylistContentsErrors = { let value: ClearPlaylistContentsErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -6,9 +6,9 @@
import { ClearPlaylistContentsPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { ClearPlaylistContentsPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: ClearPlaylistContentsPlaylistsErrors = { let value: ClearPlaylistContentsPlaylistsErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# ClearPlaylistContentsPlaylistsResponseBody # ClearPlaylistContentsUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage ## Example Usage
```typescript ```typescript
import { ClearPlaylistContentsPlaylistsResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { ClearPlaylistContentsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -1,11 +1,11 @@
# CreatePlaylistResponseBody # CreatePlaylistBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { CreatePlaylistResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { CreatePlaylistBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { CreatePlaylistErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { CreatePlaylistErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: CreatePlaylistErrors = { let value: CreatePlaylistErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -6,9 +6,9 @@
import { CreatePlaylistPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { CreatePlaylistPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: CreatePlaylistPlaylistsErrors = { let value: CreatePlaylistPlaylistsErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# CreatePlaylistPlaylistsResponseBody # CreatePlaylistUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage ## Example Usage
```typescript ```typescript
import { CreatePlaylistPlaylistsResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { CreatePlaylistUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -1,11 +1,11 @@
# DeleteLibraryResponseBody # DeleteLibraryBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { DeleteLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { DeleteLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { DeleteLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { DeleteLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: DeleteLibraryErrors = { let value: DeleteLibraryErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -6,9 +6,9 @@
import { DeleteLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { DeleteLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: DeleteLibraryLibraryErrors = { let value: DeleteLibraryLibraryErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# DeleteLibraryLibraryResponseBody # DeleteLibraryUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage ## Example Usage
```typescript ```typescript
import { DeleteLibraryLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { DeleteLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -1,11 +1,11 @@
# DeletePlaylistResponseBody # DeletePlaylistBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { DeletePlaylistResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { DeletePlaylistBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { DeletePlaylistErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { DeletePlaylistErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: DeletePlaylistErrors = { let value: DeletePlaylistErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -6,9 +6,9 @@
import { DeletePlaylistPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { DeletePlaylistPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: DeletePlaylistPlaylistsErrors = { let value: DeletePlaylistPlaylistsErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# DeletePlaylistPlaylistsResponseBody # DeletePlaylistUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage ## Example Usage
```typescript ```typescript
import { DeletePlaylistPlaylistsResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { DeletePlaylistUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -1,11 +1,11 @@
# EnablePaperTrailResponseBody # EnablePaperTrailBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { EnablePaperTrailResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { EnablePaperTrailBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { EnablePaperTrailErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { EnablePaperTrailErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: EnablePaperTrailErrors = { let value: EnablePaperTrailErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -6,9 +6,9 @@
import { EnablePaperTrailLogErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { EnablePaperTrailLogErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: EnablePaperTrailLogErrors = { let value: EnablePaperTrailLogErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# EnablePaperTrailLogResponseBody # EnablePaperTrailUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage ## Example Usage
```typescript ```typescript
import { EnablePaperTrailLogResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { EnablePaperTrailUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { Errors } from "@lukehagar/plexjs/sdk/models/errors"; import { Errors } from "@lukehagar/plexjs/sdk/models/errors";
let value: Errors = { let value: Errors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# GetRecentlyAddedResponseBody # GetActorsLibraryBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { GetRecentlyAddedResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { GetActorsLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```
@@ -14,5 +14,5 @@ import { GetRecentlyAddedResponseBody } from "@lukehagar/plexjs/sdk/models/error
| Field | Type | Required | Description | | Field | Type | Required | Description |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `errors` | [errors.GetRecentlyAddedErrors](../../../sdk/models/errors/getrecentlyaddederrors.md)[] | :heavy_minus_sign: | N/A | | `errors` | [errors.GetActorsLibraryErrors](../../../sdk/models/errors/getactorslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -1,14 +1,14 @@
# GetRecentlyAddedErrors # GetActorsLibraryErrors
## Example Usage ## Example Usage
```typescript ```typescript
import { GetRecentlyAddedErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetActorsLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetRecentlyAddedErrors = { let value: GetActorsLibraryErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -0,0 +1,21 @@
# GetActorsLibraryLibraryErrors
## Example Usage
```typescript
import { GetActorsLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetActorsLibraryLibraryErrors = {
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 |

View 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 |

View File

@@ -1,11 +1,11 @@
# GetAllLibrariesResponseBody # GetAllLibrariesBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { GetAllLibrariesResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { GetAllLibrariesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { GetAllLibrariesErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetAllLibrariesErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetAllLibrariesErrors = { let value: GetAllLibrariesErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -6,9 +6,9 @@
import { GetAllLibrariesLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetAllLibrariesLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetAllLibrariesLibraryErrors = { let value: GetAllLibrariesLibraryErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# GetAllLibrariesLibraryResponseBody # GetAllLibrariesUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage ## Example Usage
```typescript ```typescript
import { GetAllLibrariesLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { GetAllLibrariesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -0,0 +1,18 @@
# GetAllMediaLibraryBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { GetAllMediaLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `errors` | [errors.GetAllMediaLibraryErrors](../../../sdk/models/errors/getallmedialibraryerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -1,14 +1,14 @@
# GetMetaDataByRatingKeyErrors # GetAllMediaLibraryErrors
## Example Usage ## Example Usage
```typescript ```typescript
import { GetMetaDataByRatingKeyErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetAllMediaLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetMetaDataByRatingKeyErrors = { let value: GetAllMediaLibraryErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -0,0 +1,21 @@
# GetAllMediaLibraryLibraryErrors
## Example Usage
```typescript
import { GetAllMediaLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetAllMediaLibraryLibraryErrors = {
code: 1001,
message: "User could not be authenticated",
status: 401,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,18 @@
# GetAllMediaLibraryUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetAllMediaLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `errors` | [errors.GetAllMediaLibraryLibraryErrors](../../../sdk/models/errors/getallmedialibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -1,11 +1,11 @@
# GetAvailableClientsResponseBody # GetAvailableClientsBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { GetAvailableClientsResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { GetAvailableClientsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { GetAvailableClientsErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetAvailableClientsErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetAvailableClientsErrors = { let value: GetAvailableClientsErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -6,9 +6,9 @@
import { GetAvailableClientsServerErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetAvailableClientsServerErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetAvailableClientsServerErrors = { let value: GetAvailableClientsServerErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# GetAvailableClientsServerResponseBody # GetAvailableClientsUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage ## Example Usage
```typescript ```typescript
import { GetAvailableClientsServerResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { GetAvailableClientsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -1,11 +1,11 @@
# GetBandwidthStatisticsResponseBody # GetBandwidthStatisticsBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { GetBandwidthStatisticsResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { GetBandwidthStatisticsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { GetBandwidthStatisticsErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetBandwidthStatisticsErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetBandwidthStatisticsErrors = { let value: GetBandwidthStatisticsErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -6,9 +6,9 @@
import { GetBandwidthStatisticsStatisticsErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetBandwidthStatisticsStatisticsErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetBandwidthStatisticsStatisticsErrors = { let value: GetBandwidthStatisticsStatisticsErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# GetBandwidthStatisticsStatisticsResponseBody # GetBandwidthStatisticsUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage ## Example Usage
```typescript ```typescript
import { GetBandwidthStatisticsStatisticsResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { GetBandwidthStatisticsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -1,11 +1,11 @@
# GetBannerImageResponseBody # GetBannerImageBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { GetBannerImageResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { GetBannerImageBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { GetBannerImageErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetBannerImageErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetBannerImageErrors = { let value: GetBannerImageErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -6,9 +6,9 @@
import { GetBannerImageMediaErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetBannerImageMediaErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetBannerImageMediaErrors = { let value: GetBannerImageMediaErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# GetBannerImageMediaResponseBody # GetBannerImageUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage ## Example Usage
```typescript ```typescript
import { GetBannerImageMediaResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { GetBannerImageUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -1,11 +1,11 @@
# GetButlerTasksResponseBody # GetButlerTasksBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { GetButlerTasksResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { GetButlerTasksBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { GetButlerTasksButlerErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetButlerTasksButlerErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetButlerTasksButlerErrors = { let value: GetButlerTasksButlerErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,
}; };
``` ```

View File

@@ -6,9 +6,9 @@
import { GetButlerTasksErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetButlerTasksErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetButlerTasksErrors = { let value: GetButlerTasksErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# GetButlerTasksButlerResponseBody # GetButlerTasksUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage ## Example Usage
```typescript ```typescript
import { GetButlerTasksButlerResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { GetButlerTasksUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -1,11 +1,11 @@
# GetCompanionsDataResponseBody # GetCompanionsDataBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { GetCompanionsDataResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { GetCompanionsDataBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { GetCompanionsDataErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetCompanionsDataErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetCompanionsDataErrors = { let value: GetCompanionsDataErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -6,9 +6,9 @@
import { GetCompanionsDataPlexErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetCompanionsDataPlexErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetCompanionsDataPlexErrors = { let value: GetCompanionsDataPlexErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# GetCompanionsDataPlexResponseBody # GetCompanionsDataUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage ## Example Usage
```typescript ```typescript
import { GetCompanionsDataPlexResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { GetCompanionsDataUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View 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 |

View File

@@ -0,0 +1,21 @@
# GetCountriesLibraryErrors
## Example Usage
```typescript
import { GetCountriesLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetCountriesLibraryErrors = {
code: 1000,
message: "X-Plex-Client-Identifier is missing",
status: 400,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |

View 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 |

View 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 |

View File

@@ -1,11 +1,11 @@
# GetDevicesResponseBody # GetDevicesBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { GetDevicesResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { GetDevicesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { GetDevicesErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetDevicesErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetDevicesErrors = { let value: GetDevicesErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -6,9 +6,9 @@
import { GetDevicesServerErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetDevicesServerErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetDevicesServerErrors = { let value: GetDevicesServerErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# GetDevicesServerResponseBody # GetDevicesUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage ## Example Usage
```typescript ```typescript
import { GetDevicesServerResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { GetDevicesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -1,11 +1,11 @@
# GetFileHashResponseBody # GetFileHashBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { GetFileHashResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { GetFileHashBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { GetFileHashErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetFileHashErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetFileHashErrors = { let value: GetFileHashErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View File

@@ -6,9 +6,9 @@
import { GetFileHashLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetFileHashLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetFileHashLibraryErrors = { let value: GetFileHashLibraryErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,
}; };
``` ```

View File

@@ -1,11 +1,11 @@
# GetFileHashLibraryResponseBody # GetFileHashUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage ## Example Usage
```typescript ```typescript
import { GetFileHashLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { GetFileHashUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -0,0 +1,18 @@
# GetGenresLibraryBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { GetGenresLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `errors` | [errors.GetGenresLibraryErrors](../../../sdk/models/errors/getgenreslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -1,14 +1,14 @@
# GetUserDetailsErrors # GetGenresLibraryErrors
## Example Usage ## Example Usage
```typescript ```typescript
import { GetUserDetailsErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetGenresLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetUserDetailsErrors = { let value: GetGenresLibraryErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

View 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 |

View 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 |

View File

@@ -1,11 +1,11 @@
# GetGeoDataResponseBody # GetGeoDataBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly. Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage ## Example Usage
```typescript ```typescript
import { GetGeoDataResponseBody } from "@lukehagar/plexjs/sdk/models/errors"; import { GetGeoDataBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model // No examples available for this model
``` ```

View File

@@ -6,9 +6,9 @@
import { GetGeoDataErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetGeoDataErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetGeoDataErrors = { let value: GetGeoDataErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,
}; };
``` ```

Some files were not shown because too many files have changed in this diff Show More