Compare commits

...

23 Commits

Author SHA1 Message Date
speakeasybot
cdcdc0ca8e ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.474.0 2025-01-24 00:11:07 +00:00
speakeasybot
b03cc6a609 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.459.2 2024-12-22 00:12:06 +00:00
speakeasybot
4e989e0de3 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.456.1 2024-12-20 16:02:41 +00:00
Luke Hagar
c10e011a68 adjusted workflow 2024-12-20 09:59:40 -06:00
speakeasybot
7e3dca8466 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6 2024-12-16 22:20:26 +00:00
speakeasybot
8a2d3e04ab ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6 2024-11-14 00:11:57 +00:00
speakeasybot
6c8a73ae84 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6 2024-11-11 20:30:45 +00:00
speakeasybot
c839d9f6c7 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.406.0 2024-10-03 12:29:09 +00:00
speakeasybot
77b0ef9507 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.406.0 2024-10-03 00:11:46 +00:00
speakeasybot
1cfbd17f28 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6 2024-10-02 02:30:07 +00:00
speakeasybot
2492807c65 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6 2024-10-01 15:37:08 +00:00
speakeasybot
ead0a8773c ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6 2024-10-01 00:12:18 +00:00
speakeasybot
e254f82e06 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.398.0 2024-09-17 00:10:26 +00:00
Luke Hagar
a4369c999a Update workflow.yaml 2024-09-16 13:14:07 -05:00
speakeasybot
c50b85f29a ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.397.2 2024-09-16 18:01:31 +00:00
Luke Hagar
496ebda695 Update workflow.yaml 2024-09-16 12:57:23 -05:00
speakeasybot
d436fc3452 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.396.9 2024-09-16 00:11:44 +00:00
speakeasybot
99cdf6effe ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.396.9 2024-09-15 00:12:31 +00:00
speakeasybot
fa2ba82f62 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.396.9 2024-09-14 00:10:58 +00:00
speakeasybot
fd8095a8df ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.396.6 2024-09-13 00:11:18 +00:00
speakeasybot
9911164ab0 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.396.2 2024-09-12 00:11:23 +00:00
speakeasybot
ffedf47cad ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.395.1 2024-09-11 00:11:04 +00:00
speakeasybot
39d3a40524 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.394.0 2024-09-10 00:11:07 +00:00
1078 changed files with 82077 additions and 56087 deletions

2
.gitignore vendored
View File

@@ -1,3 +1,5 @@
/.speakeasy/reports
/react-query
/sdk/models/errors
/sdk/types
/__tests__

View File

@@ -1,6 +1,10 @@
**/*
!/FUNCTIONS.md
!/RUNTIMES.md
!/REACT_QUERY.md
!/**/*.ts
!/**/*.js
!/**/*.json
!/**/*.map
/.eslintrc.js

File diff suppressed because one or more lines are too long

View File

@@ -11,8 +11,9 @@ generation:
requestResponseComponentNamesFeb2024: true
auth:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
typescript:
version: 0.21.1
version: 0.32.2
additionalDependencies:
dependencies: {}
devDependencies: {}
@@ -20,8 +21,12 @@ typescript:
additionalPackageJSON: {}
author: LukeHagar
clientServerStatusCodesAsErrors: true
defaultErrorName: SDKError
enableCustomCodeRegions: false
enableReactQuery: false
enumFormat: enum
flattenGlobalSecurity: true
flatteningOrder: body-first
imports:
option: openapi
paths:

View File

@@ -1,36 +1,45 @@
speakeasyVersion: 1.392.1
speakeasyVersion: 1.474.0
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:b146684d2d813daa8ba29e432a12334838753d0b20183beca8178a74ec4d895a
sourceBlobDigest: sha256:58f51c4319fcda931d63950fd926e8650e20a2e1375e356bf3a930111e246a58
tags:
- latest
- speakeasy-sdk-regen-1737677393
- 0.0.3
targets:
plexjs:
source: my-source
sourceNamespace: my-source
sourceRevisionDigest: sha256:06d2bc8083f30b9af5d98573735dcbe4b08efb34abd1829f8ce5d8a4a54f2a7c
sourceBlobDigest: sha256:ce28f3e6f2abc18cde6fb9e41093952eac55be5ad46b47b6f44fcdee1ca77eb2
source: plexapi
sourceNamespace: plexapi
sourceRevisionDigest: sha256:b146684d2d813daa8ba29e432a12334838753d0b20183beca8178a74ec4d895a
sourceBlobDigest: sha256:58f51c4319fcda931d63950fd926e8650e20a2e1375e356bf3a930111e246a58
codeSamplesNamespace: code-samples-typescript-plexjs
codeSamplesRevisionDigest: sha256:449f01edd3f23d0c55b0daeac1240a8b08125fd34e06c09da47e9cb8222d2494
outLocation: /github/workspace/repo
codeSamplesRevisionDigest: sha256:96ce210c9c8c0b5ae45ce5fe2e62d64d6914bb1b1b6c18eaee6e1e379fb40e13
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
sources:
my-source:
plexapi:
inputs:
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/output/plex-media-server-spec-dereferenced.yaml
registry:
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
targets:
plexjs:
target: typescript
source: my-source
source: plexapi
publish:
npm:
token: $npm_token
codeSamples:
output: codeSamples.yaml
registry:
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-typescript-plexjs
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs

View File

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

View File

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

608
README.md
View File

@@ -11,23 +11,55 @@
## Summary
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
# Plex Media Server OpenAPI Specification
An Open Source OpenAPI Specification for Plex Media Server
Automation and SDKs provided by [Speakeasy](https://speakeasyapi.dev/)
## Documentation
[API Documentation](https://plexapi.dev)
## SDKs
The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the [main specification Repository](https://github.com/LukeHagar/plex-api-spec).
| Language | Repository | Releases | Other |
| --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
| Python | [GitHub](https://github.com/LukeHagar/plexpy) | [PyPI](https://pypi.org/project/plex-api-client/) | - |
| JavaScript/TypeScript | [GitHub](https://github.com/LukeHagar/plexjs) | [NPM](https://www.npmjs.com/package/@lukehagar/plexjs) \ [JSR](https://jsr.io/@lukehagar/plexjs) | - |
| Go | [GitHub](https://github.com/LukeHagar/plexgo) | [Releases](https://github.com/LukeHagar/plexgo/releases) | [GoDoc](https://pkg.go.dev/github.com/LukeHagar/plexgo) |
| Ruby | [GitHub](https://github.com/LukeHagar/plexruby) | [Releases](https://github.com/LukeHagar/plexruby/releases) | - |
| Swift | [GitHub](https://github.com/LukeHagar/plexswift) | [Releases](https://github.com/LukeHagar/plexswift/releases) | - |
| PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - |
| Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - |
| C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -
<!-- End Summary [summary] -->
<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [@lukehagar/plexjs](#lukehagarplexjs)
* [Plex Media Server OpenAPI Specification](#plex-media-server-openapi-specification)
* [Documentation](#documentation)
* [SDKs](#sdks)
* [SDK Installation](#sdk-installation)
* [SDK Example Usage](#sdk-example-usage)
* [Available Resources and Operations](#available-resources-and-operations)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Custom HTTP Client](#custom-http-client)
* [Authentication](#authentication)
* [Requirements](#requirements)
* [Standalone functions](#standalone-functions)
* [Retries](#retries)
* [Debugging](#debugging)
* [Development](#development)
* [Maturity](#maturity)
* [Contributions](#contributions)
* [SDK Installation](#sdk-installation)
* [Requirements](#requirements)
* [SDK Example Usage](#sdk-example-usage)
* [Available Resources and Operations](#available-resources-and-operations)
* [Standalone functions](#standalone-functions)
* [Global Parameters](#global-parameters)
* [Retries](#retries)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Custom HTTP Client](#custom-http-client)
* [Authentication](#authentication)
* [Debugging](#debugging)
<!-- End Table of Contents [toc] -->
<!-- Start SDK Installation [installation] -->
@@ -72,15 +104,14 @@ yarn add @lukehagar/plexjs zod
import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.server.getServerCapabilities();
const result = await plexAPI.server.getServerCapabilities();
// Handle the result
console.log(result);
// Handle the result
console.log(result);
}
run();
@@ -91,36 +122,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 +145,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 +193,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,158 +229,156 @@ 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.
Some methods specify known errors which can be thrown. All the known errors are enumerated in the `sdk/models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `getServerCapabilities` method may throw the following errors:
| Error Object | Status Code | Content Type |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| errors.GetServerCapabilitiesResponseBody | 400 | application/json |
| errors.GetServerCapabilitiesServerResponseBody | 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.
| Error Type | Status Code | Content Type |
| ---------------------------------------- | ----------- | ---------------- |
| errors.GetServerCapabilitiesBadRequest | 400 | application/json |
| errors.GetServerCapabilitiesUnauthorized | 401 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
If the method throws an error and it is not captured by the known errors, it will default to throwing a `SDKError`.
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import {
GetServerCapabilitiesResponseBody,
GetServerCapabilitiesServerResponseBody,
SDKValidationError,
GetServerCapabilitiesBadRequest,
GetServerCapabilitiesUnauthorized,
SDKValidationError,
} from "@lukehagar/plexjs/sdk/models/errors";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
let result;
try {
result = await plexAPI.server.getServerCapabilities();
let result;
try {
result = await plexAPI.server.getServerCapabilities();
// Handle the result
console.log(result);
} catch (err) {
switch (true) {
case err instanceof SDKValidationError: {
// Validation errors can be pretty-printed
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
case err instanceof GetServerCapabilitiesResponseBody: {
// Handle err.data$: GetServerCapabilitiesResponseBodyData
console.error(err);
return;
}
case err instanceof GetServerCapabilitiesServerResponseBody: {
// Handle err.data$: GetServerCapabilitiesServerResponseBodyData
console.error(err);
return;
}
default: {
throw err;
}
}
// Handle the result
console.log(result);
} catch (err) {
switch (true) {
// The server response does not match the expected SDK schema
case (err instanceof SDKValidationError): {
// Pretty-print will provide a human-readable multi-line error message
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
case (err instanceof GetServerCapabilitiesBadRequest): {
// Handle err.data$: GetServerCapabilitiesBadRequestData
console.error(err);
return;
}
case (err instanceof GetServerCapabilitiesUnauthorized): {
// Handle err.data$: GetServerCapabilitiesUnauthorizedData
console.error(err);
return;
}
default: {
// Other errors such as network errors, see HTTPClientErrors for more details
throw err;
}
}
}
}
run();
```
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `sdk/models/errors/httpclienterrors.ts` module:
| HTTP Client Error | Description |
| ---------------------------------------------------- | ---------------------------------------------------- |
| RequestAbortedError | HTTP request was aborted by the client |
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
| ConnectionError | HTTP client was unable to make a request to a server |
| InvalidRequestError | Any input used to create a request is invalid |
| UnexpectedClientError | Unrecognised or unexpected error |
<!-- End Error Handling [errors] -->
<!-- Start Server Selection [server] -->
## Server Selection
### Select Server by Index
### Server Variables
You can override the default server globally by passing a server index to the `serverIdx` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
| - | ------ | --------- |
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `https`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
serverIdx: 0,
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
});
async function run() {
const result = await plexAPI.server.getServerCapabilities();
// Handle the result
console.log(result);
}
run();
```
#### Variables
Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following parameters are available when initializing the SDK client instance:
* `protocol: models.ServerProtocol`
* `ip: string`
* `port: string`
### Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example:
The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
serverURL: "{protocol}://{ip}:{port}",
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
serverURL: "https://10.10.10.47:32400",
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.server.getServerCapabilities();
const result = await plexAPI.server.getServerCapabilities();
// Handle the result
console.log(result);
// Handle the result
console.log(result);
}
run();
```
### Override Server URL Per-Operation
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.plex.getCompanionsData({
serverURL: "https://plex.tv/api/v2/",
});
const result = await plexAPI.plex.getCompanionsData({
serverURL: "https://plex.tv/api/v2",
});
// Handle the result
console.log(result);
// Handle the result
console.log(result);
}
run();
@@ -422,24 +442,23 @@ const sdk = new PlexAPI({ httpClient });
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
| ------------- | ------------- | ------------- |
| `accessToken` | apiKey | API key |
| Name | Type | Scheme |
| ------------- | ------ | ------- |
| `accessToken` | apiKey | API key |
To authenticate with the API the `accessToken` parameter must be set when initializing the SDK client instance. For example:
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.server.getServerCapabilities();
const result = await plexAPI.server.getServerCapabilities();
// Handle the result
console.log(result);
// Handle the result
console.log(result);
}
run();
@@ -468,133 +487,86 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
<summary>Available standalone functions</summary>
- [activitiesCancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities)
- [activitiesGetServerActivities](docs/sdks/activities/README.md#getserveractivities)
- [authenticationGetSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation)
- [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)
- [butlerStartTask](docs/sdks/butler/README.md#starttask)
- [butlerStopAllTasks](docs/sdks/butler/README.md#stopalltasks)
- [butlerStopTask](docs/sdks/butler/README.md#stoptask)
- [hubsGetGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs)
- [hubsGetLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs)
- [libraryDeleteLibrary](docs/sdks/library/README.md#deletelibrary)
- [libraryGetAllLibraries](docs/sdks/library/README.md#getalllibraries)
- [libraryGetFileHash](docs/sdks/library/README.md#getfilehash)
- [libraryGetLibraryDetails](docs/sdks/library/README.md#getlibrarydetails)
- [libraryGetLibraryItems](docs/sdks/library/README.md#getlibraryitems)
- [libraryGetMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey)
- [libraryGetMetadataChildren](docs/sdks/library/README.md#getmetadatachildren)
- [libraryGetOnDeck](docs/sdks/library/README.md#getondeck)
- [libraryGetRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded)
- [libraryGetRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata)
- [libraryGetSearchLibrary](docs/sdks/library/README.md#getsearchlibrary)
- [libraryGetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent)
- [logEnablePaperTrail](docs/sdks/log/README.md#enablepapertrail)
- [logLogLine](docs/sdks/log/README.md#logline)
- [logLogMultiLine](docs/sdks/log/README.md#logmultiline)
- [mediaGetBannerImage](docs/sdks/media/README.md#getbannerimage)
- [mediaGetThumbImage](docs/sdks/media/README.md#getthumbimage)
- [mediaMarkPlayed](docs/sdks/media/README.md#markplayed)
- [mediaMarkUnplayed](docs/sdks/media/README.md#markunplayed)
- [mediaUpdatePlayProgress](docs/sdks/media/README.md#updateplayprogress)
- [playlistsAddPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents)
- [playlistsClearPlaylistContents](docs/sdks/playlists/README.md#clearplaylistcontents)
- [playlistsCreatePlaylist](docs/sdks/playlists/README.md#createplaylist)
- [playlistsDeletePlaylist](docs/sdks/playlists/README.md#deleteplaylist)
- [playlistsGetPlaylistContents](docs/sdks/playlists/README.md#getplaylistcontents)
- [playlistsGetPlaylist](docs/sdks/playlists/README.md#getplaylist)
- [playlistsGetPlaylists](docs/sdks/playlists/README.md#getplaylists)
- [playlistsUpdatePlaylist](docs/sdks/playlists/README.md#updateplaylist)
- [playlistsUploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist)
- [plexGetCompanionsData](docs/sdks/plex/README.md#getcompanionsdata)
- [plexGetGeoData](docs/sdks/plex/README.md#getgeodata)
- [plexGetHomeData](docs/sdks/plex/README.md#gethomedata)
- [plexGetPin](docs/sdks/plex/README.md#getpin)
- [plexGetServerResources](docs/sdks/plex/README.md#getserverresources)
- [plexGetTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid)
- [plexGetUserFriends](docs/sdks/plex/README.md#getuserfriends)
- [searchGetSearchResults](docs/sdks/search/README.md#getsearchresults)
- [searchPerformSearch](docs/sdks/search/README.md#performsearch)
- [searchPerformVoiceSearch](docs/sdks/search/README.md#performvoicesearch)
- [serverGetAvailableClients](docs/sdks/server/README.md#getavailableclients)
- [serverGetDevices](docs/sdks/server/README.md#getdevices)
- [serverGetMediaProviders](docs/sdks/server/README.md#getmediaproviders)
- [serverGetMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount)
- [serverGetResizedPhoto](docs/sdks/server/README.md#getresizedphoto)
- [serverGetServerCapabilities](docs/sdks/server/README.md#getservercapabilities)
- [serverGetServerIdentity](docs/sdks/server/README.md#getserveridentity)
- [serverGetServerList](docs/sdks/server/README.md#getserverlist)
- [serverGetServerPreferences](docs/sdks/server/README.md#getserverpreferences)
- [sessionsGetSessionHistory](docs/sdks/sessions/README.md#getsessionhistory)
- [sessionsGetSessions](docs/sdks/sessions/README.md#getsessions)
- [sessionsGetTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions)
- [sessionsStopTranscodeSession](docs/sdks/sessions/README.md#stoptranscodesession)
- [statisticsGetBandwidthStatistics](docs/sdks/statistics/README.md#getbandwidthstatistics)
- [statisticsGetResourcesStatistics](docs/sdks/statistics/README.md#getresourcesstatistics)
- [statisticsGetStatistics](docs/sdks/statistics/README.md#getstatistics)
- [updaterApplyUpdates](docs/sdks/updater/README.md#applyupdates)
- [updaterCheckForUpdates](docs/sdks/updater/README.md#checkforupdates)
- [updaterGetUpdateStatus](docs/sdks/updater/README.md#getupdatestatus)
- [videoGetTimeline](docs/sdks/video/README.md#gettimeline)
- [videoStartUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode)
- [watchlistGetWatchList](docs/sdks/watchlist/README.md#getwatchlist)
- [`activitiesCancelServerActivities`](docs/sdks/activities/README.md#cancelserveractivities) - Cancel Server Activities
- [`activitiesGetServerActivities`](docs/sdks/activities/README.md#getserveractivities) - Get Server Activities
- [`authenticationGetSourceConnectionInformation`](docs/sdks/authentication/README.md#getsourceconnectioninformation) - Get Source Connection Information
- [`authenticationGetTokenDetails`](docs/sdks/authentication/README.md#gettokendetails) - Get Token Details
- [`authenticationGetTransientToken`](docs/sdks/authentication/README.md#gettransienttoken) - Get a Transient Token
- [`authenticationPostUsersSignInData`](docs/sdks/authentication/README.md#postuserssignindata) - Get User Sign In Data
- [`butlerGetButlerTasks`](docs/sdks/butler/README.md#getbutlertasks) - Get Butler tasks
- [`butlerStartAllTasks`](docs/sdks/butler/README.md#startalltasks) - Start all Butler tasks
- [`butlerStartTask`](docs/sdks/butler/README.md#starttask) - Start a single Butler task
- [`butlerStopAllTasks`](docs/sdks/butler/README.md#stopalltasks) - Stop all Butler tasks
- [`butlerStopTask`](docs/sdks/butler/README.md#stoptask) - Stop a single Butler task
- [`hubsGetGlobalHubs`](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
- [`hubsGetLibraryHubs`](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
- [`hubsGetRecentlyAdded`](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
- [`libraryDeleteLibrary`](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
- [`libraryGetAllLibraries`](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
- [`libraryGetFileHash`](docs/sdks/library/README.md#getfilehash) - Get Hash Value
- [`libraryGetLibraryDetails`](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
- [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
- [`libraryGetMetaDataByRatingKey`](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
- [`libraryGetMetadataChildren`](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
- [`libraryGetOnDeck`](docs/sdks/library/README.md#getondeck) - Get On Deck
- [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
- [`libraryGetRefreshLibraryMetadata`](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
- [`libraryGetSearchAllLibraries`](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
- [`libraryGetSearchLibrary`](docs/sdks/library/README.md#getsearchlibrary) - Search Library
- [`libraryGetTopWatchedContent`](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
- [`logEnablePaperTrail`](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
- [`logLogLine`](docs/sdks/log/README.md#logline) - Logging a single line message.
- [`logLogMultiLine`](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
- [`mediaGetBannerImage`](docs/sdks/media/README.md#getbannerimage) - Get Banner Image
- [`mediaGetThumbImage`](docs/sdks/media/README.md#getthumbimage) - Get Thumb Image
- [`mediaMarkPlayed`](docs/sdks/media/README.md#markplayed) - Mark Media Played
- [`mediaMarkUnplayed`](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
- [`mediaUpdatePlayProgress`](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress
- [`playlistsAddPlaylistContents`](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a Playlist
- [`playlistsClearPlaylistContents`](docs/sdks/playlists/README.md#clearplaylistcontents) - Delete Playlist Contents
- [`playlistsCreatePlaylist`](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
- [`playlistsDeletePlaylist`](docs/sdks/playlists/README.md#deleteplaylist) - Deletes a Playlist
- [`playlistsGetPlaylist`](docs/sdks/playlists/README.md#getplaylist) - Retrieve Playlist
- [`playlistsGetPlaylistContents`](docs/sdks/playlists/README.md#getplaylistcontents) - Retrieve Playlist Contents
- [`playlistsGetPlaylists`](docs/sdks/playlists/README.md#getplaylists) - Get All Playlists
- [`playlistsUpdatePlaylist`](docs/sdks/playlists/README.md#updateplaylist) - Update a Playlist
- [`playlistsUploadPlaylist`](docs/sdks/playlists/README.md#uploadplaylist) - Upload Playlist
- [`plexGetCompanionsData`](docs/sdks/plex/README.md#getcompanionsdata) - Get Companions Data
- [`plexGetGeoData`](docs/sdks/plex/README.md#getgeodata) - Get Geo Data
- [`plexGetHomeData`](docs/sdks/plex/README.md#gethomedata) - Get Plex Home Data
- [`plexGetPin`](docs/sdks/plex/README.md#getpin) - Get a Pin
- [`plexGetServerResources`](docs/sdks/plex/README.md#getserverresources) - Get Server Resources
- [`plexGetTokenByPinId`](docs/sdks/plex/README.md#gettokenbypinid) - Get Access Token by PinId
- [`plexGetUserFriends`](docs/sdks/plex/README.md#getuserfriends) - Get list of friends of the user logged in
- [`searchGetSearchResults`](docs/sdks/search/README.md#getsearchresults) - Get Search Results
- [`searchPerformSearch`](docs/sdks/search/README.md#performsearch) - Perform a search
- [`searchPerformVoiceSearch`](docs/sdks/search/README.md#performvoicesearch) - Perform a voice search
- [`serverGetAvailableClients`](docs/sdks/server/README.md#getavailableclients) - Get Available Clients
- [`serverGetDevices`](docs/sdks/server/README.md#getdevices) - Get Devices
- [`serverGetMediaProviders`](docs/sdks/server/README.md#getmediaproviders) - Get Media Providers
- [`serverGetMyPlexAccount`](docs/sdks/server/README.md#getmyplexaccount) - Get MyPlex Account
- [`serverGetResizedPhoto`](docs/sdks/server/README.md#getresizedphoto) - Get a Resized Photo
- [`serverGetServerCapabilities`](docs/sdks/server/README.md#getservercapabilities) - Get Server Capabilities
- [`serverGetServerIdentity`](docs/sdks/server/README.md#getserveridentity) - Get Server Identity
- [`serverGetServerList`](docs/sdks/server/README.md#getserverlist) - Get Server List
- [`serverGetServerPreferences`](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
- [`sessionsGetSessionHistory`](docs/sdks/sessions/README.md#getsessionhistory) - Get Session History
- [`sessionsGetSessions`](docs/sdks/sessions/README.md#getsessions) - Get Active Sessions
- [`sessionsGetTranscodeSessions`](docs/sdks/sessions/README.md#gettranscodesessions) - Get Transcode Sessions
- [`sessionsStopTranscodeSession`](docs/sdks/sessions/README.md#stoptranscodesession) - Stop a Transcode Session
- [`statisticsGetBandwidthStatistics`](docs/sdks/statistics/README.md#getbandwidthstatistics) - Get Bandwidth Statistics
- [`statisticsGetResourcesStatistics`](docs/sdks/statistics/README.md#getresourcesstatistics) - Get Resources Statistics
- [`statisticsGetStatistics`](docs/sdks/statistics/README.md#getstatistics) - Get Media Statistics
- [`updaterApplyUpdates`](docs/sdks/updater/README.md#applyupdates) - Apply Updates
- [`updaterCheckForUpdates`](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
- [`updaterGetUpdateStatus`](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
- [`videoGetTimeline`](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
- [`videoStartUniversalTranscode`](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
- [`watchlistGetWatchList`](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
</details>
<!-- End Standalone functions [standalone-funcs] -->
<!-- Start Global Parameters [global-parameters] -->
## Global Parameters
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
@@ -605,26 +577,25 @@ To change the default retry strategy for a single API call, simply provide a ret
import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.server.getServerCapabilities({
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
const result = await plexAPI.server.getServerCapabilities({
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
// Handle the result
console.log(result);
// Handle the result
console.log(result);
}
run();
@@ -636,25 +607,24 @@ If you'd like to override the default retry strategy for all operations that sup
import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
retryConnectionErrors: false,
},
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.server.getServerCapabilities();
const result = await plexAPI.server.getServerCapabilities();
// Handle the result
console.log(result);
// Handle the result
console.log(result);
}
run();

View File

@@ -978,4 +978,204 @@ Based on:
### Generated
- [typescript v0.21.1] .
### Releases
- [NPM v0.21.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.21.1 - .
- [NPM v0.21.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.21.1 - .
## 2024-09-10 00:09:01
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.394.0 (2.413.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.22.0] .
### Releases
- [NPM v0.22.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.22.0 - .
## 2024-09-11 00:09:01
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.395.1 (2.415.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.22.1] .
### Releases
- [NPM v0.22.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.22.1 - .
## 2024-09-12 00:09:10
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.396.2 (2.415.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.22.2] .
### Releases
- [NPM v0.22.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.22.2 - .
## 2024-09-13 00:09:09
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.396.6 (2.415.6) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.23.0] .
### Releases
- [NPM v0.23.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.0 - .
## 2024-09-14 00:08:56
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.396.9 (2.415.7) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.23.1] .
### Releases
- [NPM v0.23.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.1 - .
## 2024-09-15 00:10:25
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.396.9 (2.415.7) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.23.2] .
### Releases
- [NPM v0.23.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.2 - .
## 2024-09-16 00:09:42
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.396.9 (2.415.7) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.23.3] .
### Releases
- [NPM v0.23.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.3 - .
## 2024-09-16 17:59:12
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.397.2 (2.415.8) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.23.4] .
### Releases
- [NPM v0.23.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.4 - .
## 2024-09-17 00:08:25
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.398.0 (2.415.8) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.23.5] .
### Releases
- [NPM v0.23.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.5 - .
## 2024-10-01 00:10:47
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.24.0] .
### Releases
- [NPM v0.24.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.0 - .
## 2024-10-01 15:35:33
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.24.1] .
### Releases
- [NPM v0.24.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.1 - .
## 2024-10-02 02:28:25
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.24.2] .
### Releases
- [NPM v0.24.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.2 - .
## 2024-10-03 00:09:30
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.25.1] .
### Releases
- [NPM v0.25.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.25.1 - .
## 2024-10-03 12:26:50
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.26.1] .
### Releases
- [NPM v0.26.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.26.1 - .
## 2024-11-11 20:28:21
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.28.0] .
### Releases
- [NPM v0.28.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.28.0 - .
## 2024-11-14 00:09:39
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.30.0] .
### Releases
- [NPM v0.30.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.30.0 - .
## 2024-12-16 22:17:52
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.31.1] .
### Releases
- [NPM v0.31.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.31.1 - .
## 2024-12-20 16:01:16
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.456.1 (2.481.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.32.0] .
### Releases
- [NPM v0.32.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.0 - .
## 2024-12-22 00:10:48
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.459.2 (2.483.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.32.1] .
### Releases
- [NPM v0.32.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.1 - .
## 2025-01-24 00:09:35
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.474.0 (2.495.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.32.2] .
### Releases
- [NPM v0.32.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.2 - .

View File

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

View File

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

File diff suppressed because it is too large Load Diff

View File

@@ -1,11 +1,11 @@
# AddPlaylistContentsResponseBody
# AddPlaylistContentsBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## 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
```

View File

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

View File

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

View File

@@ -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
```

View File

@@ -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
```

View File

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

View File

@@ -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
```

View File

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

View File

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

View File

@@ -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
```

View File

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

View File

@@ -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
```

View File

@@ -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
```

View File

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

View File

@@ -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
```

View File

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

View File

@@ -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
```

View File

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

View File

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

View File

@@ -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
```

View File

@@ -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
```

View File

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

View File

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

View File

@@ -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
```

View File

@@ -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
```

View File

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

View File

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

View File

@@ -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
```

View File

@@ -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
```

View File

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

View File

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

View File

@@ -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
```

View File

@@ -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
```

View File

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

View File

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

View File

@@ -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
```

View File

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

View File

@@ -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
```

View File

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

View File

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

View File

@@ -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
```

View File

@@ -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
```

View File

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

View File

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

View File

@@ -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
```

View File

@@ -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
```

View File

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

View File

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

View File

@@ -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
```

View File

@@ -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
```

View File

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

View File

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

View File

@@ -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
```

View File

@@ -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
```

View File

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

View File

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

View File

@@ -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
```

View File

@@ -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
```

View File

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

View File

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

View File

@@ -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
```

View File

@@ -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
```

View File

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

View File

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

View File

@@ -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
```

View File

@@ -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
```

View File

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

View File

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

View File

@@ -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
```

View File

@@ -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
```

View File

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

View File

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

View File

@@ -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
```

View File

@@ -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
```

View File

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

View File

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

View File

@@ -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
```

View File

@@ -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
```

View File

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

View File

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

View File

@@ -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
```

View File

@@ -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
```

View File

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

View File

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

View File

@@ -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
```

View File

@@ -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
```

View File

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

View File

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

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