mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
fd8095a8df | ||
|
|
9911164ab0 | ||
|
|
ffedf47cad | ||
|
|
39d3a40524 | ||
|
|
8dc802ca50 | ||
|
|
5465f1e74c | ||
|
|
2d100b8e75 | ||
|
|
0533836427 |
5
.github/workflows/publish-jsr.yaml
vendored
5
.github/workflows/publish-jsr.yaml
vendored
@@ -7,9 +7,8 @@ permissions:
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
registry_package:
|
||||
types: [published]
|
||||
|
||||
jobs:
|
||||
publish:
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -12,7 +12,7 @@ generation:
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
typescript:
|
||||
version: 0.20.2
|
||||
version: 0.23.0
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies: {}
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
speakeasyVersion: 1.392.1
|
||||
speakeasyVersion: 1.396.6
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
sourceRevisionDigest: sha256:facfe37caadd8c575513e97dbc389d0e4d7166c5310c891edb352e65da942367
|
||||
sourceBlobDigest: sha256:f816f80e55e2eeb2a0c30bfb6bfe919f0a1a7284e996cec3a680aa661d39e3c6
|
||||
sourceRevisionDigest: sha256:c5a41b6aee4bd139b743b4e1242411b5dfbcb7360eaf2cd5ffe68605ad979c4a
|
||||
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
||||
tags:
|
||||
- latest
|
||||
- main
|
||||
@@ -11,11 +11,10 @@ targets:
|
||||
plexjs:
|
||||
source: my-source
|
||||
sourceNamespace: my-source
|
||||
sourceRevisionDigest: sha256:facfe37caadd8c575513e97dbc389d0e4d7166c5310c891edb352e65da942367
|
||||
sourceBlobDigest: sha256:f816f80e55e2eeb2a0c30bfb6bfe919f0a1a7284e996cec3a680aa661d39e3c6
|
||||
sourceRevisionDigest: sha256:c5a41b6aee4bd139b743b4e1242411b5dfbcb7360eaf2cd5ffe68605ad979c4a
|
||||
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||
codeSamplesRevisionDigest: sha256:7b7fc9efdcfb2e57e099c7a3da0c064c908a9862cec1a419d9785af091277b8c
|
||||
outLocation: /github/workspace/repo
|
||||
codeSamplesRevisionDigest: sha256:09af81a03c971b1e59cef54746892a87b98a5f7fc3c92253c9a6f45a0e9bf4fe
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
|
||||
321
README.md
321
README.md
@@ -72,15 +72,15 @@ 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>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
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 +91,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,27 +114,11 @@ 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
|
||||
* [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
|
||||
@@ -165,16 +134,20 @@ run();
|
||||
* [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 +160,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 SignIn 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,11 +196,28 @@ 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] -->
|
||||
@@ -221,7 +227,8 @@ All SDK methods return a response object or throw an error. If Error objects are
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| errors.GetServerCapabilitiesResponseBody | 401 | application/json |
|
||||
| errors.GetServerCapabilitiesBadRequest | 400 | application/json |
|
||||
| errors.GetServerCapabilitiesUnauthorized | 401 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
|
||||
@@ -230,41 +237,47 @@ Validation errors can also occur when either method arguments or data returned f
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import {
|
||||
GetServerCapabilitiesResponseBody,
|
||||
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>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
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;
|
||||
}
|
||||
default: {
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
} catch (err) {
|
||||
switch (true) {
|
||||
case (err instanceof SDKValidationError): {
|
||||
// Validation errors can be pretty-printed
|
||||
console.error(err.pretty());
|
||||
// Raw value may also be inspected
|
||||
console.error(err.rawValue);
|
||||
return;
|
||||
}
|
||||
case (err instanceof GetServerCapabilitiesBadRequest): {
|
||||
// Handle err.data$: GetServerCapabilitiesBadRequestData
|
||||
console.error(err);
|
||||
return;
|
||||
}
|
||||
case (err instanceof GetServerCapabilitiesUnauthorized): {
|
||||
// Handle err.data$: GetServerCapabilitiesUnauthorizedData
|
||||
console.error(err);
|
||||
return;
|
||||
}
|
||||
default: {
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
run();
|
||||
@@ -287,16 +300,16 @@ You can override the default server globally by passing a server index to the `s
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
serverIdx: 0,
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
serverIdx: 0,
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
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();
|
||||
@@ -318,16 +331,16 @@ The default server can also be overridden globally by passing a URL to the `serv
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
serverURL: "{protocol}://{ip}:{port}",
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
serverURL: "{protocol}://{ip}:{port}",
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
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();
|
||||
@@ -341,17 +354,17 @@ The server URL can also be overridden on a per-operation basis, provided a serve
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
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();
|
||||
@@ -424,15 +437,15 @@ To authenticate with the API the `accessToken` parameter must be set when initia
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
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();
|
||||
@@ -464,8 +477,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)
|
||||
@@ -564,23 +577,27 @@ This is used to track the client application and its usage
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { IncludeHttps, IncludeIPv6, IncludeRelay } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import {
|
||||
IncludeHttps,
|
||||
IncludeIPv6,
|
||||
IncludeRelay,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
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,
|
||||
});
|
||||
const result = await plexAPI.plex.getServerResources(
|
||||
"gcgzw5rz2xovp84b4vha3a40",
|
||||
IncludeHttps.One,
|
||||
IncludeRelay.One,
|
||||
IncludeIPv6.One,
|
||||
);
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
@@ -598,26 +615,26 @@ 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>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
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();
|
||||
@@ -629,25 +646,25 @@ 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>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
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();
|
||||
|
||||
62
RELEASES.md
62
RELEASES.md
@@ -958,4 +958,64 @@ Based on:
|
||||
### Generated
|
||||
- [typescript v0.20.2] .
|
||||
### Releases
|
||||
- [NPM v0.20.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.20.2 - .
|
||||
- [NPM v0.20.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.20.2 - .
|
||||
|
||||
## 2024-09-08 17:37:50
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.392.1 (2.411.9) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.21.0] .
|
||||
### Releases
|
||||
- [NPM v0.21.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.21.0 - .
|
||||
|
||||
## 2024-09-09 00:09:42
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.392.1 (2.411.9) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.21.1] .
|
||||
### Releases
|
||||
- [NPM v0.21.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.21.1 - .
|
||||
|
||||
## 2024-09-10 00:09:01
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.394.0 (2.413.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.22.0] .
|
||||
### Releases
|
||||
- [NPM v0.22.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.22.0 - .
|
||||
|
||||
## 2024-09-11 00:09:01
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.395.1 (2.415.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.22.1] .
|
||||
### Releases
|
||||
- [NPM v0.22.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.22.1 - .
|
||||
|
||||
## 2024-09-12 00:09:10
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.396.2 (2.415.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.22.2] .
|
||||
### Releases
|
||||
- [NPM v0.22.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.22.2 - .
|
||||
|
||||
## 2024-09-13 00:09:09
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.396.6 (2.415.6) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.23.0] .
|
||||
### Releases
|
||||
- [NPM v0.23.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.23.0 - .
|
||||
10
USAGE.md
10
USAGE.md
@@ -3,15 +3,15 @@
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
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();
|
||||
|
||||
@@ -344,7 +344,7 @@ actions:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: resources
|
||||
source: "import { PlexAPI } from \"@lukehagar/plexjs\";\nimport { IncludeHttps, IncludeIPv6, IncludeRelay } from \"@lukehagar/plexjs/sdk/models/operations\";\n\nconst plexAPI = new PlexAPI({\n accessToken: \"<YOUR_API_KEY_HERE>\",\n xPlexClientIdentifier: \"gcgzw5rz2xovp84b4vha3a40\",\n});\n\nasync function run() {\n const result = await plexAPI.plex.getServerResources({\n xPlexToken: \"CV5xoxjTpFKUzBTShsaf\",\n includeHttps: IncludeHttps.One,\n includeRelay: IncludeRelay.One,\n includeIPv6: IncludeIPv6.One,\n });\n \n // Handle the result\n console.log(result)\n}\n\nrun();"
|
||||
source: "import { PlexAPI } from \"@lukehagar/plexjs\";\nimport { IncludeHttps, IncludeIPv6, IncludeRelay } from \"@lukehagar/plexjs/sdk/models/operations\";\n\nconst plexAPI = new PlexAPI({\n accessToken: \"<YOUR_API_KEY_HERE>\",\n xPlexClientIdentifier: \"gcgzw5rz2xovp84b4vha3a40\",\n});\n\nasync function run() {\n const result = await plexAPI.plex.getServerResources(\"gcgzw5rz2xovp84b4vha3a40\", IncludeHttps.One, IncludeRelay.One, IncludeIPv6.One);\n \n // Handle the result\n console.log(result)\n}\n\nrun();"
|
||||
- target: $["paths"]["/search"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
@@ -433,14 +433,14 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getUserDetails
|
||||
source: "import { PlexAPI } from \"@lukehagar/plexjs\";\n\nconst plexAPI = new PlexAPI({\n accessToken: \"<YOUR_API_KEY_HERE>\",\n xPlexClientIdentifier: \"gcgzw5rz2xovp84b4vha3a40\",\n});\n\nasync function run() {\n const result = await plexAPI.authentication.getUserDetails(\"CV5xoxjTpFKUzBTShsaf\");\n \n // Handle the result\n console.log(result)\n}\n\nrun();"
|
||||
label: getTokenDetails
|
||||
source: "import { PlexAPI } from \"@lukehagar/plexjs\";\n\nconst plexAPI = new PlexAPI({\n accessToken: \"<YOUR_API_KEY_HERE>\",\n xPlexClientIdentifier: \"gcgzw5rz2xovp84b4vha3a40\",\n});\n\nasync function run() {\n const result = await plexAPI.authentication.getTokenDetails();\n \n // Handle the result\n console.log(result)\n}\n\nrun();"
|
||||
- target: $["paths"]["/users/signin"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: data
|
||||
source: "import { PlexAPI } from \"@lukehagar/plexjs\";\n\nconst plexAPI = new PlexAPI({\n xPlexClientIdentifier: \"gcgzw5rz2xovp84b4vha3a40\",\n});\n\nasync function run() {\n const result = await plexAPI.authentication.postUsersSignInData(\"gcgzw5rz2xovp84b4vha3a40\", {\n login: \"username@email.com\",\n password: \"password123\",\n });\n \n // Handle the result\n console.log(result)\n}\n\nrun();"
|
||||
source: "import { PlexAPI } from \"@lukehagar/plexjs\";\n\nconst plexAPI = new PlexAPI({\n xPlexClientIdentifier: \"gcgzw5rz2xovp84b4vha3a40\",\n});\n\nasync function run() {\n const result = await plexAPI.authentication.postUsersSignInData(\"gcgzw5rz2xovp84b4vha3a40\", {\n login: \"username@email.com\",\n password: \"password123\",\n verificationCode: \"123456\",\n });\n \n // Handle the result\n console.log(result)\n}\n\nrun();"
|
||||
- target: $["paths"]["/video/:/transcode/universal/start.mpd"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
# AddPlaylistContentsResponseBody
|
||||
# AddPlaylistContentsBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddPlaylistContentsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { AddPlaylistContentsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { AddPlaylistContentsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: AddPlaylistContentsErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/addplaylistcontentsplaylistserrors.md
Normal file
21
docs/sdk/models/errors/addplaylistcontentsplaylistserrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# AddPlaylistContentsPlaylistsErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddPlaylistContentsPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: AddPlaylistContentsPlaylistsErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/addplaylistcontentsunauthorized.md
Normal file
18
docs/sdk/models/errors/addplaylistcontentsunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# AddPlaylistContentsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddPlaylistContentsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.AddPlaylistContentsPlaylistsErrors](../../../sdk/models/errors/addplaylistcontentsplaylistserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# ApplyUpdatesResponseBody
|
||||
# ApplyUpdatesBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ApplyUpdatesResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { ApplyUpdatesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { ApplyUpdatesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: ApplyUpdatesErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
18
docs/sdk/models/errors/applyupdatesunauthorized.md
Normal file
18
docs/sdk/models/errors/applyupdatesunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# ApplyUpdatesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ApplyUpdatesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.ApplyUpdatesUpdaterErrors](../../../sdk/models/errors/applyupdatesupdatererrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
21
docs/sdk/models/errors/applyupdatesupdatererrors.md
Normal file
21
docs/sdk/models/errors/applyupdatesupdatererrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# ApplyUpdatesUpdaterErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ApplyUpdatesUpdaterErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: ApplyUpdatesUpdaterErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
@@ -0,0 +1,21 @@
|
||||
# CancelServerActivitiesActivitiesErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CancelServerActivitiesActivitiesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: CancelServerActivitiesActivitiesErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
@@ -1,11 +1,11 @@
|
||||
# CancelServerActivitiesResponseBody
|
||||
# CancelServerActivitiesBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CancelServerActivitiesResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { CancelServerActivitiesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { CancelServerActivitiesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: CancelServerActivitiesErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
18
docs/sdk/models/errors/cancelserveractivitiesunauthorized.md
Normal file
18
docs/sdk/models/errors/cancelserveractivitiesunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# CancelServerActivitiesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CancelServerActivitiesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.CancelServerActivitiesActivitiesErrors](../../../sdk/models/errors/cancelserveractivitiesactivitieserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# CheckForUpdatesResponseBody
|
||||
# CheckForUpdatesBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CheckForUpdatesResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { CheckForUpdatesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { CheckForUpdatesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: CheckForUpdatesErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
18
docs/sdk/models/errors/checkforupdatesunauthorized.md
Normal file
18
docs/sdk/models/errors/checkforupdatesunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# CheckForUpdatesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CheckForUpdatesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.CheckForUpdatesUpdaterErrors](../../../sdk/models/errors/checkforupdatesupdatererrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
21
docs/sdk/models/errors/checkforupdatesupdatererrors.md
Normal file
21
docs/sdk/models/errors/checkforupdatesupdatererrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# CheckForUpdatesUpdaterErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CheckForUpdatesUpdaterErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: CheckForUpdatesUpdaterErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
@@ -1,11 +1,11 @@
|
||||
# ClearPlaylistContentsResponseBody
|
||||
# ClearPlaylistContentsBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ClearPlaylistContentsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { ClearPlaylistContentsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { ClearPlaylistContentsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: ClearPlaylistContentsErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -0,0 +1,21 @@
|
||||
# ClearPlaylistContentsPlaylistsErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ClearPlaylistContentsPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: ClearPlaylistContentsPlaylistsErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/clearplaylistcontentsunauthorized.md
Normal file
18
docs/sdk/models/errors/clearplaylistcontentsunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# ClearPlaylistContentsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ClearPlaylistContentsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.ClearPlaylistContentsPlaylistsErrors](../../../sdk/models/errors/clearplaylistcontentsplaylistserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# CreatePlaylistResponseBody
|
||||
# CreatePlaylistBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePlaylistResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { CreatePlaylistBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { CreatePlaylistErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: CreatePlaylistErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/createplaylistplaylistserrors.md
Normal file
21
docs/sdk/models/errors/createplaylistplaylistserrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# CreatePlaylistPlaylistsErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePlaylistPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: CreatePlaylistPlaylistsErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/createplaylistunauthorized.md
Normal file
18
docs/sdk/models/errors/createplaylistunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# CreatePlaylistUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePlaylistUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.CreatePlaylistPlaylistsErrors](../../../sdk/models/errors/createplaylistplaylistserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# DeleteLibraryResponseBody
|
||||
# DeleteLibraryBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { DeleteLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { DeleteLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: DeleteLibraryErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/deletelibrarylibraryerrors.md
Normal file
21
docs/sdk/models/errors/deletelibrarylibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# DeleteLibraryLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: DeleteLibraryLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/deletelibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/deletelibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# DeleteLibraryUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.DeleteLibraryLibraryErrors](../../../sdk/models/errors/deletelibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# DeletePlaylistResponseBody
|
||||
# DeletePlaylistBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeletePlaylistResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { DeletePlaylistBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { DeletePlaylistErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: DeletePlaylistErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/deleteplaylistplaylistserrors.md
Normal file
21
docs/sdk/models/errors/deleteplaylistplaylistserrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# DeletePlaylistPlaylistsErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeletePlaylistPlaylistsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: DeletePlaylistPlaylistsErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/deleteplaylistunauthorized.md
Normal file
18
docs/sdk/models/errors/deleteplaylistunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# DeletePlaylistUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeletePlaylistUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.DeletePlaylistPlaylistsErrors](../../../sdk/models/errors/deleteplaylistplaylistserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# EnablePaperTrailResponseBody
|
||||
# EnablePaperTrailBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { EnablePaperTrailResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { EnablePaperTrailBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { EnablePaperTrailErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: EnablePaperTrailErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/enablepapertraillogerrors.md
Normal file
21
docs/sdk/models/errors/enablepapertraillogerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# EnablePaperTrailLogErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { EnablePaperTrailLogErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: EnablePaperTrailLogErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/enablepapertrailunauthorized.md
Normal file
18
docs/sdk/models/errors/enablepapertrailunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# EnablePaperTrailUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { EnablePaperTrailUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.EnablePaperTrailLogErrors](../../../sdk/models/errors/enablepapertraillogerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -6,16 +6,16 @@
|
||||
import { Errors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: Errors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetAllLibrariesResponseBody
|
||||
# GetAllLibrariesBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllLibrariesResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetAllLibrariesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { GetAllLibrariesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetAllLibrariesErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/getalllibrarieslibraryerrors.md
Normal file
21
docs/sdk/models/errors/getalllibrarieslibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetAllLibrariesLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllLibrariesLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetAllLibrariesLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/getalllibrariesunauthorized.md
Normal file
18
docs/sdk/models/errors/getalllibrariesunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetAllLibrariesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllLibrariesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetAllLibrariesLibraryErrors](../../../sdk/models/errors/getalllibrarieslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetAvailableClientsResponseBody
|
||||
# GetAvailableClientsBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAvailableClientsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetAvailableClientsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { GetAvailableClientsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetAvailableClientsErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/getavailableclientsservererrors.md
Normal file
21
docs/sdk/models/errors/getavailableclientsservererrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetAvailableClientsServerErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAvailableClientsServerErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetAvailableClientsServerErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/getavailableclientsunauthorized.md
Normal file
18
docs/sdk/models/errors/getavailableclientsunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetAvailableClientsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAvailableClientsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetAvailableClientsServerErrors](../../../sdk/models/errors/getavailableclientsservererrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetBandwidthStatisticsResponseBody
|
||||
# GetBandwidthStatisticsBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetBandwidthStatisticsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetBandwidthStatisticsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { GetBandwidthStatisticsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetBandwidthStatisticsErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -0,0 +1,21 @@
|
||||
# GetBandwidthStatisticsStatisticsErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetBandwidthStatisticsStatisticsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetBandwidthStatisticsStatisticsErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/getbandwidthstatisticsunauthorized.md
Normal file
18
docs/sdk/models/errors/getbandwidthstatisticsunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetBandwidthStatisticsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetBandwidthStatisticsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetBandwidthStatisticsStatisticsErrors](../../../sdk/models/errors/getbandwidthstatisticsstatisticserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetBannerImageResponseBody
|
||||
# GetBannerImageBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetBannerImageResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetBannerImageBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { GetBannerImageErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetBannerImageErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/getbannerimagemediaerrors.md
Normal file
21
docs/sdk/models/errors/getbannerimagemediaerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetBannerImageMediaErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetBannerImageMediaErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetBannerImageMediaErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/getbannerimageunauthorized.md
Normal file
18
docs/sdk/models/errors/getbannerimageunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetBannerImageUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetBannerImageUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetBannerImageMediaErrors](../../../sdk/models/errors/getbannerimagemediaerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetButlerTasksResponseBody
|
||||
# GetButlerTasksBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetButlerTasksResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetButlerTasksBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
21
docs/sdk/models/errors/getbutlertasksbutlererrors.md
Normal file
21
docs/sdk/models/errors/getbutlertasksbutlererrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetButlerTasksButlerErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetButlerTasksButlerErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetButlerTasksButlerErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
@@ -6,16 +6,16 @@
|
||||
import { GetButlerTasksErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetButlerTasksErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
18
docs/sdk/models/errors/getbutlertasksunauthorized.md
Normal file
18
docs/sdk/models/errors/getbutlertasksunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetButlerTasksUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetButlerTasksUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetButlerTasksButlerErrors](../../../sdk/models/errors/getbutlertasksbutlererrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetCompanionsDataResponseBody
|
||||
# GetCompanionsDataBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetCompanionsDataResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetCompanionsDataBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { GetCompanionsDataErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetCompanionsDataErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/getcompanionsdataplexerrors.md
Normal file
21
docs/sdk/models/errors/getcompanionsdataplexerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetCompanionsDataPlexErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetCompanionsDataPlexErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetCompanionsDataPlexErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/getcompanionsdataunauthorized.md
Normal file
18
docs/sdk/models/errors/getcompanionsdataunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetCompanionsDataUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetCompanionsDataUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetCompanionsDataPlexErrors](../../../sdk/models/errors/getcompanionsdataplexerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetDevicesResponseBody
|
||||
# GetDevicesBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetDevicesResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetDevicesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { GetDevicesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetDevicesErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/getdevicesservererrors.md
Normal file
21
docs/sdk/models/errors/getdevicesservererrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetDevicesServerErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetDevicesServerErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetDevicesServerErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/getdevicesunauthorized.md
Normal file
18
docs/sdk/models/errors/getdevicesunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetDevicesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetDevicesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetDevicesServerErrors](../../../sdk/models/errors/getdevicesservererrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetFileHashResponseBody
|
||||
# GetFileHashBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetFileHashResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetFileHashBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { GetFileHashErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetFileHashErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/getfilehashlibraryerrors.md
Normal file
21
docs/sdk/models/errors/getfilehashlibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetFileHashLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetFileHashLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetFileHashLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/getfilehashunauthorized.md
Normal file
18
docs/sdk/models/errors/getfilehashunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetFileHashUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetFileHashUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetFileHashLibraryErrors](../../../sdk/models/errors/getfilehashlibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetGeoDataResponseBody
|
||||
# GetGeoDataBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGeoDataResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetGeoDataBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { GetGeoDataErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetGeoDataErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,14 +1,14 @@
|
||||
# GetUserDetailsErrors
|
||||
# GetGeoDataPlexErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetUserDetailsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetGeoDataPlexErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetUserDetailsErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
let value: GetGeoDataPlexErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
18
docs/sdk/models/errors/getgeodataunauthorized.md
Normal file
18
docs/sdk/models/errors/getgeodataunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetGeoDataUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGeoDataUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetGeoDataPlexErrors](../../../sdk/models/errors/getgeodataplexerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetGlobalHubsResponseBody
|
||||
# GetGlobalHubsBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGlobalHubsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetGlobalHubsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { GetGlobalHubsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetGlobalHubsErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/getglobalhubshubserrors.md
Normal file
21
docs/sdk/models/errors/getglobalhubshubserrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetGlobalHubsHubsErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGlobalHubsHubsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetGlobalHubsHubsErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/getglobalhubsunauthorized.md
Normal file
18
docs/sdk/models/errors/getglobalhubsunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetGlobalHubsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGlobalHubsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetGlobalHubsHubsErrors](../../../sdk/models/errors/getglobalhubshubserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetHomeDataResponseBody
|
||||
# GetHomeDataBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetHomeDataResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetHomeDataBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { GetHomeDataErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetHomeDataErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/gethomedataplexerrors.md
Normal file
21
docs/sdk/models/errors/gethomedataplexerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetHomeDataPlexErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetHomeDataPlexErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetHomeDataPlexErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/gethomedataunauthorized.md
Normal file
18
docs/sdk/models/errors/gethomedataunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetHomeDataUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetHomeDataUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetHomeDataPlexErrors](../../../sdk/models/errors/gethomedataplexerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetLibraryDetailsResponseBody
|
||||
# GetLibraryDetailsBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryDetailsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetLibraryDetailsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { GetLibraryDetailsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetLibraryDetailsErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/getlibrarydetailslibraryerrors.md
Normal file
21
docs/sdk/models/errors/getlibrarydetailslibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetLibraryDetailsLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryDetailsLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetLibraryDetailsLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/getlibrarydetailsunauthorized.md
Normal file
18
docs/sdk/models/errors/getlibrarydetailsunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetLibraryDetailsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryDetailsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetLibraryDetailsLibraryErrors](../../../sdk/models/errors/getlibrarydetailslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetLibraryHubsResponseBody
|
||||
# GetLibraryHubsBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryHubsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetLibraryHubsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { GetLibraryHubsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetLibraryHubsErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/getlibraryhubshubserrors.md
Normal file
21
docs/sdk/models/errors/getlibraryhubshubserrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetLibraryHubsHubsErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryHubsHubsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetLibraryHubsHubsErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/getlibraryhubsunauthorized.md
Normal file
18
docs/sdk/models/errors/getlibraryhubsunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetLibraryHubsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryHubsUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetLibraryHubsHubsErrors](../../../sdk/models/errors/getlibraryhubshubserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetLibraryItemsResponseBody
|
||||
# GetLibraryItemsBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryItemsResponseBody } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetLibraryItemsBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -6,16 +6,16 @@
|
||||
import { GetLibraryItemsErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetLibraryItemsErrors = {
|
||||
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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/getlibraryitemslibraryerrors.md
Normal file
21
docs/sdk/models/errors/getlibraryitemslibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetLibraryItemsLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryItemsLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetLibraryItemsLibraryErrors = {
|
||||
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 |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user