mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
Compare commits
17 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6c8a73ae84 | ||
|
|
c839d9f6c7 | ||
|
|
77b0ef9507 | ||
|
|
1cfbd17f28 | ||
|
|
2492807c65 | ||
|
|
ead0a8773c | ||
|
|
e254f82e06 | ||
|
|
a4369c999a | ||
|
|
c50b85f29a | ||
|
|
496ebda695 | ||
|
|
d436fc3452 | ||
|
|
99cdf6effe | ||
|
|
fa2ba82f62 | ||
|
|
fd8095a8df | ||
|
|
9911164ab0 | ||
|
|
ffedf47cad | ||
|
|
39d3a40524 |
File diff suppressed because one or more lines are too long
@@ -12,7 +12,7 @@ generation:
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
typescript:
|
||||
version: 0.21.1
|
||||
version: 0.28.0
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies: {}
|
||||
@@ -20,8 +20,10 @@ typescript:
|
||||
additionalPackageJSON: {}
|
||||
author: LukeHagar
|
||||
clientServerStatusCodesAsErrors: true
|
||||
defaultErrorName: SDKError
|
||||
enumFormat: enum
|
||||
flattenGlobalSecurity: true
|
||||
flatteningOrder: body-first
|
||||
imports:
|
||||
option: openapi
|
||||
paths:
|
||||
|
||||
@@ -1,36 +1,42 @@
|
||||
speakeasyVersion: 1.392.1
|
||||
speakeasyVersion: 1.405.6
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
sourceRevisionDigest: sha256:06d2bc8083f30b9af5d98573735dcbe4b08efb34abd1829f8ce5d8a4a54f2a7c
|
||||
sourceBlobDigest: sha256:ce28f3e6f2abc18cde6fb9e41093952eac55be5ad46b47b6f44fcdee1ca77eb2
|
||||
sourceRevisionDigest: sha256:1b8840d540c66b58d1009ec2581fb18464158ec9aa00464eac05ba737f31207e
|
||||
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
||||
tags:
|
||||
- latest
|
||||
- main
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:15e040d800921ded49cf84650ef2bc8fb1acf32c885ee193c42e838d754bf345
|
||||
sourceBlobDigest: sha256:c178be2b4bfefb37d76c0fdaef37c51f9b6ab1410422d3698a41bb6a8d79a79f
|
||||
tags:
|
||||
- latest
|
||||
- main
|
||||
targets:
|
||||
plexjs:
|
||||
source: my-source
|
||||
sourceNamespace: my-source
|
||||
sourceRevisionDigest: sha256:06d2bc8083f30b9af5d98573735dcbe4b08efb34abd1829f8ce5d8a4a54f2a7c
|
||||
sourceBlobDigest: sha256:ce28f3e6f2abc18cde6fb9e41093952eac55be5ad46b47b6f44fcdee1ca77eb2
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:15e040d800921ded49cf84650ef2bc8fb1acf32c885ee193c42e838d754bf345
|
||||
sourceBlobDigest: sha256:c178be2b4bfefb37d76c0fdaef37c51f9b6ab1410422d3698a41bb6a8d79a79f
|
||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||
codeSamplesRevisionDigest: sha256:449f01edd3f23d0c55b0daeac1240a8b08125fd34e06c09da47e9cb8222d2494
|
||||
outLocation: /github/workspace/repo
|
||||
codeSamplesRevisionDigest: sha256:5c54699020b321aaa58525ef206ddf19e67e8cd6eb452f7a064169fdef2170a9
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
sources:
|
||||
my-source:
|
||||
plexapi:
|
||||
inputs:
|
||||
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main
|
||||
- location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main
|
||||
targets:
|
||||
plexjs:
|
||||
target: typescript
|
||||
source: my-source
|
||||
source: plexapi
|
||||
publish:
|
||||
npm:
|
||||
token: $npm_token
|
||||
codeSamples:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-typescript-plexjs
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
sources:
|
||||
my-source:
|
||||
plexapi:
|
||||
inputs:
|
||||
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main
|
||||
- location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main
|
||||
targets:
|
||||
plexjs:
|
||||
target: typescript
|
||||
source: my-source
|
||||
source: plexapi
|
||||
publish:
|
||||
npm:
|
||||
token: $npm_token
|
||||
codeSamples:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-typescript-plexjs
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||
|
||||
@@ -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.
|
||||
const plexAPI = new PlexAPICore({
|
||||
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() {
|
||||
@@ -53,7 +57,7 @@ async function run() {
|
||||
const { value: result } = res;
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
285
README.md
285
README.md
@@ -11,6 +11,31 @@
|
||||
## Summary
|
||||
|
||||
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
||||
|
||||
# Plex Media Server OpenAPI Specification
|
||||
|
||||
An Open Source OpenAPI Specification for Plex Media Server
|
||||
|
||||
Automation and SDKs provided by [Speakeasy](https://speakeasyapi.dev/)
|
||||
|
||||
## Documentation
|
||||
|
||||
[API Documentation](https://plexapi.dev)
|
||||
|
||||
## SDKs
|
||||
|
||||
The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the [main specification Repository](https://github.com/LukeHagar/plex-api-spec).
|
||||
|
||||
| Language | Repository | Releases | Other |
|
||||
| --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
|
||||
| Python | [GitHub](https://github.com/LukeHagar/plexpy) | [PyPI](https://pypi.org/project/plex-api-client/) | - |
|
||||
| JavaScript/TypeScript | [GitHub](https://github.com/LukeHagar/plexjs) | [NPM](https://www.npmjs.com/package/@lukehagar/plexjs) \ [JSR](https://jsr.io/@lukehagar/plexjs) | - |
|
||||
| Go | [GitHub](https://github.com/LukeHagar/plexgo) | [Releases](https://github.com/LukeHagar/plexgo/releases) | [GoDoc](https://pkg.go.dev/github.com/LukeHagar/plexgo) |
|
||||
| Ruby | [GitHub](https://github.com/LukeHagar/plexruby) | [Releases](https://github.com/LukeHagar/plexruby/releases) | - |
|
||||
| Swift | [GitHub](https://github.com/LukeHagar/plexswift) | [Releases](https://github.com/LukeHagar/plexswift/releases) | - |
|
||||
| PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - |
|
||||
| Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - |
|
||||
| C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -
|
||||
<!-- End Summary [summary] -->
|
||||
|
||||
<!-- Start Table of Contents [toc] -->
|
||||
@@ -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)
|
||||
* [Available Resources and Operations](#available-resources-and-operations)
|
||||
* [Standalone functions](#standalone-functions)
|
||||
* [Global Parameters](#global-parameters)
|
||||
* [Retries](#retries)
|
||||
* [Error Handling](#error-handling)
|
||||
* [Server Selection](#server-selection)
|
||||
@@ -73,7 +97,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
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() {
|
||||
@@ -91,36 +119,21 @@ run();
|
||||
<!-- Start Available Resources and Operations [operations] -->
|
||||
## Available Resources and Operations
|
||||
|
||||
### [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
|
||||
|
||||
### [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
|
||||
<details open>
|
||||
<summary>Available methods</summary>
|
||||
|
||||
### [activities](docs/sdks/activities/README.md)
|
||||
|
||||
* [getServerActivities](docs/sdks/activities/README.md#getserveractivities) - Get 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)
|
||||
|
||||
* [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
|
||||
* [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)
|
||||
|
||||
* [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
|
||||
|
||||
### [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)
|
||||
|
||||
* [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||
* [getRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded) - Get Recently Added
|
||||
* [getRecentlyAddedLibrary](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
|
||||
* [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
||||
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The 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
|
||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||
|
||||
### [watchlist](docs/sdks/watchlist/README.md)
|
||||
|
||||
* [getWatchList](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
|
||||
|
||||
### [log](docs/sdks/log/README.md)
|
||||
|
||||
* [logLine](docs/sdks/log/README.md#logline) - Logging a single line message.
|
||||
* [logMultiLine](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
|
||||
* [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)
|
||||
|
||||
* [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
|
||||
* [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.
|
||||
* [getSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation) - Get Source Connection Information
|
||||
* [getUserDetails](docs/sdks/authentication/README.md#getuserdetails) - Get User Data By Token
|
||||
* [postUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata) - Get User Sign In Data
|
||||
* [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
|
||||
|
||||
### [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
|
||||
### [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
|
||||
|
||||
### [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)
|
||||
|
||||
@@ -207,38 +226,68 @@ run();
|
||||
* [getTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions) - Get Transcode Sessions
|
||||
* [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)
|
||||
|
||||
* [getUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
|
||||
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for 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] -->
|
||||
|
||||
<!-- Start Error Handling [errors] -->
|
||||
## Error Handling
|
||||
|
||||
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
|
||||
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 |
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| errors.GetServerCapabilitiesResponseBody | 400 | application/json |
|
||||
| errors.GetServerCapabilitiesServerResponseBody | 401 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
If a HTTP request fails, an operation my also throw an error from the `sdk/models/errors/httpclienterrors.ts` module:
|
||||
|
||||
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.
|
||||
| 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.GetServerCapabilitiesBadRequest | 400 | application/json |
|
||||
| errors.GetServerCapabilitiesUnauthorized | 401 | application/json |
|
||||
| errors.SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import {
|
||||
GetServerCapabilitiesResponseBody,
|
||||
GetServerCapabilitiesServerResponseBody,
|
||||
GetServerCapabilitiesBadRequest,
|
||||
GetServerCapabilitiesUnauthorized,
|
||||
SDKValidationError,
|
||||
} from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
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() {
|
||||
@@ -250,20 +299,20 @@ async function run() {
|
||||
console.log(result);
|
||||
} catch (err) {
|
||||
switch (true) {
|
||||
case err instanceof SDKValidationError: {
|
||||
case (err instanceof SDKValidationError): {
|
||||
// Validation errors can be pretty-printed
|
||||
console.error(err.pretty());
|
||||
// Raw value may also be inspected
|
||||
console.error(err.rawValue);
|
||||
return;
|
||||
}
|
||||
case err instanceof GetServerCapabilitiesResponseBody: {
|
||||
// Handle err.data$: GetServerCapabilitiesResponseBodyData
|
||||
case (err instanceof GetServerCapabilitiesBadRequest): {
|
||||
// Handle err.data$: GetServerCapabilitiesBadRequestData
|
||||
console.error(err);
|
||||
return;
|
||||
}
|
||||
case err instanceof GetServerCapabilitiesServerResponseBody: {
|
||||
// Handle err.data$: GetServerCapabilitiesServerResponseBodyData
|
||||
case (err instanceof GetServerCapabilitiesUnauthorized): {
|
||||
// Handle err.data$: GetServerCapabilitiesUnauthorizedData
|
||||
console.error(err);
|
||||
return;
|
||||
}
|
||||
@@ -277,6 +326,8 @@ async function 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] -->
|
||||
|
||||
<!-- Start Server Selection [server] -->
|
||||
@@ -296,7 +347,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
const plexAPI = new PlexAPI({
|
||||
serverIdx: 0,
|
||||
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() {
|
||||
@@ -327,7 +382,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
const plexAPI = new PlexAPI({
|
||||
serverURL: "{protocol}://{ip}:{port}",
|
||||
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() {
|
||||
@@ -349,12 +408,16 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
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() {
|
||||
const result = await plexAPI.plex.getCompanionsData({
|
||||
serverURL: "https://plex.tv/api/v2/",
|
||||
serverURL: "https://plex.tv/api/v2",
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
@@ -432,7 +495,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
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() {
|
||||
@@ -471,8 +538,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
- [activitiesCancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities)
|
||||
- [activitiesGetServerActivities](docs/sdks/activities/README.md#getserveractivities)
|
||||
- [authenticationGetSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation)
|
||||
- [authenticationGetTokenDetails](docs/sdks/authentication/README.md#gettokendetails)
|
||||
- [authenticationGetTransientToken](docs/sdks/authentication/README.md#gettransienttoken)
|
||||
- [authenticationGetUserDetails](docs/sdks/authentication/README.md#getuserdetails)
|
||||
- [authenticationPostUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata)
|
||||
- [butlerGetButlerTasks](docs/sdks/butler/README.md#getbutlertasks)
|
||||
- [butlerStartAllTasks](docs/sdks/butler/README.md#startalltasks)
|
||||
@@ -481,6 +548,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
- [butlerStopTask](docs/sdks/butler/README.md#stoptask)
|
||||
- [hubsGetGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs)
|
||||
- [hubsGetLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs)
|
||||
- [hubsGetRecentlyAdded](docs/sdks/hubs/README.md#getrecentlyadded)
|
||||
- [libraryDeleteLibrary](docs/sdks/library/README.md#deletelibrary)
|
||||
- [libraryGetAllLibraries](docs/sdks/library/README.md#getalllibraries)
|
||||
- [libraryGetFileHash](docs/sdks/library/README.md#getfilehash)
|
||||
@@ -489,8 +557,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
- [libraryGetMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey)
|
||||
- [libraryGetMetadataChildren](docs/sdks/library/README.md#getmetadatachildren)
|
||||
- [libraryGetOnDeck](docs/sdks/library/README.md#getondeck)
|
||||
- [libraryGetRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded)
|
||||
- [libraryGetRecentlyAddedLibrary](docs/sdks/library/README.md#getrecentlyaddedlibrary)
|
||||
- [libraryGetRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata)
|
||||
- [libraryGetSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries)
|
||||
- [libraryGetSearchLibrary](docs/sdks/library/README.md#getsearchlibrary)
|
||||
- [libraryGetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent)
|
||||
- [logEnablePaperTrail](docs/sdks/log/README.md#enablepapertrail)
|
||||
@@ -547,54 +616,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
</details>
|
||||
<!-- 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] -->
|
||||
## Retries
|
||||
|
||||
@@ -606,7 +627,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
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() {
|
||||
@@ -647,7 +672,11 @@ const plexAPI = new PlexAPI({
|
||||
retryConnectionErrors: false,
|
||||
},
|
||||
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() {
|
||||
|
||||
150
RELEASES.md
150
RELEASES.md
@@ -979,3 +979,153 @@ Based on:
|
||||
- [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 - .
|
||||
6
USAGE.md
6
USAGE.md
@@ -4,7 +4,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
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() {
|
||||
|
||||
1741
codeSamples.yaml
1741
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
@@ -1,11 +1,11 @@
|
||||
# AddPlaylistContentsResponseBody
|
||||
# AddPlaylistContentsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddPlaylistContentsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { AddPlaylistContentsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# AddPlaylistContentsPlaylistsResponseBody
|
||||
# AddPlaylistContentsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddPlaylistContentsPlaylistsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { AddPlaylistContentsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# ApplyUpdatesResponseBody
|
||||
# ApplyUpdatesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ApplyUpdatesResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { ApplyUpdatesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# ApplyUpdatesUpdaterResponseBody
|
||||
# ApplyUpdatesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ApplyUpdatesUpdaterResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { ApplyUpdatesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# CancelServerActivitiesResponseBody
|
||||
# CancelServerActivitiesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CancelServerActivitiesResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { CancelServerActivitiesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# CancelServerActivitiesActivitiesResponseBody
|
||||
# CancelServerActivitiesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CancelServerActivitiesActivitiesResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { CancelServerActivitiesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# CheckForUpdatesResponseBody
|
||||
# CheckForUpdatesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CheckForUpdatesResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { CheckForUpdatesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# CheckForUpdatesUpdaterResponseBody
|
||||
# CheckForUpdatesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CheckForUpdatesUpdaterResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { CheckForUpdatesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# ClearPlaylistContentsResponseBody
|
||||
# ClearPlaylistContentsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ClearPlaylistContentsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { ClearPlaylistContentsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# ClearPlaylistContentsPlaylistsResponseBody
|
||||
# ClearPlaylistContentsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ClearPlaylistContentsPlaylistsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { ClearPlaylistContentsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# CreatePlaylistResponseBody
|
||||
# CreatePlaylistBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePlaylistResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { CreatePlaylistBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# CreatePlaylistPlaylistsResponseBody
|
||||
# CreatePlaylistUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePlaylistPlaylistsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { CreatePlaylistUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# DeleteLibraryResponseBody
|
||||
# DeleteLibraryBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { DeleteLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# DeleteLibraryLibraryResponseBody
|
||||
# DeleteLibraryUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteLibraryLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { DeleteLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# DeletePlaylistResponseBody
|
||||
# DeletePlaylistBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeletePlaylistResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { DeletePlaylistBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# DeletePlaylistPlaylistsResponseBody
|
||||
# DeletePlaylistUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeletePlaylistPlaylistsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { DeletePlaylistUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# EnablePaperTrailResponseBody
|
||||
# EnablePaperTrailBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { EnablePaperTrailResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { EnablePaperTrailBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# EnablePaperTrailLogResponseBody
|
||||
# EnablePaperTrailUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { EnablePaperTrailLogResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { EnablePaperTrailUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetAllLibrariesResponseBody
|
||||
# GetAllLibrariesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllLibrariesResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetAllLibrariesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetAllLibrariesLibraryResponseBody
|
||||
# GetAllLibrariesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllLibrariesLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetAllLibrariesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetAvailableClientsResponseBody
|
||||
# GetAvailableClientsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAvailableClientsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetAvailableClientsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetAvailableClientsServerResponseBody
|
||||
# GetAvailableClientsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAvailableClientsServerResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetAvailableClientsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetBandwidthStatisticsResponseBody
|
||||
# GetBandwidthStatisticsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetBandwidthStatisticsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetBandwidthStatisticsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetBandwidthStatisticsStatisticsResponseBody
|
||||
# GetBandwidthStatisticsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetBandwidthStatisticsStatisticsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetBandwidthStatisticsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetBannerImageResponseBody
|
||||
# GetBannerImageBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetBannerImageResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetBannerImageBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetBannerImageMediaResponseBody
|
||||
# GetBannerImageUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetBannerImageMediaResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetBannerImageUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetButlerTasksResponseBody
|
||||
# GetButlerTasksBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetButlerTasksResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetButlerTasksBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetButlerTasksButlerResponseBody
|
||||
# GetButlerTasksUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetButlerTasksButlerResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetButlerTasksUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetCompanionsDataResponseBody
|
||||
# GetCompanionsDataBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetCompanionsDataResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetCompanionsDataBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetCompanionsDataPlexResponseBody
|
||||
# GetCompanionsDataUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetCompanionsDataPlexResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetCompanionsDataUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetDevicesResponseBody
|
||||
# GetDevicesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetDevicesResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetDevicesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetDevicesServerResponseBody
|
||||
# GetDevicesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetDevicesServerResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetDevicesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetFileHashResponseBody
|
||||
# GetFileHashBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetFileHashResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetFileHashBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetFileHashLibraryResponseBody
|
||||
# GetFileHashUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetFileHashLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetFileHashUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetGeoDataResponseBody
|
||||
# GetGeoDataBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGeoDataResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetGeoDataBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetGeoDataPlexResponseBody
|
||||
# GetGeoDataUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGeoDataPlexResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetGeoDataUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetGlobalHubsResponseBody
|
||||
# GetGlobalHubsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGlobalHubsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetGlobalHubsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetGlobalHubsHubsResponseBody
|
||||
# GetGlobalHubsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGlobalHubsHubsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetGlobalHubsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetHomeDataResponseBody
|
||||
# GetHomeDataBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetHomeDataResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetHomeDataBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetHomeDataPlexResponseBody
|
||||
# GetHomeDataUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetHomeDataPlexResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetHomeDataUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetLibraryDetailsResponseBody
|
||||
# GetLibraryDetailsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryDetailsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetLibraryDetailsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetLibraryDetailsLibraryResponseBody
|
||||
# GetLibraryDetailsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryDetailsLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetLibraryDetailsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetLibraryHubsResponseBody
|
||||
# GetLibraryHubsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryHubsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetLibraryHubsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetLibraryHubsHubsResponseBody
|
||||
# GetLibraryHubsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryHubsHubsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetLibraryHubsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetLibraryItemsResponseBody
|
||||
# GetLibraryItemsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryItemsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetLibraryItemsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetLibraryItemsLibraryResponseBody
|
||||
# GetLibraryItemsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryItemsLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetLibraryItemsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMediaProvidersResponseBody
|
||||
# GetMediaProvidersBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaProvidersResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetMediaProvidersBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMediaProvidersServerResponseBody
|
||||
# GetMediaProvidersUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaProvidersServerResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetMediaProvidersUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMetaDataByRatingKeyResponseBody
|
||||
# GetMetaDataByRatingKeyBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetaDataByRatingKeyResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetMetaDataByRatingKeyBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMetaDataByRatingKeyLibraryResponseBody
|
||||
# GetMetaDataByRatingKeyUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetaDataByRatingKeyLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetMetaDataByRatingKeyUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMetadataChildrenResponseBody
|
||||
# GetMetadataChildrenBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataChildrenResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetMetadataChildrenBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMetadataChildrenLibraryResponseBody
|
||||
# GetMetadataChildrenUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataChildrenLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetMetadataChildrenUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMyPlexAccountResponseBody
|
||||
# GetMyPlexAccountBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMyPlexAccountResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetMyPlexAccountBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMyPlexAccountServerResponseBody
|
||||
# GetMyPlexAccountUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMyPlexAccountServerResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetMyPlexAccountUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetOnDeckResponseBody
|
||||
# GetOnDeckBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetOnDeckBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetOnDeckLibraryResponseBody
|
||||
# GetOnDeckUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetOnDeckUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetPinResponseBody
|
||||
# GetPinBadRequest
|
||||
|
||||
Bad Request response when the X-Plex-Client-Identifier is missing
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPinResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetPinBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetPlaylistResponseBody
|
||||
# GetPlaylistBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPlaylistResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetPlaylistBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetPlaylistContentsResponseBody
|
||||
# GetPlaylistContentsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPlaylistContentsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetPlaylistContentsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetPlaylistContentsPlaylistsResponseBody
|
||||
# GetPlaylistContentsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPlaylistContentsPlaylistsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetPlaylistContentsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetPlaylistsResponseBody
|
||||
# GetPlaylistsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPlaylistsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetPlaylistsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetPlaylistsPlaylistsResponseBody
|
||||
# GetPlaylistsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPlaylistsPlaylistsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetPlaylistsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetPlaylistPlaylistsResponseBody
|
||||
# GetPlaylistUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPlaylistPlaylistsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetPlaylistUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetRecentlyAddedLibraryResponseBody
|
||||
# GetRecentlyAddedLibraryBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetRecentlyAddedLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetRecentlyAddedLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { GetRecentlyAddedLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetRecentlyAddedLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
code: 1000,
|
||||
message: "X-Plex-Client-Identifier is missing",
|
||||
status: 400,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -0,0 +1,21 @@
|
||||
# GetRecentlyAddedLibraryLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetRecentlyAddedLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetRecentlyAddedLibraryLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
@@ -0,0 +1,18 @@
|
||||
# GetRecentlyAddedLibraryUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetRecentlyAddedLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetRecentlyAddedLibraryLibraryErrors](../../../sdk/models/errors/getrecentlyaddedlibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetRecentlyAddedResponseBody
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetRecentlyAddedResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetRecentlyAddedErrors](../../../sdk/models/errors/getrecentlyaddederrors.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 @@
|
||||
# GetRefreshLibraryMetadataResponseBody
|
||||
# GetRefreshLibraryMetadataBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetRefreshLibraryMetadataResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetRefreshLibraryMetadataBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetRefreshLibraryMetadataLibraryResponseBody
|
||||
# GetRefreshLibraryMetadataUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetRefreshLibraryMetadataLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetRefreshLibraryMetadataUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetResizedPhotoResponseBody
|
||||
# GetResizedPhotoBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetResizedPhotoResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetResizedPhotoBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetResizedPhotoServerResponseBody
|
||||
# GetResizedPhotoUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetResizedPhotoServerResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetResizedPhotoUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetResourcesStatisticsResponseBody
|
||||
# GetResourcesStatisticsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetResourcesStatisticsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetResourcesStatisticsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetResourcesStatisticsStatisticsResponseBody
|
||||
# GetResourcesStatisticsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetResourcesStatisticsStatisticsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetResourcesStatisticsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
18
docs/sdk/models/errors/getsearchalllibrariesbadrequest.md
Normal file
18
docs/sdk/models/errors/getsearchalllibrariesbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetSearchAllLibrariesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetSearchAllLibrariesErrors](../../../sdk/models/errors/getsearchalllibrarieserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetRecentlyAddedErrors
|
||||
# GetSearchAllLibrariesErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetRecentlyAddedErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetSearchAllLibrariesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetRecentlyAddedErrors = {
|
||||
let value: GetSearchAllLibrariesErrors = {
|
||||
code: 1000,
|
||||
message: "X-Plex-Client-Identifier is missing",
|
||||
status: 400,
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetUserDetailsAuthenticationErrors
|
||||
# GetSearchAllLibrariesLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetUserDetailsAuthenticationErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetSearchAllLibrariesLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetUserDetailsAuthenticationErrors = {
|
||||
let value: GetSearchAllLibrariesLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetUserDetailsAuthenticationResponseBody
|
||||
# GetSearchAllLibrariesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetUserDetailsAuthenticationResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetSearchAllLibrariesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -14,5 +14,5 @@ import { GetUserDetailsAuthenticationResponseBody } from "@lukehagar/plexjs/sdk/
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetUserDetailsAuthenticationErrors](../../../sdk/models/errors/getuserdetailsauthenticationerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `errors` | [errors.GetSearchAllLibrariesLibraryErrors](../../../sdk/models/errors/getsearchalllibrarieslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetSearchLibraryResponseBody
|
||||
# GetSearchLibraryBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetSearchLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetSearchLibraryLibraryResponseBody
|
||||
# GetSearchLibraryUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchLibraryLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetSearchLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetSearchResultsResponseBody
|
||||
# GetSearchResultsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchResultsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetSearchResultsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetSearchResultsSearchResponseBody
|
||||
# GetSearchResultsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchResultsSearchResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetSearchResultsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetServerActivitiesResponseBody
|
||||
# GetServerActivitiesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetServerActivitiesResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetServerActivitiesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetServerActivitiesActivitiesResponseBody
|
||||
# GetServerActivitiesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetServerActivitiesActivitiesResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetServerActivitiesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetServerCapabilitiesResponseBody
|
||||
# GetServerCapabilitiesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetServerCapabilitiesResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetServerCapabilitiesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetServerCapabilitiesServerResponseBody
|
||||
# GetServerCapabilitiesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetServerCapabilitiesServerResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetServerCapabilitiesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetServerIdentityResponseBody
|
||||
# GetServerIdentityRequestTimeout
|
||||
|
||||
Request Timeout
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetServerIdentityResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetServerIdentityRequestTimeout } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetServerListResponseBody
|
||||
# GetServerListBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetServerListResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetServerListBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetServerListServerResponseBody
|
||||
# GetServerListUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetServerListServerResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetServerListUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetServerPreferencesResponseBody
|
||||
# GetServerPreferencesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetServerPreferencesResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetServerPreferencesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetServerPreferencesServerResponseBody
|
||||
# GetServerPreferencesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetServerPreferencesServerResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetServerPreferencesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// 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