mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 20:47:46 +00:00
Compare commits
21 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
6c8a73ae84 | ||
|
|
c839d9f6c7 | ||
|
|
77b0ef9507 | ||
|
|
1cfbd17f28 | ||
|
|
2492807c65 | ||
|
|
ead0a8773c | ||
|
|
e254f82e06 | ||
|
|
a4369c999a | ||
|
|
c50b85f29a | ||
|
|
496ebda695 | ||
|
|
d436fc3452 | ||
|
|
99cdf6effe | ||
|
|
fa2ba82f62 | ||
|
|
fd8095a8df | ||
|
|
9911164ab0 | ||
|
|
ffedf47cad | ||
|
|
39d3a40524 | ||
|
|
8dc802ca50 | ||
|
|
5465f1e74c | ||
|
|
2d100b8e75 | ||
|
|
0533836427 |
5
.github/workflows/publish-jsr.yaml
vendored
5
.github/workflows/publish-jsr.yaml
vendored
@@ -7,9 +7,8 @@ permissions:
|
|||||||
|
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
push:
|
registry_package:
|
||||||
branches:
|
types: [published]
|
||||||
- main
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
publish:
|
publish:
|
||||||
|
|||||||
File diff suppressed because one or more lines are too long
@@ -12,7 +12,7 @@ generation:
|
|||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
typescript:
|
typescript:
|
||||||
version: 0.20.2
|
version: 0.28.0
|
||||||
additionalDependencies:
|
additionalDependencies:
|
||||||
dependencies: {}
|
dependencies: {}
|
||||||
devDependencies: {}
|
devDependencies: {}
|
||||||
@@ -20,8 +20,10 @@ typescript:
|
|||||||
additionalPackageJSON: {}
|
additionalPackageJSON: {}
|
||||||
author: LukeHagar
|
author: LukeHagar
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
|
defaultErrorName: SDKError
|
||||||
enumFormat: enum
|
enumFormat: enum
|
||||||
flattenGlobalSecurity: true
|
flattenGlobalSecurity: true
|
||||||
|
flatteningOrder: body-first
|
||||||
imports:
|
imports:
|
||||||
option: openapi
|
option: openapi
|
||||||
paths:
|
paths:
|
||||||
|
|||||||
@@ -1,36 +1,42 @@
|
|||||||
speakeasyVersion: 1.392.1
|
speakeasyVersion: 1.405.6
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
sourceRevisionDigest: sha256:facfe37caadd8c575513e97dbc389d0e4d7166c5310c891edb352e65da942367
|
sourceRevisionDigest: sha256:1b8840d540c66b58d1009ec2581fb18464158ec9aa00464eac05ba737f31207e
|
||||||
sourceBlobDigest: sha256:f816f80e55e2eeb2a0c30bfb6bfe919f0a1a7284e996cec3a680aa661d39e3c6
|
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
||||||
|
tags:
|
||||||
|
- latest
|
||||||
|
- main
|
||||||
|
plexapi:
|
||||||
|
sourceNamespace: plexapi
|
||||||
|
sourceRevisionDigest: sha256:15e040d800921ded49cf84650ef2bc8fb1acf32c885ee193c42e838d754bf345
|
||||||
|
sourceBlobDigest: sha256:c178be2b4bfefb37d76c0fdaef37c51f9b6ab1410422d3698a41bb6a8d79a79f
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- main
|
- main
|
||||||
targets:
|
targets:
|
||||||
plexjs:
|
plexjs:
|
||||||
source: my-source
|
source: plexapi
|
||||||
sourceNamespace: my-source
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:facfe37caadd8c575513e97dbc389d0e4d7166c5310c891edb352e65da942367
|
sourceRevisionDigest: sha256:15e040d800921ded49cf84650ef2bc8fb1acf32c885ee193c42e838d754bf345
|
||||||
sourceBlobDigest: sha256:f816f80e55e2eeb2a0c30bfb6bfe919f0a1a7284e996cec3a680aa661d39e3c6
|
sourceBlobDigest: sha256:c178be2b4bfefb37d76c0fdaef37c51f9b6ab1410422d3698a41bb6a8d79a79f
|
||||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||||
codeSamplesRevisionDigest: sha256:7b7fc9efdcfb2e57e099c7a3da0c064c908a9862cec1a419d9785af091277b8c
|
codeSamplesRevisionDigest: sha256:5c54699020b321aaa58525ef206ddf19e67e8cd6eb452f7a064169fdef2170a9
|
||||||
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: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main
|
||||||
targets:
|
targets:
|
||||||
plexjs:
|
plexjs:
|
||||||
target: typescript
|
target: typescript
|
||||||
source: my-source
|
source: plexapi
|
||||||
publish:
|
publish:
|
||||||
npm:
|
npm:
|
||||||
token: $npm_token
|
token: $npm_token
|
||||||
codeSamples:
|
codeSamples:
|
||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-typescript-plexjs
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||||
|
|||||||
@@ -1,17 +1,17 @@
|
|||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
plexapi:
|
||||||
inputs:
|
inputs:
|
||||||
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main
|
- location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main
|
||||||
targets:
|
targets:
|
||||||
plexjs:
|
plexjs:
|
||||||
target: typescript
|
target: typescript
|
||||||
source: my-source
|
source: plexapi
|
||||||
publish:
|
publish:
|
||||||
npm:
|
npm:
|
||||||
token: $npm_token
|
token: $npm_token
|
||||||
codeSamples:
|
codeSamples:
|
||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-typescript-plexjs
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||||
|
|||||||
@@ -27,7 +27,11 @@ import { SDKValidationError } from "@lukehagar/plexjs/sdk/models/errors/sdkvalid
|
|||||||
// You can create one instance of it to use across an application.
|
// You can create one instance of it to use across an application.
|
||||||
const plexAPI = new PlexAPICore({
|
const plexAPI = new PlexAPICore({
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
@@ -53,7 +57,7 @@ async function run() {
|
|||||||
const { value: result } = res;
|
const { value: result } = res;
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result);
|
||||||
}
|
}
|
||||||
|
|
||||||
run();
|
run();
|
||||||
|
|||||||
432
README.md
432
README.md
@@ -11,6 +11,31 @@
|
|||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
||||||
|
|
||||||
|
# Plex Media Server OpenAPI Specification
|
||||||
|
|
||||||
|
An Open Source OpenAPI Specification for Plex Media Server
|
||||||
|
|
||||||
|
Automation and SDKs provided by [Speakeasy](https://speakeasyapi.dev/)
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
[API Documentation](https://plexapi.dev)
|
||||||
|
|
||||||
|
## SDKs
|
||||||
|
|
||||||
|
The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the [main specification Repository](https://github.com/LukeHagar/plex-api-spec).
|
||||||
|
|
||||||
|
| Language | Repository | Releases | Other |
|
||||||
|
| --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
|
||||||
|
| Python | [GitHub](https://github.com/LukeHagar/plexpy) | [PyPI](https://pypi.org/project/plex-api-client/) | - |
|
||||||
|
| JavaScript/TypeScript | [GitHub](https://github.com/LukeHagar/plexjs) | [NPM](https://www.npmjs.com/package/@lukehagar/plexjs) \ [JSR](https://jsr.io/@lukehagar/plexjs) | - |
|
||||||
|
| Go | [GitHub](https://github.com/LukeHagar/plexgo) | [Releases](https://github.com/LukeHagar/plexgo/releases) | [GoDoc](https://pkg.go.dev/github.com/LukeHagar/plexgo) |
|
||||||
|
| Ruby | [GitHub](https://github.com/LukeHagar/plexruby) | [Releases](https://github.com/LukeHagar/plexruby/releases) | - |
|
||||||
|
| Swift | [GitHub](https://github.com/LukeHagar/plexswift) | [Releases](https://github.com/LukeHagar/plexswift/releases) | - |
|
||||||
|
| PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - |
|
||||||
|
| Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - |
|
||||||
|
| C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -
|
||||||
<!-- End Summary [summary] -->
|
<!-- End Summary [summary] -->
|
||||||
|
|
||||||
<!-- Start Table of Contents [toc] -->
|
<!-- Start Table of Contents [toc] -->
|
||||||
@@ -21,7 +46,6 @@ Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
|||||||
* [SDK Example Usage](#sdk-example-usage)
|
* [SDK Example Usage](#sdk-example-usage)
|
||||||
* [Available Resources and Operations](#available-resources-and-operations)
|
* [Available Resources and Operations](#available-resources-and-operations)
|
||||||
* [Standalone functions](#standalone-functions)
|
* [Standalone functions](#standalone-functions)
|
||||||
* [Global Parameters](#global-parameters)
|
|
||||||
* [Retries](#retries)
|
* [Retries](#retries)
|
||||||
* [Error Handling](#error-handling)
|
* [Error Handling](#error-handling)
|
||||||
* [Server Selection](#server-selection)
|
* [Server Selection](#server-selection)
|
||||||
@@ -72,15 +96,19 @@ 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",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.server.getServerCapabilities();
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
}
|
}
|
||||||
|
|
||||||
run();
|
run();
|
||||||
@@ -91,36 +119,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,52 +142,42 @@ 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
|
||||||
* [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
|
||||||
|
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||||
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
||||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||||
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||||
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||||
|
|
||||||
### [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)
|
||||||
|
|
||||||
* [logLine](docs/sdks/log/README.md#logline) - Logging a single line message.
|
* [logLine](docs/sdks/log/README.md#logline) - Logging a single line message.
|
||||||
* [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 +190,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 SignIn 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,69 +226,108 @@ 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
|
||||||
|
|
||||||
|
### [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.
|
All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`.
|
||||||
|
|
||||||
| Error Object | Status Code | Content Type |
|
If a HTTP request fails, an operation my also throw an error from the `sdk/models/errors/httpclienterrors.ts` module:
|
||||||
|
|
||||||
|
| HTTP Client Error | Description |
|
||||||
|
| ---------------------------------------------------- | ---------------------------------------------------- |
|
||||||
|
| RequestAbortedError | HTTP request was aborted by the client |
|
||||||
|
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
|
||||||
|
| ConnectionError | HTTP client was unable to make a request to a server |
|
||||||
|
| InvalidRequestError | Any input used to create a request is invalid |
|
||||||
|
| UnexpectedClientError | Unrecognised or unexpected error |
|
||||||
|
|
||||||
|
In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `getServerCapabilities` method may throw the following errors:
|
||||||
|
|
||||||
|
| Error Type | Status Code | Content Type |
|
||||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||||
| errors.GetServerCapabilitiesResponseBody | 401 | application/json |
|
| errors.GetServerCapabilitiesBadRequest | 400 | application/json |
|
||||||
| errors.SDKError | 4xx-5xx | */* |
|
| errors.GetServerCapabilitiesUnauthorized | 401 | application/json |
|
||||||
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
||||||
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
|
|
||||||
|
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import {
|
import {
|
||||||
GetServerCapabilitiesResponseBody,
|
GetServerCapabilitiesBadRequest,
|
||||||
SDKValidationError,
|
GetServerCapabilitiesUnauthorized,
|
||||||
|
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",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
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: {
|
case (err instanceof SDKValidationError): {
|
||||||
// Validation errors can be pretty-printed
|
// Validation errors can be pretty-printed
|
||||||
console.error(err.pretty());
|
console.error(err.pretty());
|
||||||
// Raw value may also be inspected
|
// Raw value may also be inspected
|
||||||
console.error(err.rawValue);
|
console.error(err.rawValue);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
case err instanceof GetServerCapabilitiesResponseBody: {
|
case (err instanceof GetServerCapabilitiesBadRequest): {
|
||||||
// Handle err.data$: GetServerCapabilitiesResponseBodyData
|
// Handle err.data$: GetServerCapabilitiesBadRequestData
|
||||||
console.error(err);
|
console.error(err);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
default: {
|
case (err instanceof GetServerCapabilitiesUnauthorized): {
|
||||||
throw err;
|
// Handle err.data$: GetServerCapabilitiesUnauthorizedData
|
||||||
}
|
console.error(err);
|
||||||
}
|
return;
|
||||||
|
}
|
||||||
|
default: {
|
||||||
|
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 string since validation errors can list many issues and the plain error string may be difficult read when debugging.
|
||||||
<!-- End Error Handling [errors] -->
|
<!-- End Error Handling [errors] -->
|
||||||
|
|
||||||
<!-- Start Server Selection [server] -->
|
<!-- Start Server Selection [server] -->
|
||||||
@@ -287,16 +345,20 @@ You can override the default server globally by passing a server index to the `s
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
serverIdx: 0,
|
serverIdx: 0,
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
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();
|
||||||
@@ -318,16 +380,20 @@ The default server can also be overridden globally by passing a URL to the `serv
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
const plexAPI = new PlexAPI({
|
||||||
serverURL: "{protocol}://{ip}:{port}",
|
serverURL: "{protocol}://{ip}:{port}",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
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();
|
||||||
@@ -341,17 +407,21 @@ The server URL can also be overridden on a per-operation basis, provided a serve
|
|||||||
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",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.plex.getCompanionsData({
|
const result = await plexAPI.plex.getCompanionsData({
|
||||||
serverURL: "https://plex.tv/api/v2/",
|
serverURL: "https://plex.tv/api/v2",
|
||||||
});
|
});
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
}
|
}
|
||||||
|
|
||||||
run();
|
run();
|
||||||
@@ -424,15 +494,19 @@ To authenticate with the API the `accessToken` parameter must be set when initia
|
|||||||
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",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.server.getServerCapabilities();
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
}
|
}
|
||||||
|
|
||||||
run();
|
run();
|
||||||
@@ -464,8 +538,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|||||||
- [activitiesCancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities)
|
- [activitiesCancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities)
|
||||||
- [activitiesGetServerActivities](docs/sdks/activities/README.md#getserveractivities)
|
- [activitiesGetServerActivities](docs/sdks/activities/README.md#getserveractivities)
|
||||||
- [authenticationGetSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation)
|
- [authenticationGetSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation)
|
||||||
|
- [authenticationGetTokenDetails](docs/sdks/authentication/README.md#gettokendetails)
|
||||||
- [authenticationGetTransientToken](docs/sdks/authentication/README.md#gettransienttoken)
|
- [authenticationGetTransientToken](docs/sdks/authentication/README.md#gettransienttoken)
|
||||||
- [authenticationGetUserDetails](docs/sdks/authentication/README.md#getuserdetails)
|
|
||||||
- [authenticationPostUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata)
|
- [authenticationPostUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata)
|
||||||
- [butlerGetButlerTasks](docs/sdks/butler/README.md#getbutlertasks)
|
- [butlerGetButlerTasks](docs/sdks/butler/README.md#getbutlertasks)
|
||||||
- [butlerStartAllTasks](docs/sdks/butler/README.md#startalltasks)
|
- [butlerStartAllTasks](docs/sdks/butler/README.md#startalltasks)
|
||||||
@@ -474,6 +548,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|||||||
- [butlerStopTask](docs/sdks/butler/README.md#stoptask)
|
- [butlerStopTask](docs/sdks/butler/README.md#stoptask)
|
||||||
- [hubsGetGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs)
|
- [hubsGetGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs)
|
||||||
- [hubsGetLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs)
|
- [hubsGetLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs)
|
||||||
|
- [hubsGetRecentlyAdded](docs/sdks/hubs/README.md#getrecentlyadded)
|
||||||
- [libraryDeleteLibrary](docs/sdks/library/README.md#deletelibrary)
|
- [libraryDeleteLibrary](docs/sdks/library/README.md#deletelibrary)
|
||||||
- [libraryGetAllLibraries](docs/sdks/library/README.md#getalllibraries)
|
- [libraryGetAllLibraries](docs/sdks/library/README.md#getalllibraries)
|
||||||
- [libraryGetFileHash](docs/sdks/library/README.md#getfilehash)
|
- [libraryGetFileHash](docs/sdks/library/README.md#getfilehash)
|
||||||
@@ -482,8 +557,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|||||||
- [libraryGetMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey)
|
- [libraryGetMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey)
|
||||||
- [libraryGetMetadataChildren](docs/sdks/library/README.md#getmetadatachildren)
|
- [libraryGetMetadataChildren](docs/sdks/library/README.md#getmetadatachildren)
|
||||||
- [libraryGetOnDeck](docs/sdks/library/README.md#getondeck)
|
- [libraryGetOnDeck](docs/sdks/library/README.md#getondeck)
|
||||||
- [libraryGetRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded)
|
- [libraryGetRecentlyAddedLibrary](docs/sdks/library/README.md#getrecentlyaddedlibrary)
|
||||||
- [libraryGetRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata)
|
- [libraryGetRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata)
|
||||||
|
- [libraryGetSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries)
|
||||||
- [libraryGetSearchLibrary](docs/sdks/library/README.md#getsearchlibrary)
|
- [libraryGetSearchLibrary](docs/sdks/library/README.md#getsearchlibrary)
|
||||||
- [libraryGetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent)
|
- [libraryGetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent)
|
||||||
- [logEnablePaperTrail](docs/sdks/log/README.md#enablepapertrail)
|
- [logEnablePaperTrail](docs/sdks/log/README.md#enablepapertrail)
|
||||||
@@ -540,54 +616,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|||||||
</details>
|
</details>
|
||||||
<!-- End Standalone functions [standalone-funcs] -->
|
<!-- End Standalone functions [standalone-funcs] -->
|
||||||
|
|
||||||
<!-- Start Global Parameters [global-parameters] -->
|
|
||||||
## Global Parameters
|
|
||||||
|
|
||||||
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
|
|
||||||
|
|
||||||
For example, you can set `X-Plex-Client-Identifier` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getServerResources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
|
||||||
|
|
||||||
|
|
||||||
### Available Globals
|
|
||||||
|
|
||||||
The following global parameter is available.
|
|
||||||
|
|
||||||
| Name | Type | Required | Description |
|
|
||||||
| ---- | ---- |:--------:| ----------- |
|
|
||||||
| xPlexClientIdentifier | string | | The unique identifier for the client application
|
|
||||||
This is used to track the client application and its usage
|
|
||||||
(UUID, serial number, or other number unique per device)
|
|
||||||
|
|
|
||||||
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
|
||||||
import { IncludeHttps, IncludeIPv6, IncludeRelay } from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
const plexAPI = new PlexAPI({
|
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
|
||||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
|
||||||
});
|
|
||||||
|
|
||||||
async function run() {
|
|
||||||
const result = await plexAPI.plex.getServerResources({
|
|
||||||
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
|
||||||
|
|
||||||
@@ -598,26 +626,30 @@ 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",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.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();
|
||||||
@@ -629,25 +661,29 @@ 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>",
|
||||||
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.server.getServerCapabilities();
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
}
|
}
|
||||||
|
|
||||||
run();
|
run();
|
||||||
|
|||||||
170
RELEASES.md
170
RELEASES.md
@@ -959,3 +959,173 @@ Based on:
|
|||||||
- [typescript v0.20.2] .
|
- [typescript v0.20.2] .
|
||||||
### Releases
|
### Releases
|
||||||
- [NPM v0.20.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.20.2 - .
|
- [NPM v0.20.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.20.2 - .
|
||||||
|
|
||||||
|
## 2024-09-08 17:37:50
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.392.1 (2.411.9) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.21.0] .
|
||||||
|
### Releases
|
||||||
|
- [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 - .
|
||||||
14
USAGE.md
14
USAGE.md
@@ -3,15 +3,19 @@
|
|||||||
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",
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||||
|
clientName: "Plex for Roku",
|
||||||
|
clientVersion: "2.4.1",
|
||||||
|
platform: "Roku",
|
||||||
|
deviceNickname: "Roku 3",
|
||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.server.getServerCapabilities();
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
}
|
}
|
||||||
|
|
||||||
run();
|
run();
|
||||||
|
|||||||
1741
codeSamples.yaml
1741
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
@@ -1,11 +1,11 @@
|
|||||||
# AddPlaylistContentsResponseBody
|
# AddPlaylistContentsBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { 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
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { AddPlaylistContentsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { AddPlaylistContentsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: AddPlaylistContentsErrors = {
|
let value: AddPlaylistContentsErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/addplaylistcontentsplaylistserrors.md
Normal file
21
docs/sdk/models/errors/addplaylistcontentsplaylistserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# AddPlaylistContentsPlaylistsErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AddPlaylistContentsPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: AddPlaylistContentsPlaylistsErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/addplaylistcontentsunauthorized.md
Normal file
18
docs/sdk/models/errors/addplaylistcontentsunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# AddPlaylistContentsUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AddPlaylistContentsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.AddPlaylistContentsPlaylistsErrors](../../../sdk/models/errors/addplaylistcontentsplaylistserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# ApplyUpdatesResponseBody
|
# ApplyUpdatesBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { 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
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { ApplyUpdatesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { ApplyUpdatesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: ApplyUpdatesErrors = {
|
let value: ApplyUpdatesErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
18
docs/sdk/models/errors/applyupdatesunauthorized.md
Normal file
18
docs/sdk/models/errors/applyupdatesunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# ApplyUpdatesUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ApplyUpdatesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.ApplyUpdatesUpdaterErrors](../../../sdk/models/errors/applyupdatesupdatererrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
21
docs/sdk/models/errors/applyupdatesupdatererrors.md
Normal file
21
docs/sdk/models/errors/applyupdatesupdatererrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# ApplyUpdatesUpdaterErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ApplyUpdatesUpdaterErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: ApplyUpdatesUpdaterErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
# CancelServerActivitiesActivitiesErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CancelServerActivitiesActivitiesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: CancelServerActivitiesActivitiesErrors = {
|
||||||
|
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 |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# CancelServerActivitiesResponseBody
|
# CancelServerActivitiesBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { 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
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { CancelServerActivitiesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { CancelServerActivitiesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: CancelServerActivitiesErrors = {
|
let value: CancelServerActivitiesErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
18
docs/sdk/models/errors/cancelserveractivitiesunauthorized.md
Normal file
18
docs/sdk/models/errors/cancelserveractivitiesunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# CancelServerActivitiesUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CancelServerActivitiesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.CancelServerActivitiesActivitiesErrors](../../../sdk/models/errors/cancelserveractivitiesactivitieserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# CheckForUpdatesResponseBody
|
# CheckForUpdatesBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { 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
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { CheckForUpdatesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { CheckForUpdatesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: CheckForUpdatesErrors = {
|
let value: CheckForUpdatesErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
18
docs/sdk/models/errors/checkforupdatesunauthorized.md
Normal file
18
docs/sdk/models/errors/checkforupdatesunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# CheckForUpdatesUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CheckForUpdatesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.CheckForUpdatesUpdaterErrors](../../../sdk/models/errors/checkforupdatesupdatererrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
21
docs/sdk/models/errors/checkforupdatesupdatererrors.md
Normal file
21
docs/sdk/models/errors/checkforupdatesupdatererrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# CheckForUpdatesUpdaterErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CheckForUpdatesUpdaterErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: CheckForUpdatesUpdaterErrors = {
|
||||||
|
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 |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# ClearPlaylistContentsResponseBody
|
# ClearPlaylistContentsBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { 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
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { ClearPlaylistContentsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { ClearPlaylistContentsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: ClearPlaylistContentsErrors = {
|
let value: ClearPlaylistContentsErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
# ClearPlaylistContentsPlaylistsErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ClearPlaylistContentsPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: ClearPlaylistContentsPlaylistsErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/clearplaylistcontentsunauthorized.md
Normal file
18
docs/sdk/models/errors/clearplaylistcontentsunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# ClearPlaylistContentsUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ClearPlaylistContentsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.ClearPlaylistContentsPlaylistsErrors](../../../sdk/models/errors/clearplaylistcontentsplaylistserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# CreatePlaylistResponseBody
|
# CreatePlaylistBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { 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
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { CreatePlaylistErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { CreatePlaylistErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: CreatePlaylistErrors = {
|
let value: CreatePlaylistErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/createplaylistplaylistserrors.md
Normal file
21
docs/sdk/models/errors/createplaylistplaylistserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# CreatePlaylistPlaylistsErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CreatePlaylistPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: CreatePlaylistPlaylistsErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/createplaylistunauthorized.md
Normal file
18
docs/sdk/models/errors/createplaylistunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# CreatePlaylistUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CreatePlaylistUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.CreatePlaylistPlaylistsErrors](../../../sdk/models/errors/createplaylistplaylistserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# DeleteLibraryResponseBody
|
# DeleteLibraryBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { 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
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { DeleteLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { DeleteLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: DeleteLibraryErrors = {
|
let value: DeleteLibraryErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/deletelibrarylibraryerrors.md
Normal file
21
docs/sdk/models/errors/deletelibrarylibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# DeleteLibraryLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeleteLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: DeleteLibraryLibraryErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/deletelibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/deletelibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# DeleteLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeleteLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.DeleteLibraryLibraryErrors](../../../sdk/models/errors/deletelibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# DeletePlaylistResponseBody
|
# DeletePlaylistBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { 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
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { DeletePlaylistErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { DeletePlaylistErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: DeletePlaylistErrors = {
|
let value: DeletePlaylistErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/deleteplaylistplaylistserrors.md
Normal file
21
docs/sdk/models/errors/deleteplaylistplaylistserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# DeletePlaylistPlaylistsErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeletePlaylistPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: DeletePlaylistPlaylistsErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/deleteplaylistunauthorized.md
Normal file
18
docs/sdk/models/errors/deleteplaylistunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# DeletePlaylistUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeletePlaylistUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.DeletePlaylistPlaylistsErrors](../../../sdk/models/errors/deleteplaylistplaylistserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# EnablePaperTrailResponseBody
|
# EnablePaperTrailBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { 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
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { EnablePaperTrailErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { EnablePaperTrailErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: EnablePaperTrailErrors = {
|
let value: EnablePaperTrailErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/enablepapertraillogerrors.md
Normal file
21
docs/sdk/models/errors/enablepapertraillogerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# EnablePaperTrailLogErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { EnablePaperTrailLogErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: EnablePaperTrailLogErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/enablepapertrailunauthorized.md
Normal file
18
docs/sdk/models/errors/enablepapertrailunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# EnablePaperTrailUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { EnablePaperTrailUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.EnablePaperTrailLogErrors](../../../sdk/models/errors/enablepapertraillogerrors.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 |
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { Errors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { Errors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: Errors = {
|
let value: Errors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetAllLibrariesResponseBody
|
# GetAllLibrariesBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { 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
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { GetAllLibrariesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetAllLibrariesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetAllLibrariesErrors = {
|
let value: GetAllLibrariesErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/getalllibrarieslibraryerrors.md
Normal file
21
docs/sdk/models/errors/getalllibrarieslibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetAllLibrariesLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllLibrariesLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetAllLibrariesLibraryErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/getalllibrariesunauthorized.md
Normal file
18
docs/sdk/models/errors/getalllibrariesunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetAllLibrariesUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllLibrariesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetAllLibrariesLibraryErrors](../../../sdk/models/errors/getalllibrarieslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetAvailableClientsResponseBody
|
# GetAvailableClientsBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { 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
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { GetAvailableClientsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetAvailableClientsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetAvailableClientsErrors = {
|
let value: GetAvailableClientsErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/getavailableclientsservererrors.md
Normal file
21
docs/sdk/models/errors/getavailableclientsservererrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetAvailableClientsServerErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAvailableClientsServerErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetAvailableClientsServerErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/getavailableclientsunauthorized.md
Normal file
18
docs/sdk/models/errors/getavailableclientsunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetAvailableClientsUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAvailableClientsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetAvailableClientsServerErrors](../../../sdk/models/errors/getavailableclientsservererrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetBandwidthStatisticsResponseBody
|
# GetBandwidthStatisticsBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { 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
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { GetBandwidthStatisticsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetBandwidthStatisticsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetBandwidthStatisticsErrors = {
|
let value: GetBandwidthStatisticsErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
# GetBandwidthStatisticsStatisticsErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetBandwidthStatisticsStatisticsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetBandwidthStatisticsStatisticsErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/getbandwidthstatisticsunauthorized.md
Normal file
18
docs/sdk/models/errors/getbandwidthstatisticsunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetBandwidthStatisticsUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetBandwidthStatisticsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetBandwidthStatisticsStatisticsErrors](../../../sdk/models/errors/getbandwidthstatisticsstatisticserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetBannerImageResponseBody
|
# GetBannerImageBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { 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
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { GetBannerImageErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetBannerImageErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetBannerImageErrors = {
|
let value: GetBannerImageErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/getbannerimagemediaerrors.md
Normal file
21
docs/sdk/models/errors/getbannerimagemediaerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetBannerImageMediaErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetBannerImageMediaErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetBannerImageMediaErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/getbannerimageunauthorized.md
Normal file
18
docs/sdk/models/errors/getbannerimageunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetBannerImageUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetBannerImageUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetBannerImageMediaErrors](../../../sdk/models/errors/getbannerimagemediaerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetButlerTasksResponseBody
|
# GetButlerTasksBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { 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
|
||||||
```
|
```
|
||||||
21
docs/sdk/models/errors/getbutlertasksbutlererrors.md
Normal file
21
docs/sdk/models/errors/getbutlertasksbutlererrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetButlerTasksButlerErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetButlerTasksButlerErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetButlerTasksButlerErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { GetButlerTasksErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetButlerTasksErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetButlerTasksErrors = {
|
let value: GetButlerTasksErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
18
docs/sdk/models/errors/getbutlertasksunauthorized.md
Normal file
18
docs/sdk/models/errors/getbutlertasksunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetButlerTasksUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetButlerTasksUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetButlerTasksButlerErrors](../../../sdk/models/errors/getbutlertasksbutlererrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetCompanionsDataResponseBody
|
# GetCompanionsDataBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { 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
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { GetCompanionsDataErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetCompanionsDataErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetCompanionsDataErrors = {
|
let value: GetCompanionsDataErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/getcompanionsdataplexerrors.md
Normal file
21
docs/sdk/models/errors/getcompanionsdataplexerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetCompanionsDataPlexErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCompanionsDataPlexErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetCompanionsDataPlexErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/getcompanionsdataunauthorized.md
Normal file
18
docs/sdk/models/errors/getcompanionsdataunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetCompanionsDataUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetCompanionsDataUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetCompanionsDataPlexErrors](../../../sdk/models/errors/getcompanionsdataplexerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetDevicesResponseBody
|
# GetDevicesBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { 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
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { GetDevicesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetDevicesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetDevicesErrors = {
|
let value: GetDevicesErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
@@ -1,14 +1,14 @@
|
|||||||
# GetRecentlyAddedErrors
|
# GetDevicesServerErrors
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetRecentlyAddedErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetDevicesServerErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetRecentlyAddedErrors = {
|
let value: GetDevicesServerErrors = {
|
||||||
code: 1001,
|
code: 1001,
|
||||||
message: "User could not be authenticated",
|
message: "User could not be authenticated",
|
||||||
status: 401,
|
status: 401,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetRecentlyAddedResponseBody
|
# 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 { GetRecentlyAddedResponseBody } 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
|
||||||
```
|
```
|
||||||
@@ -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.GetDevicesServerErrors](../../../sdk/models/errors/getdevicesservererrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetFileHashResponseBody
|
# GetFileHashBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { 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
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { GetFileHashErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetFileHashErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetFileHashErrors = {
|
let value: GetFileHashErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/getfilehashlibraryerrors.md
Normal file
21
docs/sdk/models/errors/getfilehashlibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetFileHashLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetFileHashLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetFileHashLibraryErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/getfilehashunauthorized.md
Normal file
18
docs/sdk/models/errors/getfilehashunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetFileHashUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetFileHashUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetFileHashLibraryErrors](../../../sdk/models/errors/getfilehashlibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetGeoDataResponseBody
|
# GetGeoDataBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { 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
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { GetGeoDataErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetGeoDataErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetGeoDataErrors = {
|
let value: GetGeoDataErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
@@ -1,14 +1,14 @@
|
|||||||
# GetUserDetailsErrors
|
# GetGeoDataPlexErrors
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetUserDetailsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetGeoDataPlexErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetUserDetailsErrors = {
|
let value: GetGeoDataPlexErrors = {
|
||||||
code: 1001,
|
code: 1001,
|
||||||
message: "User could not be authenticated",
|
message: "User could not be authenticated",
|
||||||
status: 401,
|
status: 401,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
18
docs/sdk/models/errors/getgeodataunauthorized.md
Normal file
18
docs/sdk/models/errors/getgeodataunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetGeoDataUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGeoDataUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetGeoDataPlexErrors](../../../sdk/models/errors/getgeodataplexerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetGlobalHubsResponseBody
|
# GetGlobalHubsBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetGlobalHubsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetGlobalHubsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
// No examples available for this model
|
// No examples available for this model
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { GetGlobalHubsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetGlobalHubsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetGlobalHubsErrors = {
|
let value: GetGlobalHubsErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/getglobalhubshubserrors.md
Normal file
21
docs/sdk/models/errors/getglobalhubshubserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetGlobalHubsHubsErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGlobalHubsHubsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetGlobalHubsHubsErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/getglobalhubsunauthorized.md
Normal file
18
docs/sdk/models/errors/getglobalhubsunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetGlobalHubsUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetGlobalHubsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetGlobalHubsHubsErrors](../../../sdk/models/errors/getglobalhubshubserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetHomeDataResponseBody
|
# GetHomeDataBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetHomeDataResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetHomeDataBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
// No examples available for this model
|
// No examples available for this model
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { GetHomeDataErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetHomeDataErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetHomeDataErrors = {
|
let value: GetHomeDataErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/gethomedataplexerrors.md
Normal file
21
docs/sdk/models/errors/gethomedataplexerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetHomeDataPlexErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetHomeDataPlexErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetHomeDataPlexErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/gethomedataunauthorized.md
Normal file
18
docs/sdk/models/errors/gethomedataunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetHomeDataUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetHomeDataUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetHomeDataPlexErrors](../../../sdk/models/errors/gethomedataplexerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetLibraryDetailsResponseBody
|
# GetLibraryDetailsBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryDetailsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetLibraryDetailsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
// No examples available for this model
|
// No examples available for this model
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { GetLibraryDetailsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetLibraryDetailsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetLibraryDetailsErrors = {
|
let value: GetLibraryDetailsErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/getlibrarydetailslibraryerrors.md
Normal file
21
docs/sdk/models/errors/getlibrarydetailslibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetLibraryDetailsLibraryErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryDetailsLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetLibraryDetailsLibraryErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/getlibrarydetailsunauthorized.md
Normal file
18
docs/sdk/models/errors/getlibrarydetailsunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetLibraryDetailsUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryDetailsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetLibraryDetailsLibraryErrors](../../../sdk/models/errors/getlibrarydetailslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetLibraryHubsResponseBody
|
# GetLibraryHubsBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryHubsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetLibraryHubsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
// No examples available for this model
|
// No examples available for this model
|
||||||
```
|
```
|
||||||
@@ -6,16 +6,16 @@
|
|||||||
import { GetLibraryHubsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetLibraryHubsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetLibraryHubsErrors = {
|
let value: GetLibraryHubsErrors = {
|
||||||
code: 1001,
|
code: 1000,
|
||||||
message: "User could not be authenticated",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 401,
|
status: 400,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||||
21
docs/sdk/models/errors/getlibraryhubshubserrors.md
Normal file
21
docs/sdk/models/errors/getlibraryhubshubserrors.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetLibraryHubsHubsErrors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryHubsHubsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
let value: GetLibraryHubsHubsErrors = {
|
||||||
|
code: 1001,
|
||||||
|
message: "User could not be authenticated",
|
||||||
|
status: 401,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||||
18
docs/sdk/models/errors/getlibraryhubsunauthorized.md
Normal file
18
docs/sdk/models/errors/getlibraryhubsunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetLibraryHubsUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryHubsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
|
// No examples available for this model
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | [errors.GetLibraryHubsHubsErrors](../../../sdk/models/errors/getlibraryhubshubserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetLibraryItemsResponseBody
|
# GetLibraryItemsBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetLibraryItemsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
// No examples available for this model
|
// No examples available for this model
|
||||||
```
|
```
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user