mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-07 12:37:45 +00:00
Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
f0b08b9bd9 | ||
|
|
244adab882 | ||
|
|
4d8ee6c199 | ||
|
|
4fe1356250 |
30
.github/workflows/sdk_generation.yaml
vendored
Normal file
30
.github/workflows/sdk_generation.yaml
vendored
Normal file
@@ -0,0 +1,30 @@
|
||||
name: Generate
|
||||
permissions:
|
||||
checks: write
|
||||
contents: write
|
||||
pull-requests: write
|
||||
statuses: write
|
||||
"on":
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
force:
|
||||
description: Force generation of SDKs
|
||||
type: boolean
|
||||
default: false
|
||||
set_version:
|
||||
description: optionally set a specific SDK version
|
||||
type: string
|
||||
schedule:
|
||||
- cron: 0 0 * * *
|
||||
jobs:
|
||||
generate:
|
||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
||||
with:
|
||||
force: ${{ github.event.inputs.force }}
|
||||
mode: direct
|
||||
set_version: ${{ github.event.inputs.set_version }}
|
||||
speakeasy_version: latest
|
||||
secrets:
|
||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
npm_token: ${{ secrets.NPM_TOKEN }}
|
||||
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||
31
.github/workflows/speakeasy_sdk_generation.yml
vendored
31
.github/workflows/speakeasy_sdk_generation.yml
vendored
@@ -1,31 +0,0 @@
|
||||
name: Generate
|
||||
permissions:
|
||||
checks: write
|
||||
contents: write
|
||||
pull-requests: write
|
||||
statuses: write
|
||||
"on":
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
force:
|
||||
description: Force generation of SDKs
|
||||
type: boolean
|
||||
default: false
|
||||
push_code_samples_only:
|
||||
description: Force push only code samples from SDK generation
|
||||
type: boolean
|
||||
default: false
|
||||
schedule:
|
||||
- cron: 0 0 * * *
|
||||
jobs:
|
||||
generate:
|
||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
||||
with:
|
||||
force: ${{ github.event.inputs.force }}
|
||||
mode: direct
|
||||
push_code_samples_only: ${{ fromJSON(github.event.inputs.push_code_samples_only) }}
|
||||
speakeasy_version: latest
|
||||
secrets:
|
||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
npm_token: ${{ secrets.NPM_TOKEN }}
|
||||
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||
20
.github/workflows/tagging.yaml
vendored
20
.github/workflows/tagging.yaml
vendored
@@ -1,20 +0,0 @@
|
||||
name: Speakeasy Tagging
|
||||
permissions:
|
||||
checks: write
|
||||
contents: write
|
||||
pull-requests: write
|
||||
statuses: write
|
||||
"on":
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths: []
|
||||
workflow_dispatch: {}
|
||||
jobs:
|
||||
tag:
|
||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/tag.yaml@v15
|
||||
with:
|
||||
registry_tags: main
|
||||
secrets:
|
||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -1,3 +1,6 @@
|
||||
/sdk/models/errors
|
||||
/sdk/types
|
||||
/__tests__
|
||||
/funcs
|
||||
/core.*
|
||||
/esm
|
||||
|
||||
@@ -7,3 +7,4 @@
|
||||
/cjs
|
||||
/.tshy
|
||||
/.tshy-*
|
||||
/__tests__
|
||||
|
||||
2327
.speakeasy/gen.lock
2327
.speakeasy/gen.lock
File diff suppressed because it is too large
Load Diff
@@ -12,7 +12,7 @@ generation:
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
typescript:
|
||||
version: 0.19.0
|
||||
version: 0.20.2
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies: {}
|
||||
@@ -25,11 +25,11 @@ typescript:
|
||||
imports:
|
||||
option: openapi
|
||||
paths:
|
||||
callbacks: ""
|
||||
errors: ""
|
||||
operations: ""
|
||||
shared: ""
|
||||
webhooks: ""
|
||||
callbacks: sdk/models/callbacks
|
||||
errors: sdk/models/errors
|
||||
operations: sdk/models/operations
|
||||
shared: sdk/models/shared
|
||||
webhooks: sdk/models/webhooks
|
||||
inputModelSuffix: input
|
||||
maxMethodParams: 4
|
||||
methodArguments: require-security-and-request
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
speakeasyVersion: 1.377.1
|
||||
speakeasyVersion: 1.392.1
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
sourceRevisionDigest: sha256:4e103669d4bcf7c698608fa37524f3d644510de45959c5437c21b60b2fb2dd9f
|
||||
sourceBlobDigest: sha256:3cb937b6d66508640fa6080fa4c16ebef73a438fbb21a1f8833d6dd2e8fcd5ee
|
||||
sourceRevisionDigest: sha256:facfe37caadd8c575513e97dbc389d0e4d7166c5310c891edb352e65da942367
|
||||
sourceBlobDigest: sha256:f816f80e55e2eeb2a0c30bfb6bfe919f0a1a7284e996cec3a680aa661d39e3c6
|
||||
tags:
|
||||
- latest
|
||||
- main
|
||||
@@ -11,10 +11,10 @@ targets:
|
||||
plexjs:
|
||||
source: my-source
|
||||
sourceNamespace: my-source
|
||||
sourceRevisionDigest: sha256:4e103669d4bcf7c698608fa37524f3d644510de45959c5437c21b60b2fb2dd9f
|
||||
sourceBlobDigest: sha256:3cb937b6d66508640fa6080fa4c16ebef73a438fbb21a1f8833d6dd2e8fcd5ee
|
||||
sourceRevisionDigest: sha256:facfe37caadd8c575513e97dbc389d0e4d7166c5310c891edb352e65da942367
|
||||
sourceBlobDigest: sha256:f816f80e55e2eeb2a0c30bfb6bfe919f0a1a7284e996cec3a680aa661d39e3c6
|
||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||
codeSamplesRevisionDigest: sha256:439dcb28ca6dc855201641d70fc56ac3a6685187d824eb3077145b6a5be15b8b
|
||||
codeSamplesRevisionDigest: sha256:7b7fc9efdcfb2e57e099c7a3da0c064c908a9862cec1a419d9785af091277b8c
|
||||
outLocation: /github/workspace/repo
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
@@ -22,16 +22,14 @@ workflow:
|
||||
sources:
|
||||
my-source:
|
||||
inputs:
|
||||
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/my-source
|
||||
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main
|
||||
targets:
|
||||
plexjs:
|
||||
target: typescript
|
||||
source: my-source
|
||||
publish:
|
||||
npm:
|
||||
token: $NPM_TOKEN
|
||||
token: $npm_token
|
||||
codeSamples:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
|
||||
@@ -3,16 +3,14 @@ speakeasyVersion: latest
|
||||
sources:
|
||||
my-source:
|
||||
inputs:
|
||||
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/my-source
|
||||
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main
|
||||
targets:
|
||||
plexjs:
|
||||
target: typescript
|
||||
source: my-source
|
||||
publish:
|
||||
npm:
|
||||
token: $NPM_TOKEN
|
||||
token: $npm_token
|
||||
codeSamples:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
|
||||
@@ -21,13 +21,13 @@ specific category of applications.
|
||||
```typescript
|
||||
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
|
||||
import { serverGetServerCapabilities } from "@lukehagar/plexjs/funcs/serverGetServerCapabilities.js";
|
||||
import { SDKValidationError } from "@lukehagar/plexjs/models/sdkvalidationerror.js";
|
||||
import { SDKValidationError } from "@lukehagar/plexjs/sdk/models/errors/sdkvalidationerror.js";
|
||||
|
||||
// Use `PlexAPICore` for best tree-shaking performance.
|
||||
// You can create one instance of it to use across an application.
|
||||
const plexAPI = new PlexAPICore({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
166
README.md
166
README.md
@@ -7,9 +7,34 @@
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<!-- Start Summary [summary] -->
|
||||
## Summary
|
||||
|
||||
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
||||
<!-- End Summary [summary] -->
|
||||
|
||||
<!-- Start Table of Contents [toc] -->
|
||||
## Table of Contents
|
||||
|
||||
* [SDK Installation](#sdk-installation)
|
||||
* [Requirements](#requirements)
|
||||
* [SDK Example Usage](#sdk-example-usage)
|
||||
* [Available Resources and Operations](#available-resources-and-operations)
|
||||
* [Standalone functions](#standalone-functions)
|
||||
* [Global Parameters](#global-parameters)
|
||||
* [Retries](#retries)
|
||||
* [Error Handling](#error-handling)
|
||||
* [Server Selection](#server-selection)
|
||||
* [Custom HTTP Client](#custom-http-client)
|
||||
* [Authentication](#authentication)
|
||||
* [Debugging](#debugging)
|
||||
<!-- End Table of Contents [toc] -->
|
||||
|
||||
<!-- Start SDK Installation [installation] -->
|
||||
## SDK Installation
|
||||
|
||||
The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
|
||||
|
||||
### NPM
|
||||
|
||||
```bash
|
||||
@@ -48,7 +73,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -75,6 +100,7 @@ run();
|
||||
* [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)
|
||||
@@ -82,6 +108,8 @@ run();
|
||||
* [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)
|
||||
|
||||
@@ -107,10 +135,9 @@ run();
|
||||
* [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
|
||||
* [getResources](docs/sdks/plex/README.md#getresources) - Get Resources
|
||||
* [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
|
||||
* [getUserDetails](docs/sdks/plex/README.md#getuserdetails) - Get UserData By Token
|
||||
|
||||
### [hubs](docs/sdks/hubs/README.md)
|
||||
|
||||
@@ -127,17 +154,21 @@ run();
|
||||
|
||||
* [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||
* [getRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded) - Get Recently Added
|
||||
* [getLibraries](docs/sdks/library/README.md#getlibraries) - Get All Libraries
|
||||
* [getLibrary](docs/sdks/library/README.md#getlibrary) - Get Library Details
|
||||
* [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
||||
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||
* [refreshLibrary](docs/sdks/library/README.md#refreshlibrary) - Refresh Library
|
||||
* [searchLibrary](docs/sdks/library/README.md#searchlibrary) - Search Library
|
||||
* [getMetadata](docs/sdks/library/README.md#getmetadata) - Get Items Metadata
|
||||
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||
|
||||
### [watchlist](docs/sdks/watchlist/README.md)
|
||||
|
||||
* [getWatchList](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
|
||||
|
||||
### [log](docs/sdks/log/README.md)
|
||||
|
||||
* [logLine](docs/sdks/log/README.md#logline) - Logging a single line message.
|
||||
@@ -160,6 +191,8 @@ run();
|
||||
|
||||
* [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
|
||||
|
||||
### [statistics](docs/sdks/statistics/README.md)
|
||||
|
||||
@@ -179,14 +212,6 @@ run();
|
||||
* [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
|
||||
|
||||
### [user](docs/sdks/user/README.md)
|
||||
|
||||
* [postUsersSigninData](docs/sdks/user/README.md#postuserssignindata) - Get User SignIn Data
|
||||
|
||||
### [watchlist](docs/sdks/watchlist/README.md)
|
||||
|
||||
* [getWatchlist](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
|
||||
<!-- End Available Resources and Operations [operations] -->
|
||||
|
||||
<!-- Start Error Handling [errors] -->
|
||||
@@ -195,26 +220,32 @@ run();
|
||||
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| models.GetServerCapabilitiesServerResponseBody | 401 | application/json |
|
||||
| models.SDKError | 4xx-5xx | */* |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| errors.GetServerCapabilitiesResponseBody | 401 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
|
||||
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { SDKValidationError } from "@lukehagar/plexjs/models";
|
||||
import {
|
||||
GetServerCapabilitiesResponseBody,
|
||||
SDKValidationError,
|
||||
} from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
let result;
|
||||
try {
|
||||
result = await plexAPI.server.getServerCapabilities();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
} catch (err) {
|
||||
switch (true) {
|
||||
case err instanceof SDKValidationError: {
|
||||
@@ -224,8 +255,9 @@ async function run() {
|
||||
console.error(err.rawValue);
|
||||
return;
|
||||
}
|
||||
case err instanceof models.GetServerCapabilitiesServerResponseBody: {
|
||||
console.error(err); // handle exception
|
||||
case err instanceof GetServerCapabilitiesResponseBody: {
|
||||
// Handle err.data$: GetServerCapabilitiesResponseBodyData
|
||||
console.error(err);
|
||||
return;
|
||||
}
|
||||
default: {
|
||||
@@ -233,9 +265,6 @@ async function run() {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
@@ -252,7 +281,7 @@ You can override the default server globally by passing a server index to the `s
|
||||
|
||||
| # | Server | Variables |
|
||||
| - | ------ | --------- |
|
||||
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `http`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
||||
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `https`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -260,7 +289,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
const plexAPI = new PlexAPI({
|
||||
serverIdx: 0,
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -291,7 +320,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
const plexAPI = new PlexAPI({
|
||||
serverURL: "{protocol}://{ip}:{port}",
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -313,12 +342,12 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.plex.getCompanionsData({
|
||||
serverURL: "https://plex.tv/api/v2",
|
||||
serverURL: "https://plex.tv/api/v2/",
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
@@ -396,7 +425,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -436,6 +465,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
- [activitiesGetServerActivities](docs/sdks/activities/README.md#getserveractivities)
|
||||
- [authenticationGetSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation)
|
||||
- [authenticationGetTransientToken](docs/sdks/authentication/README.md#gettransienttoken)
|
||||
- [authenticationGetUserDetails](docs/sdks/authentication/README.md#getuserdetails)
|
||||
- [authenticationPostUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata)
|
||||
- [butlerGetButlerTasks](docs/sdks/butler/README.md#getbutlertasks)
|
||||
- [butlerStartAllTasks](docs/sdks/butler/README.md#startalltasks)
|
||||
- [butlerStartTask](docs/sdks/butler/README.md#starttask)
|
||||
@@ -444,20 +475,22 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
- [hubsGetGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs)
|
||||
- [hubsGetLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs)
|
||||
- [libraryDeleteLibrary](docs/sdks/library/README.md#deletelibrary)
|
||||
- [libraryGetAllLibraries](docs/sdks/library/README.md#getalllibraries)
|
||||
- [libraryGetFileHash](docs/sdks/library/README.md#getfilehash)
|
||||
- [libraryGetLibraries](docs/sdks/library/README.md#getlibraries)
|
||||
- [libraryGetLibraryDetails](docs/sdks/library/README.md#getlibrarydetails)
|
||||
- [libraryGetLibraryItems](docs/sdks/library/README.md#getlibraryitems)
|
||||
- [libraryGetLibrary](docs/sdks/library/README.md#getlibrary)
|
||||
- [libraryGetMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey)
|
||||
- [libraryGetMetadataChildren](docs/sdks/library/README.md#getmetadatachildren)
|
||||
- [libraryGetMetadata](docs/sdks/library/README.md#getmetadata)
|
||||
- [libraryGetOnDeck](docs/sdks/library/README.md#getondeck)
|
||||
- [libraryGetRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded)
|
||||
- [libraryGetRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata)
|
||||
- [libraryGetSearchLibrary](docs/sdks/library/README.md#getsearchlibrary)
|
||||
- [libraryGetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent)
|
||||
- [libraryRefreshLibrary](docs/sdks/library/README.md#refreshlibrary)
|
||||
- [librarySearchLibrary](docs/sdks/library/README.md#searchlibrary)
|
||||
- [logEnablePaperTrail](docs/sdks/log/README.md#enablepapertrail)
|
||||
- [logLogLine](docs/sdks/log/README.md#logline)
|
||||
- [logLogMultiLine](docs/sdks/log/README.md#logmultiline)
|
||||
- [mediaGetBannerImage](docs/sdks/media/README.md#getbannerimage)
|
||||
- [mediaGetThumbImage](docs/sdks/media/README.md#getthumbimage)
|
||||
- [mediaMarkPlayed](docs/sdks/media/README.md#markplayed)
|
||||
- [mediaMarkUnplayed](docs/sdks/media/README.md#markunplayed)
|
||||
- [mediaUpdatePlayProgress](docs/sdks/media/README.md#updateplayprogress)
|
||||
@@ -474,15 +507,15 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
- [plexGetGeoData](docs/sdks/plex/README.md#getgeodata)
|
||||
- [plexGetHomeData](docs/sdks/plex/README.md#gethomedata)
|
||||
- [plexGetPin](docs/sdks/plex/README.md#getpin)
|
||||
- [plexGetResources](docs/sdks/plex/README.md#getresources)
|
||||
- [plexGetServerResources](docs/sdks/plex/README.md#getserverresources)
|
||||
- [plexGetTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid)
|
||||
- [plexGetUserDetails](docs/sdks/plex/README.md#getuserdetails)
|
||||
- [plexGetUserFriends](docs/sdks/plex/README.md#getuserfriends)
|
||||
- [searchGetSearchResults](docs/sdks/search/README.md#getsearchresults)
|
||||
- [searchPerformSearch](docs/sdks/search/README.md#performsearch)
|
||||
- [searchPerformVoiceSearch](docs/sdks/search/README.md#performvoicesearch)
|
||||
- [serverGetAvailableClients](docs/sdks/server/README.md#getavailableclients)
|
||||
- [serverGetDevices](docs/sdks/server/README.md#getdevices)
|
||||
- [serverGetMediaProviders](docs/sdks/server/README.md#getmediaproviders)
|
||||
- [serverGetMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount)
|
||||
- [serverGetResizedPhoto](docs/sdks/server/README.md#getresizedphoto)
|
||||
- [serverGetServerCapabilities](docs/sdks/server/README.md#getservercapabilities)
|
||||
@@ -499,15 +532,62 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
- [updaterApplyUpdates](docs/sdks/updater/README.md#applyupdates)
|
||||
- [updaterCheckForUpdates](docs/sdks/updater/README.md#checkforupdates)
|
||||
- [updaterGetUpdateStatus](docs/sdks/updater/README.md#getupdatestatus)
|
||||
- [userPostUsersSigninData](docs/sdks/user/README.md#postuserssignindata)
|
||||
- [videoGetTimeline](docs/sdks/video/README.md#gettimeline)
|
||||
- [videoStartUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode)
|
||||
- [watchlistGetWatchlist](docs/sdks/watchlist/README.md#getwatchlist)
|
||||
- [watchlistGetWatchList](docs/sdks/watchlist/README.md#getwatchlist)
|
||||
|
||||
|
||||
</details>
|
||||
<!-- End Standalone functions [standalone-funcs] -->
|
||||
|
||||
<!-- Start Global Parameters [global-parameters] -->
|
||||
## Global Parameters
|
||||
|
||||
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
|
||||
|
||||
For example, you can set `X-Plex-Client-Identifier` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getServerResources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
||||
|
||||
|
||||
### Available Globals
|
||||
|
||||
The following global parameter is available.
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
| ---- | ---- |:--------:| ----------- |
|
||||
| xPlexClientIdentifier | string | | The unique identifier for the client application
|
||||
This is used to track the client application and its usage
|
||||
(UUID, serial number, or other number unique per device)
|
||||
|
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { IncludeHttps, IncludeIPv6, IncludeRelay } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.plex.getServerResources({
|
||||
xPlexToken: "CV5xoxjTpFKUzBTShsaf",
|
||||
includeHttps: IncludeHttps.One,
|
||||
includeRelay: IncludeRelay.One,
|
||||
includeIPv6: IncludeIPv6.One,
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End Global Parameters [global-parameters] -->
|
||||
|
||||
<!-- Start Retries [retries] -->
|
||||
## Retries
|
||||
|
||||
@@ -519,7 +599,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -560,7 +640,7 @@ const plexAPI = new PlexAPI({
|
||||
retryConnectionErrors: false,
|
||||
},
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
20
RELEASES.md
20
RELEASES.md
@@ -939,3 +939,23 @@ Based on:
|
||||
- [typescript v0.19.0] .
|
||||
### Releases
|
||||
- [NPM v0.19.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.19.0 - .
|
||||
|
||||
## 2024-09-06 00:01:07
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.390.7 (2.409.8) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.20.0] .
|
||||
### Releases
|
||||
- [NPM v0.20.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.20.0 - .
|
||||
|
||||
## 2024-09-08 03:21:12
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.392.1 (2.411.9) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.20.2] .
|
||||
### Releases
|
||||
- [NPM v0.20.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.20.2 - .
|
||||
2
USAGE.md
2
USAGE.md
@@ -4,7 +4,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
1891
codeSamples.yaml
1891
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
@@ -1,22 +0,0 @@
|
||||
# Activity
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Activity } from "@lukehagar/plexjs";
|
||||
|
||||
let value: Activity = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `cancellable` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `userID` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `subtitle` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `progress` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `context` | [models.Context](../models/context.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,39 +0,0 @@
|
||||
# AddPlaylistContentsMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddPlaylistContentsMediaContainer } from "@lukehagar/plexjs";
|
||||
|
||||
let value: AddPlaylistContentsMediaContainer = {
|
||||
size: 1,
|
||||
leafCountAdded: 1,
|
||||
leafCountRequested: 1,
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "94",
|
||||
key: "/playlists/94/items",
|
||||
guid: "com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2",
|
||||
type: "playlist",
|
||||
title: "A great playlist",
|
||||
summary: "One of my great playlists",
|
||||
smart: false,
|
||||
playlistType: "video",
|
||||
composite: "/playlists/94/composite/1705800070",
|
||||
duration: 423000,
|
||||
leafCount: 3,
|
||||
addedAt: 1705716458,
|
||||
updatedAt: 1705800070,
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `leafCountAdded` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `leafCountRequested` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `metadata` | [models.AddPlaylistContentsMetadata](../models/addplaylistcontentsmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,18 +0,0 @@
|
||||
# AddPlaylistContentsPlaylistsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddPlaylistContentsPlaylistsResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `errors` | [models.AddPlaylistContentsErrors](../models/addplaylistcontentserrors.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,48 +0,0 @@
|
||||
# AddPlaylistContentsResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AddPlaylistContentsResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: AddPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 161309,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 1,
|
||||
leafCountAdded: 1,
|
||||
leafCountRequested: 1,
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "94",
|
||||
key: "/playlists/94/items",
|
||||
guid: "com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2",
|
||||
type: "playlist",
|
||||
title: "A great playlist",
|
||||
summary: "One of my great playlists",
|
||||
smart: false,
|
||||
playlistType: "video",
|
||||
composite: "/playlists/94/composite/1705800070",
|
||||
duration: 423000,
|
||||
leafCount: 3,
|
||||
addedAt: 1705716458,
|
||||
updatedAt: 1705800070,
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [models.AddPlaylistContentsResponseBody](../models/addplaylistcontentsresponsebody.md) | :heavy_minus_sign: | Playlist Updated |
|
||||
@@ -1,18 +0,0 @@
|
||||
# ApplyUpdatesResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ApplyUpdatesResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.ApplyUpdatesErrors](../models/applyupdateserrors.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,19 +0,0 @@
|
||||
# Billing
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Billing } from "@lukehagar/plexjs";
|
||||
|
||||
let value: Billing = {
|
||||
internalPaymentMethod: {},
|
||||
paymentMethodId: 368725,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||
| `internalPaymentMethod` | [models.InternalPaymentMethod](../models/internalpaymentmethod.md) | :heavy_check_mark: | N/A |
|
||||
| `paymentMethodId` | *number* | :heavy_check_mark: | N/A |
|
||||
@@ -1,25 +0,0 @@
|
||||
# ButlerTasks
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ButlerTasks } from "@lukehagar/plexjs";
|
||||
|
||||
let value: ButlerTasks = {
|
||||
butlerTask: [
|
||||
{
|
||||
name: "BackupDatabase",
|
||||
interval: 3,
|
||||
title: "Backup Database",
|
||||
description:
|
||||
"Create a backup copy of the server's database in the configured backup directory",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| `butlerTask` | [models.ButlerTask](../models/butlertask.md)[] | :heavy_minus_sign: | N/A |
|
||||
@@ -1,18 +0,0 @@
|
||||
# CancelServerActivitiesResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CancelServerActivitiesResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `errors` | [models.CancelServerActivitiesErrors](../models/cancelserveractivitieserrors.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,17 +0,0 @@
|
||||
# CheckForUpdatesRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CheckForUpdatesRequest, Download } from "@lukehagar/plexjs";
|
||||
|
||||
let value: CheckForUpdatesRequest = {
|
||||
download: Download.One,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| `download` | [models.Download](../models/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |
|
||||
@@ -1,18 +0,0 @@
|
||||
# CheckForUpdatesResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CheckForUpdatesResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.CheckForUpdatesErrors](../models/checkforupdateserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,18 +0,0 @@
|
||||
# ClearPlaylistContentsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ClearPlaylistContentsResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| `errors` | [models.ClearPlaylistContentsErrors](../models/clearplaylistcontentserrors.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,21 +0,0 @@
|
||||
# Connections
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Connections } from "@lukehagar/plexjs";
|
||||
|
||||
let value: Connections = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `protocol` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `address` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `port` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `uri` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `local` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `relay` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `iPv6` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
@@ -1,38 +0,0 @@
|
||||
# CreatePlaylistMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePlaylistMediaContainer } from "@lukehagar/plexjs";
|
||||
|
||||
let value: CreatePlaylistMediaContainer = {
|
||||
size: 7,
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "96",
|
||||
key: "/playlists/96/items",
|
||||
guid: "com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55",
|
||||
type: "playlist",
|
||||
title: "A Great Playlist",
|
||||
summary: "What a great playlist",
|
||||
smart: false,
|
||||
playlistType: "video",
|
||||
icon: "playlist://image.smart",
|
||||
viewCount: 1,
|
||||
lastViewedAt: 1705719589,
|
||||
leafCount: 1,
|
||||
addedAt: 1705719589,
|
||||
updatedAt: 1705724593,
|
||||
composite: "/playlists/96/composite/1705724593",
|
||||
duration: 141000,
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 7 |
|
||||
| `metadata` | [models.CreatePlaylistMetadata](../models/createplaylistmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,18 +0,0 @@
|
||||
# CreatePlaylistPlaylistsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePlaylistPlaylistsResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.CreatePlaylistErrors](../models/createplaylisterrors.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,24 +0,0 @@
|
||||
# CreatePlaylistRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePlaylistRequest, QueryParamType, Smart } from "@lukehagar/plexjs";
|
||||
|
||||
let value: CreatePlaylistRequest = {
|
||||
title: "<value>",
|
||||
type: QueryParamType.Photo,
|
||||
smart: Smart.One,
|
||||
uri: "https://deadly-corsage.info",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
||||
| `title` | *string* | :heavy_check_mark: | name of the playlist |
|
||||
| `type` | [models.QueryParamType](../models/queryparamtype.md) | :heavy_check_mark: | type of playlist to create |
|
||||
| `smart` | [models.Smart](../models/smart.md) | :heavy_check_mark: | whether the playlist is smart or not |
|
||||
| `uri` | *string* | :heavy_check_mark: | the content URI for the playlist |
|
||||
| `playQueueID` | *number* | :heavy_minus_sign: | the play queue to copy to a playlist |
|
||||
@@ -1,49 +0,0 @@
|
||||
# CreatePlaylistResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePlaylistResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: CreatePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 128926,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 7,
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "96",
|
||||
key: "/playlists/96/items",
|
||||
guid: "com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55",
|
||||
type: "playlist",
|
||||
title: "A Great Playlist",
|
||||
summary: "What a great playlist",
|
||||
smart: false,
|
||||
playlistType: "video",
|
||||
icon: "playlist://image.smart",
|
||||
viewCount: 1,
|
||||
lastViewedAt: 1705719589,
|
||||
leafCount: 1,
|
||||
addedAt: 1705719589,
|
||||
updatedAt: 1705724593,
|
||||
composite: "/playlists/96/composite/1705724593",
|
||||
duration: 141000,
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [models.CreatePlaylistResponseBody](../models/createplaylistresponsebody.md) | :heavy_minus_sign: | returns all playlists |
|
||||
@@ -1,17 +0,0 @@
|
||||
# DeleteLibraryRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteLibraryRequest } from "@lukehagar/plexjs";
|
||||
|
||||
let value: DeleteLibraryRequest = {
|
||||
sectionId: 1000,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||
| `sectionId` | *number* | :heavy_check_mark: | the Id of the library to query | 1000 |
|
||||
@@ -1,18 +0,0 @@
|
||||
# DeletePlaylistResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeletePlaylistResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.DeletePlaylistErrors](../models/deleteplaylisterrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,18 +0,0 @@
|
||||
# EnablePaperTrailResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { EnablePaperTrailResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| `errors` | [models.EnablePaperTrailErrors](../models/enablepapertrailerrors.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,24 +0,0 @@
|
||||
# FieldType
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { FieldType } from "@lukehagar/plexjs";
|
||||
|
||||
let value: FieldType = {
|
||||
type: "resolution",
|
||||
operator: [
|
||||
{
|
||||
key: "=",
|
||||
title: "is",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | resolution |
|
||||
| `operator` | [models.Operator](../models/operator.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,39 +0,0 @@
|
||||
# Friend
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Friend, Status } from "@lukehagar/plexjs";
|
||||
|
||||
let value: Friend = {
|
||||
email: "username@email.com",
|
||||
friendlyName: "exampleUser",
|
||||
home: true,
|
||||
id: 0,
|
||||
restricted: false,
|
||||
sharedServers: [{}],
|
||||
sharedSources: [{}],
|
||||
status: Status.Accepted,
|
||||
thumb: "https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578",
|
||||
title: "username123",
|
||||
username: "username123",
|
||||
uuid: "7d1916e0d8f6e76b",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| `email` | *string* | :heavy_check_mark: | The account email address | username@email.com |
|
||||
| `friendlyName` | *string* | :heavy_check_mark: | The account full name | exampleUser |
|
||||
| `home` | *boolean* | :heavy_check_mark: | If the account is a Plex Home user | |
|
||||
| `id` | *number* | :heavy_check_mark: | The Plex account ID | |
|
||||
| `restricted` | *boolean* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
|
||||
| `sharedServers` | [models.SharedServers](../models/sharedservers.md)[] | :heavy_check_mark: | N/A | |
|
||||
| `sharedSources` | [models.SharedSources](../models/sharedsources.md)[] | :heavy_check_mark: | N/A | |
|
||||
| `status` | [models.Status](../models/status.md) | :heavy_check_mark: | Current friend request status | accepted |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578 |
|
||||
| `title` | *string* | :heavy_check_mark: | The title of the account (username or friendly name) | username123 |
|
||||
| `username` | *string* | :heavy_check_mark: | The account username | username123 |
|
||||
| `uuid` | *string* | :heavy_check_mark: | The account Universally Unique Identifier (UUID) | 7d1916e0d8f6e76b |
|
||||
@@ -1,33 +0,0 @@
|
||||
# GetAvailableClientsMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAvailableClientsMediaContainer } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetAvailableClientsMediaContainer = {
|
||||
size: 1,
|
||||
server: [
|
||||
{
|
||||
name: "iPad",
|
||||
host: "10.10.10.102",
|
||||
address: "10.10.10.102",
|
||||
port: 32500,
|
||||
machineIdentifier: "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05",
|
||||
version: "8.17",
|
||||
protocol: "plex",
|
||||
product: "Plex for iOS",
|
||||
deviceClass: "tablet",
|
||||
protocolVersion: 2,
|
||||
protocolCapabilities: "playback,playqueues,timeline,provider-playback",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `server` | [models.GetAvailableClientsServer](../models/getavailableclientsserver.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,44 +0,0 @@
|
||||
# GetAvailableClientsResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAvailableClientsResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetAvailableClientsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 715190,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 1,
|
||||
server: [
|
||||
{
|
||||
name: "iPad",
|
||||
host: "10.10.10.102",
|
||||
address: "10.10.10.102",
|
||||
port: 32500,
|
||||
machineIdentifier: "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05",
|
||||
version: "8.17",
|
||||
protocol: "plex",
|
||||
product: "Plex for iOS",
|
||||
deviceClass: "tablet",
|
||||
protocolVersion: 2,
|
||||
protocolCapabilities: "playback,playqueues,timeline,provider-playback",
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [models.GetAvailableClientsResponseBody](../models/getavailableclientsresponsebody.md) | :heavy_minus_sign: | Available Clients |
|
||||
@@ -1,36 +0,0 @@
|
||||
# GetAvailableClientsResponseBody
|
||||
|
||||
Available Clients
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAvailableClientsResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetAvailableClientsResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 1,
|
||||
server: [
|
||||
{
|
||||
name: "iPad",
|
||||
host: "10.10.10.102",
|
||||
address: "10.10.10.102",
|
||||
port: 32500,
|
||||
machineIdentifier: "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05",
|
||||
version: "8.17",
|
||||
protocol: "plex",
|
||||
product: "Plex for iOS",
|
||||
deviceClass: "tablet",
|
||||
protocolVersion: 2,
|
||||
protocolCapabilities: "playback,playqueues,timeline,provider-playback",
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `mediaContainer` | [models.GetAvailableClientsMediaContainer](../models/getavailableclientsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetAvailableClientsServerResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAvailableClientsServerResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetAvailableClientsErrors](../models/getavailableclientserrors.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,50 +0,0 @@
|
||||
# GetBandwidthStatisticsMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetBandwidthStatisticsMediaContainer } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetBandwidthStatisticsMediaContainer = {
|
||||
size: 5497,
|
||||
device: [
|
||||
{
|
||||
id: 208,
|
||||
name: "Roku Express",
|
||||
platform: "Roku",
|
||||
clientIdentifier: "793095d235660625108ef785cc7646e9",
|
||||
createdAt: 1706470556,
|
||||
},
|
||||
],
|
||||
account: [
|
||||
{
|
||||
id: 238960586,
|
||||
key: "/accounts/238960586",
|
||||
name: "Diane",
|
||||
defaultAudioLanguage: "en",
|
||||
autoSelectAudio: true,
|
||||
defaultSubtitleLanguage: "en",
|
||||
subtitleMode: 1,
|
||||
thumb: "https://plex.tv/users/50d83634246da1de/avatar?c=1707110967",
|
||||
},
|
||||
],
|
||||
statisticsBandwidth: [
|
||||
{
|
||||
accountID: 238960586,
|
||||
timespan: 6,
|
||||
at: 1718387650,
|
||||
lan: true,
|
||||
bytes: 22,
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 5497 |
|
||||
| `device` | [models.GetBandwidthStatisticsDevice](../models/getbandwidthstatisticsdevice.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `account` | [models.GetBandwidthStatisticsAccount](../models/getbandwidthstatisticsaccount.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `statisticsBandwidth` | [models.StatisticsBandwidth](../models/statisticsbandwidth.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,59 +0,0 @@
|
||||
# GetBandwidthStatisticsResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetBandwidthStatisticsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 623510,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 5497,
|
||||
device: [
|
||||
{
|
||||
id: 208,
|
||||
name: "Roku Express",
|
||||
platform: "Roku",
|
||||
clientIdentifier: "793095d235660625108ef785cc7646e9",
|
||||
createdAt: 1706470556,
|
||||
},
|
||||
],
|
||||
account: [
|
||||
{
|
||||
id: 238960586,
|
||||
key: "/accounts/238960586",
|
||||
name: "Diane",
|
||||
defaultAudioLanguage: "en",
|
||||
autoSelectAudio: true,
|
||||
defaultSubtitleLanguage: "en",
|
||||
subtitleMode: 1,
|
||||
thumb: "https://plex.tv/users/50d83634246da1de/avatar?c=1707110967",
|
||||
},
|
||||
],
|
||||
statisticsBandwidth: [
|
||||
{
|
||||
accountID: 238960586,
|
||||
timespan: 6,
|
||||
at: 1718387650,
|
||||
lan: true,
|
||||
bytes: 22,
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [models.GetBandwidthStatisticsResponseBody](../models/getbandwidthstatisticsresponsebody.md) | :heavy_minus_sign: | Bandwidth Statistics |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetBandwidthStatisticsStatisticsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetBandwidthStatisticsStatisticsResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetBandwidthStatisticsErrors](../models/getbandwidthstatisticserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetButlerTasksButlerResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetButlerTasksButlerResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetButlerTasksErrors](../models/getbutlertaskserrors.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,37 +0,0 @@
|
||||
# GetButlerTasksResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetButlerTasksResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetButlerTasksResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 791725,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
butlerTasks: {
|
||||
butlerTask: [
|
||||
{
|
||||
name: "BackupDatabase",
|
||||
interval: 3,
|
||||
title: "Backup Database",
|
||||
description:
|
||||
"Create a backup copy of the server's database in the configured backup directory",
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [models.GetButlerTasksResponseBody](../models/getbutlertasksresponsebody.md) | :heavy_minus_sign: | All butler tasks |
|
||||
@@ -1,29 +0,0 @@
|
||||
# GetButlerTasksResponseBody
|
||||
|
||||
All butler tasks
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetButlerTasksResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetButlerTasksResponseBody = {
|
||||
butlerTasks: {
|
||||
butlerTask: [
|
||||
{
|
||||
name: "BackupDatabase",
|
||||
interval: 3,
|
||||
title: "Backup Database",
|
||||
description:
|
||||
"Create a backup copy of the server's database in the configured backup directory",
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| `butlerTasks` | [models.ButlerTasks](../models/butlertasks.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetCompanionsDataResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetCompanionsDataResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
||||
| `errors` | [models.GetCompanionsDataErrors](../models/getcompanionsdataerrors.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,28 +0,0 @@
|
||||
# GetDevicesMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetDevicesMediaContainer } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetDevicesMediaContainer = {
|
||||
size: 151,
|
||||
identifier: "com.plexapp.system.devices",
|
||||
device: [
|
||||
{
|
||||
id: 1,
|
||||
name: "iPhone",
|
||||
platform: "iOS",
|
||||
createdAt: 1654131230,
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 151 |
|
||||
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.system.devices |
|
||||
| `device` | [models.Device](../models/device.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,38 +0,0 @@
|
||||
# GetDevicesResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetDevicesResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetDevicesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 844266,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 151,
|
||||
identifier: "com.plexapp.system.devices",
|
||||
device: [
|
||||
{
|
||||
id: 1,
|
||||
name: "iPhone",
|
||||
platform: "iOS",
|
||||
createdAt: 1654131230,
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [models.GetDevicesResponseBody](../models/getdevicesresponsebody.md) | :heavy_minus_sign: | Devices |
|
||||
@@ -1,30 +0,0 @@
|
||||
# GetDevicesResponseBody
|
||||
|
||||
Devices
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetDevicesResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetDevicesResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 151,
|
||||
identifier: "com.plexapp.system.devices",
|
||||
device: [
|
||||
{
|
||||
id: 1,
|
||||
name: "iPhone",
|
||||
platform: "iOS",
|
||||
createdAt: 1654131230,
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
||||
| `mediaContainer` | [models.GetDevicesMediaContainer](../models/getdevicesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetDevicesServerResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetDevicesServerResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetDevicesErrors](../models/getdeviceserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetFileHashResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetFileHashResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetFileHashErrors](../models/getfilehasherrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetGeoDataResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGeoDataResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetGeoDataErrors](../models/getgeodataerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetGlobalHubsHubsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGlobalHubsHubsResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetGlobalHubsErrors](../models/getglobalhubserrors.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,57 +0,0 @@
|
||||
# GetGlobalHubsMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGlobalHubsMediaContainer } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetGlobalHubsMediaContainer = {
|
||||
size: 8,
|
||||
allowSync: true,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
hub: [
|
||||
{
|
||||
hubKey: "/library/metadata/50768,65523,58188,57341,57302,57070",
|
||||
key: "/playlists/all?type=15&sort=lastViewedAt:desc&playlistType=video,audio",
|
||||
title: "Recent Playlists",
|
||||
type: "playlist",
|
||||
hubIdentifier: "home.playlists",
|
||||
context: "hub.home.playlists",
|
||||
size: 6,
|
||||
more: true,
|
||||
style: "shelf",
|
||||
promoted: true,
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "57070",
|
||||
key: "/playlists/57070/items",
|
||||
guid: "com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c",
|
||||
type: "playlist",
|
||||
title: "November Movie Day",
|
||||
titleSort: "Tracks",
|
||||
summary: "",
|
||||
smart: false,
|
||||
playlistType: "video",
|
||||
composite: "/playlists/57070/composite/1668787730",
|
||||
icon: "playlist://image.smart",
|
||||
viewCount: 2,
|
||||
lastViewedAt: 1668787732,
|
||||
duration: 16873000,
|
||||
leafCount: 3,
|
||||
addedAt: 1668779618,
|
||||
updatedAt: 1668787730,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 8 |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `hub` | [models.Hub](../models/hub.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetHomeDataPlexResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetHomeDataPlexResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetHomeDataErrors](../models/gethomedataerrors.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,30 +0,0 @@
|
||||
# GetHomeDataResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetHomeDataResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetHomeDataResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 20218,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
id: 1841489,
|
||||
name: "Blindkitty38's home",
|
||||
guestUserID: 58815432,
|
||||
guestUserUUID: "f3df4e01bfca0787",
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [models.GetHomeDataResponseBody](../models/gethomedataresponsebody.md) | :heavy_minus_sign: | Home Data |
|
||||
@@ -1,62 +0,0 @@
|
||||
# GetLibrariesDirectory
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibrariesDirectory } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibrariesDirectory = {
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1705615584",
|
||||
filters: true,
|
||||
refreshing: false,
|
||||
thumb: "/:/resources/movie.png",
|
||||
key: "1",
|
||||
type: "movie",
|
||||
title: "Movies",
|
||||
agent: "tv.plex.agents.movie",
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
updatedAt: 1705615634,
|
||||
createdAt: 1654131312,
|
||||
scannedAt: 1705615584,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 3192854,
|
||||
hidden: 0,
|
||||
location: [
|
||||
{
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `composite` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/composite/1705615584 |
|
||||
| `filters` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `refreshing` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `agent` | *string* | :heavy_minus_sign: | N/A | tv.plex.agents.movie |
|
||||
| `scanner` | *string* | :heavy_minus_sign: | N/A | Plex Movie |
|
||||
| `language` | *string* | :heavy_minus_sign: | N/A | en-US |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705615634 |
|
||||
| `createdAt` | *number* | :heavy_minus_sign: | N/A | 1654131312 |
|
||||
| `scannedAt` | *number* | :heavy_minus_sign: | N/A | 1705615584 |
|
||||
| `content` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `directory` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `contentChangedAt` | *number* | :heavy_minus_sign: | N/A | 3192854 |
|
||||
| `hidden` | *number* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `location` | [models.Location](../models/location.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetLibrariesLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibrariesLibraryResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetLibrariesErrors](../models/getlibrarieserrors.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,52 +0,0 @@
|
||||
# GetLibrariesMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibrariesMediaContainer } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibrariesMediaContainer = {
|
||||
size: 5,
|
||||
allowSync: false,
|
||||
title1: "Plex Library",
|
||||
directory: [
|
||||
{
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1705615584",
|
||||
filters: true,
|
||||
refreshing: false,
|
||||
thumb: "/:/resources/movie.png",
|
||||
key: "1",
|
||||
type: "movie",
|
||||
title: "Movies",
|
||||
agent: "tv.plex.agents.movie",
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
updatedAt: 1705615634,
|
||||
createdAt: 1654131312,
|
||||
scannedAt: 1705615584,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 3192854,
|
||||
hidden: 0,
|
||||
location: [
|
||||
{
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 5 |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `title1` | *string* | :heavy_minus_sign: | N/A | Plex Library |
|
||||
| `directory` | [models.GetLibrariesDirectory](../models/getlibrariesdirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,61 +0,0 @@
|
||||
# GetLibrariesResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibrariesResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibrariesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 264555,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 5,
|
||||
allowSync: false,
|
||||
title1: "Plex Library",
|
||||
directory: [
|
||||
{
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1705615584",
|
||||
filters: true,
|
||||
refreshing: false,
|
||||
thumb: "/:/resources/movie.png",
|
||||
key: "1",
|
||||
type: "movie",
|
||||
title: "Movies",
|
||||
agent: "tv.plex.agents.movie",
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
updatedAt: 1705615634,
|
||||
createdAt: 1654131312,
|
||||
scannedAt: 1705615584,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 3192854,
|
||||
hidden: 0,
|
||||
location: [
|
||||
{
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [models.GetLibrariesResponseBody](../models/getlibrariesresponsebody.md) | :heavy_minus_sign: | The libraries available on the Server |
|
||||
@@ -1,53 +0,0 @@
|
||||
# GetLibrariesResponseBody
|
||||
|
||||
The libraries available on the Server
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibrariesResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibrariesResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 5,
|
||||
allowSync: false,
|
||||
title1: "Plex Library",
|
||||
directory: [
|
||||
{
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1705615584",
|
||||
filters: true,
|
||||
refreshing: false,
|
||||
thumb: "/:/resources/movie.png",
|
||||
key: "1",
|
||||
type: "movie",
|
||||
title: "Movies",
|
||||
agent: "tv.plex.agents.movie",
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
updatedAt: 1705615634,
|
||||
createdAt: 1654131312,
|
||||
scannedAt: 1705615584,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 3192854,
|
||||
hidden: 0,
|
||||
location: [
|
||||
{
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [models.GetLibrariesMediaContainer](../models/getlibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,131 +0,0 @@
|
||||
# GetLibraryHubsHub
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryHubsHub } from "@lukehagar/plexjs";
|
||||
import { RFCDate } from "@lukehagar/plexjs/types";
|
||||
|
||||
let value: GetLibraryHubsHub = {
|
||||
key: "/library/sections/1/all?sort=lastViewedAt:desc&unwatched=0&viewOffset=0",
|
||||
title: "Recently Played Movies",
|
||||
type: "movie",
|
||||
hubIdentifier: "movie.recentlyviewed.1",
|
||||
context: "hub.movie.recentlyviewed",
|
||||
size: 6,
|
||||
more: true,
|
||||
style: "shelf",
|
||||
hubKey: "/library/metadata/66485,66098,57249,11449,5858,14944",
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "14944",
|
||||
key: "/library/metadata/14944",
|
||||
guid: "plex://movie/5d77686eeb5d26001f1eb339",
|
||||
studio: "Walt Disney Animation Studios",
|
||||
type: "movie",
|
||||
title: "Tangled",
|
||||
librarySectionTitle: "Movies",
|
||||
librarySectionID: 1,
|
||||
librarySectionKey: "/library/sections/1",
|
||||
contentRating: "PG",
|
||||
summary:
|
||||
"The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.",
|
||||
rating: 8.9,
|
||||
audienceRating: 8.7,
|
||||
viewCount: 1,
|
||||
lastViewedAt: 1704936047,
|
||||
year: 2010,
|
||||
tagline: "They're taking adventure to new lengths.",
|
||||
thumb: "/library/metadata/14944/thumb/1705739847",
|
||||
art: "/library/metadata/14944/art/1705739847",
|
||||
duration: 6017237,
|
||||
originallyAvailableAt: new RFCDate("2010-11-24T00:00:00Z"),
|
||||
addedAt: 1589412494,
|
||||
updatedAt: 1705739847,
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
primaryExtraKey: "/library/metadata/14952",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
media: [
|
||||
{
|
||||
id: 38247,
|
||||
duration: 6017237,
|
||||
bitrate: 2051,
|
||||
width: 1920,
|
||||
height: 1080,
|
||||
aspectRatio: 1.78,
|
||||
audioChannels: 2,
|
||||
audioCodec: "aac",
|
||||
videoCodec: "h264",
|
||||
videoResolution: "1080",
|
||||
container: "mp4",
|
||||
videoFrameRate: "24p",
|
||||
optimizedForStreaming: 1,
|
||||
audioProfile: "lc",
|
||||
has64bitOffsets: false,
|
||||
videoProfile: "high",
|
||||
part: [
|
||||
{
|
||||
id: 38247,
|
||||
key: "/library/parts/38247/1589412494/file.mp4",
|
||||
duration: 6017237,
|
||||
file: "/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4",
|
||||
size: 1545647447,
|
||||
audioProfile: "lc",
|
||||
container: "mp4",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: true,
|
||||
videoProfile: "high",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
tag: "Animation",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "Nathan Greno",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
tag: "Donna Murphy",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "Wilhelm Grimm",
|
||||
},
|
||||
],
|
||||
skipCount: 1,
|
||||
chapterSource: "media",
|
||||
},
|
||||
],
|
||||
promoted: true,
|
||||
random: true,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/all?sort=lastViewedAt:desc&unwatched=0&viewOffset=0 |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Recently Played Movies |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||
| `hubIdentifier` | *string* | :heavy_minus_sign: | N/A | movie.recentlyviewed.1 |
|
||||
| `context` | *string* | :heavy_minus_sign: | N/A | hub.movie.recentlyviewed |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `more` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `style` | *string* | :heavy_minus_sign: | N/A | shelf |
|
||||
| `hubKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66485,66098,57249,11449,5858,14944 |
|
||||
| `metadata` | [models.GetLibraryHubsMetadata](../models/getlibraryhubsmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `promoted` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `random` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetLibraryHubsHubsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryHubsHubsResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetLibraryHubsErrors](../models/getlibraryhubserrors.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,62 +0,0 @@
|
||||
# GetLibraryHubsMedia
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryHubsMedia } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibraryHubsMedia = {
|
||||
id: 38247,
|
||||
duration: 6017237,
|
||||
bitrate: 2051,
|
||||
width: 1920,
|
||||
height: 1080,
|
||||
aspectRatio: 1.78,
|
||||
audioChannels: 2,
|
||||
audioCodec: "aac",
|
||||
videoCodec: "h264",
|
||||
videoResolution: "1080",
|
||||
container: "mp4",
|
||||
videoFrameRate: "24p",
|
||||
optimizedForStreaming: 1,
|
||||
audioProfile: "lc",
|
||||
has64bitOffsets: false,
|
||||
videoProfile: "high",
|
||||
part: [
|
||||
{
|
||||
id: 38247,
|
||||
key: "/library/parts/38247/1589412494/file.mp4",
|
||||
duration: 6017237,
|
||||
file: "/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4",
|
||||
size: 1545647447,
|
||||
audioProfile: "lc",
|
||||
container: "mp4",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: true,
|
||||
videoProfile: "high",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 38247 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 6017237 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 2051 |
|
||||
| `width` | *number* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `height` | *number* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 1.78 |
|
||||
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | aac |
|
||||
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | h264 |
|
||||
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `optimizedForStreaming` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
|
||||
| `part` | [models.GetLibraryHubsPart](../models/getlibraryhubspart.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetLibraryItemsLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryItemsLibraryResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetLibraryItemsErrors](../models/getlibraryitemserrors.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,53 +0,0 @@
|
||||
# GetLibraryItemsMedia
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryItemsMedia } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibraryItemsMedia = {
|
||||
id: 119534,
|
||||
duration: 11558112,
|
||||
bitrate: 25025,
|
||||
width: 3840,
|
||||
height: 2072,
|
||||
aspectRatio: 1.85,
|
||||
audioChannels: 6,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
part: [
|
||||
{
|
||||
id: 119542,
|
||||
key: "/library/parts/119542/1680457526/file.mkv",
|
||||
duration: 11558112,
|
||||
file: "/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
||||
size: 36158371307,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 119534 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 25025 |
|
||||
| `width` | *number* | :heavy_minus_sign: | N/A | 3840 |
|
||||
| `height` | *number* | :heavy_minus_sign: | N/A | 2072 |
|
||||
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 1.85 |
|
||||
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | eac3 |
|
||||
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 4k |
|
||||
| `container` | *string* | :heavy_minus_sign: | N/A | mkv |
|
||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `part` | [models.GetLibraryItemsPart](../models/getlibraryitemspart.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,155 +0,0 @@
|
||||
# GetLibraryItemsMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryItemsMediaContainer } from "@lukehagar/plexjs";
|
||||
import { RFCDate } from "@lukehagar/plexjs/types";
|
||||
|
||||
let value: GetLibraryItemsMediaContainer = {
|
||||
size: 70,
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
librarySectionTitle: "Movies",
|
||||
librarySectionUUID: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1701731894,
|
||||
thumb: "/:/resources/movie.png",
|
||||
title1: "Movies",
|
||||
title2: "Recently Released",
|
||||
viewGroup: "movie",
|
||||
viewMode: 65592,
|
||||
mixedParents: true,
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
studio: "20th Century Studios",
|
||||
type: "movie",
|
||||
title: "Avatar: The Way of Water",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14T00:00:00Z"),
|
||||
addedAt: 1680457607,
|
||||
updatedAt: 1703239236,
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
grandparentRatingKey: "66",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
media: [
|
||||
{
|
||||
id: 119534,
|
||||
duration: 11558112,
|
||||
bitrate: 25025,
|
||||
width: 3840,
|
||||
height: 2072,
|
||||
aspectRatio: 1.85,
|
||||
audioChannels: 6,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
part: [
|
||||
{
|
||||
id: 119542,
|
||||
key: "/library/parts/119542/1680457526/file.mkv",
|
||||
duration: 11558112,
|
||||
file: "/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
||||
size: 36158371307,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
tag: "Adventure",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "James Cameron",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "James Cameron",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
tag: "Sigourney Weaver",
|
||||
},
|
||||
],
|
||||
titleSort: "Whale",
|
||||
viewCount: 1,
|
||||
lastViewedAt: 1682752242,
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
index: 1,
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
hasPremiumExtras: "1",
|
||||
hasPremiumPrimaryExtra: "1",
|
||||
parentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
parentStudio: "UCP",
|
||||
parentKey: "/library/metadata/66",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentYear: 2010,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
parentTheme: "/library/metadata/66/theme/1705716261",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 70 |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `librarySectionID` | *models.LibrarySectionID* | :heavy_minus_sign: | N/A | |
|
||||
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `librarySectionUUID` | *string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `mediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_minus_sign: | N/A | 1701731894 |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
||||
| `title1` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `title2` | *string* | :heavy_minus_sign: | N/A | Recently Released |
|
||||
| `viewGroup` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||
| `viewMode` | *number* | :heavy_minus_sign: | N/A | 65592 |
|
||||
| `mixedParents` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `metadata` | [models.GetLibraryItemsMetadata](../models/getlibraryitemsmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,21 +0,0 @@
|
||||
# GetLibraryItemsRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryItemsRequest, Tag } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibraryItemsRequest = {
|
||||
sectionId: "<value>",
|
||||
tag: Tag.RecentlyViewed,
|
||||
includeGuids: 1,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `sectionId` | *any* | :heavy_check_mark: | the Id of the library to query | |
|
||||
| `tag` | [models.Tag](../models/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||
| `includeGuids` | *number* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetLibraryLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryLibraryResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetLibraryErrors](../models/getlibraryerrors.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,97 +0,0 @@
|
||||
# GetLibraryMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryMediaContainer } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibraryMediaContainer = {
|
||||
size: 29,
|
||||
allowSync: false,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
librarySectionID: 1,
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1701731894,
|
||||
thumb: "/:/resources/movie.png",
|
||||
title1: "Movies",
|
||||
viewGroup: "secondary",
|
||||
viewMode: 65592,
|
||||
directory: [
|
||||
{
|
||||
key: "search?type=1",
|
||||
title: "Search...",
|
||||
secondary: true,
|
||||
prompt: "Search Movies",
|
||||
search: true,
|
||||
},
|
||||
],
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/1/all?type=1",
|
||||
type: "movie",
|
||||
title: "Movies",
|
||||
active: false,
|
||||
filter: [
|
||||
{
|
||||
filter: "label",
|
||||
filterType: "string",
|
||||
key: "/library/sections/1/label",
|
||||
title: "Labels",
|
||||
type: "filter",
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
{
|
||||
default: "asc",
|
||||
defaultDirection: "desc",
|
||||
descKey: "random:desc",
|
||||
firstCharacterKey: "/library/sections/1/firstCharacter",
|
||||
key: "random",
|
||||
title: "Randomly",
|
||||
},
|
||||
],
|
||||
field: [
|
||||
{
|
||||
key: "label",
|
||||
title: "Label",
|
||||
type: "tag",
|
||||
subType: "bitrate",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
fieldType: [
|
||||
{
|
||||
type: "resolution",
|
||||
operator: [
|
||||
{
|
||||
key: "=",
|
||||
title: "is",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 29 |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `content` | *string* | :heavy_minus_sign: | N/A | secondary |
|
||||
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `mediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_minus_sign: | N/A | 1701731894 |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
||||
| `title1` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `viewGroup` | *string* | :heavy_minus_sign: | N/A | secondary |
|
||||
| `viewMode` | *number* | :heavy_minus_sign: | N/A | 65592 |
|
||||
| `directory` | [models.GetLibraryDirectory](../models/getlibrarydirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `type` | [models.GetLibraryType](../models/getlibrarytype.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `fieldType` | [models.FieldType](../models/fieldtype.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,53 +0,0 @@
|
||||
# GetLibraryType
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryType } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibraryType = {
|
||||
key: "/library/sections/1/all?type=1",
|
||||
type: "movie",
|
||||
title: "Movies",
|
||||
active: false,
|
||||
filter: [
|
||||
{
|
||||
filter: "label",
|
||||
filterType: "string",
|
||||
key: "/library/sections/1/label",
|
||||
title: "Labels",
|
||||
type: "filter",
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
{
|
||||
default: "asc",
|
||||
defaultDirection: "desc",
|
||||
descKey: "random:desc",
|
||||
firstCharacterKey: "/library/sections/1/firstCharacter",
|
||||
key: "random",
|
||||
title: "Randomly",
|
||||
},
|
||||
],
|
||||
field: [
|
||||
{
|
||||
key: "label",
|
||||
title: "Label",
|
||||
type: "tag",
|
||||
subType: "bitrate",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/all?type=1 |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `active` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `filter` | [models.GetLibraryFilter](../models/getlibraryfilter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | [models.Sort](../models/sort.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `field` | [models.Field](../models/field.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetMetadataChildrenLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataChildrenLibraryResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetMetadataChildrenErrors](../models/getmetadatachildrenerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetMetadataLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataLibraryResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetMetadataErrors](../models/getmetadataerrors.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,98 +0,0 @@
|
||||
# GetMetadataMedia
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataMedia } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMetadataMedia = {
|
||||
id: 15,
|
||||
duration: 141417,
|
||||
bitrate: 2278,
|
||||
width: 1920,
|
||||
height: 814,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 2,
|
||||
audioCodec: "aac",
|
||||
videoCodec: "h264",
|
||||
videoResolution: "1080",
|
||||
container: "mp4",
|
||||
videoFrameRate: "24p",
|
||||
optimizedForStreaming: 0,
|
||||
audioProfile: "lc",
|
||||
has64bitOffsets: false,
|
||||
videoProfile: "high",
|
||||
part: [
|
||||
{
|
||||
id: 15,
|
||||
key: "/library/parts/15/1705637151/file.mp4",
|
||||
duration: 141417,
|
||||
file: "/movies/Serenity (2005)/Serenity (2005).mp4",
|
||||
size: 40271948,
|
||||
audioProfile: "lc",
|
||||
container: "mp4",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "high",
|
||||
stream: [
|
||||
{
|
||||
id: 29,
|
||||
streamType: 2,
|
||||
default: true,
|
||||
codec: "aac",
|
||||
index: 0,
|
||||
bitrate: 128,
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
chromaSubsampling: "14520",
|
||||
codedHeight: 816,
|
||||
codedWidth: 1920,
|
||||
colorPrimaries: "bt709",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt709",
|
||||
colorTrc: "bt709",
|
||||
frameRate: 24,
|
||||
hasScalingMatrix: false,
|
||||
height: 814,
|
||||
level: 40,
|
||||
profile: "lc",
|
||||
refFrames: 4,
|
||||
scanType: "progressive",
|
||||
streamIdentifier: "1",
|
||||
width: 1920,
|
||||
displayTitle: "English (AAC Stereo)",
|
||||
extendedDisplayTitle: "English (AAC Stereo)",
|
||||
selected: true,
|
||||
channels: 2,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
samplingRate: 44100,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 15 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 2278 |
|
||||
| `width` | *number* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `height` | *number* | :heavy_minus_sign: | N/A | 814 |
|
||||
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 2.35 |
|
||||
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | aac |
|
||||
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | h264 |
|
||||
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `optimizedForStreaming` | *number* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
|
||||
| `part` | [models.GetMetadataPart](../models/getmetadatapart.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,72 +0,0 @@
|
||||
# GetMetadataPart
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataPart } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMetadataPart = {
|
||||
id: 15,
|
||||
key: "/library/parts/15/1705637151/file.mp4",
|
||||
duration: 141417,
|
||||
file: "/movies/Serenity (2005)/Serenity (2005).mp4",
|
||||
size: 40271948,
|
||||
audioProfile: "lc",
|
||||
container: "mp4",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "high",
|
||||
stream: [
|
||||
{
|
||||
id: 29,
|
||||
streamType: 2,
|
||||
default: true,
|
||||
codec: "aac",
|
||||
index: 0,
|
||||
bitrate: 128,
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
chromaSubsampling: "14520",
|
||||
codedHeight: 816,
|
||||
codedWidth: 1920,
|
||||
colorPrimaries: "bt709",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt709",
|
||||
colorTrc: "bt709",
|
||||
frameRate: 24,
|
||||
hasScalingMatrix: false,
|
||||
height: 814,
|
||||
level: 40,
|
||||
profile: "lc",
|
||||
refFrames: 4,
|
||||
scanType: "progressive",
|
||||
streamIdentifier: "1",
|
||||
width: 1920,
|
||||
displayTitle: "English (AAC Stereo)",
|
||||
extendedDisplayTitle: "English (AAC Stereo)",
|
||||
selected: true,
|
||||
channels: 2,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
samplingRate: 44100,
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 15 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `file` | *string* | :heavy_minus_sign: | N/A | /movies/Serenity (2005)/Serenity (2005).mp4 |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 40271948 |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
||||
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
|
||||
| `stream` | [models.Stream](../models/stream.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,39 +0,0 @@
|
||||
# GetMyPlexAccountResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMyPlexAccountResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMyPlexAccountResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 857946,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
myPlex: {
|
||||
authToken: "Z5v-PrNASDFpsaCi3CPK7",
|
||||
username: "example.email@mail.com",
|
||||
mappingState: "mapped",
|
||||
signInState: "ok",
|
||||
publicAddress: "140.20.68.140",
|
||||
publicPort: 32400,
|
||||
privateAddress: "10.10.10.47",
|
||||
privatePort: 32400,
|
||||
subscriptionFeatures:
|
||||
"federated-auth,hardware_transcoding,home,hwtranscode,item_clusters,kevin-bacon,livetv,loudness,lyrics,music-analysis,music_videos,pass,photo_autotags,photos-v5,photosV6-edit,photosV6-tv-albums,premium_music_metadata,radio,server-manager,session_bandwidth_restrictions,session_kick,shared-radio,sync,trailers,tuner-sharing,type-first,unsupportedtuners,webhooks",
|
||||
subscriptionState: "Active",
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [models.GetMyPlexAccountResponseBody](../models/getmyplexaccountresponsebody.md) | :heavy_minus_sign: | MyPlex Account |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetMyPlexAccountServerResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMyPlexAccountServerResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetMyPlexAccountErrors](../models/getmyplexaccounterrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetOnDeckLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckLibraryResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetOnDeckErrors](../models/getondeckerrors.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,82 +0,0 @@
|
||||
# GetOnDeckMedia
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckMedia } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetOnDeckMedia = {
|
||||
id: 80994,
|
||||
duration: 420080,
|
||||
bitrate: 1046,
|
||||
width: 1920,
|
||||
height: 1080,
|
||||
aspectRatio: 1.78,
|
||||
audioChannels: 2,
|
||||
audioCodec: "aac",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "1080",
|
||||
container: "mkv",
|
||||
videoFrameRate: "PAL",
|
||||
audioProfile: "lc",
|
||||
videoProfile: "main",
|
||||
part: [
|
||||
{
|
||||
id: 80994,
|
||||
key: "/library/parts/80994/1655007810/file.mkv",
|
||||
duration: 420080,
|
||||
file: "/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv",
|
||||
size: 55148931,
|
||||
audioProfile: "lc",
|
||||
container: "mkv",
|
||||
videoProfile: "main",
|
||||
stream: [
|
||||
{
|
||||
id: 211234,
|
||||
streamType: 1,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 918,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1080,
|
||||
codedWidth: 1920,
|
||||
colorRange: "tv",
|
||||
frameRate: 25,
|
||||
height: 1080,
|
||||
level: 120,
|
||||
profile: "main",
|
||||
refFrames: 1,
|
||||
width: 1920,
|
||||
displayTitle: "1080p (HEVC Main)",
|
||||
extendedDisplayTitle: "1080p (HEVC Main)",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 80994 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 420080 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 1046 |
|
||||
| `width` | *number* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `height` | *number* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 1.78 |
|
||||
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | aac |
|
||||
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `container` | *string* | :heavy_minus_sign: | N/A | mkv |
|
||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | PAL |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main |
|
||||
| `part` | [models.GetOnDeckPart](../models/getondeckpart.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,58 +0,0 @@
|
||||
# GetOnDeckPart
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckPart } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetOnDeckPart = {
|
||||
id: 80994,
|
||||
key: "/library/parts/80994/1655007810/file.mkv",
|
||||
duration: 420080,
|
||||
file: "/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv",
|
||||
size: 55148931,
|
||||
audioProfile: "lc",
|
||||
container: "mkv",
|
||||
videoProfile: "main",
|
||||
stream: [
|
||||
{
|
||||
id: 211234,
|
||||
streamType: 1,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 918,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1080,
|
||||
codedWidth: 1920,
|
||||
colorRange: "tv",
|
||||
frameRate: 25,
|
||||
height: 1080,
|
||||
level: 120,
|
||||
profile: "main",
|
||||
refFrames: 1,
|
||||
width: 1920,
|
||||
displayTitle: "1080p (HEVC Main)",
|
||||
extendedDisplayTitle: "1080p (HEVC Main)",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 80994 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/parts/80994/1655007810/file.mkv |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 420080 |
|
||||
| `file` | *string* | :heavy_minus_sign: | N/A | /tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 55148931 |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
||||
| `container` | *string* | :heavy_minus_sign: | N/A | mkv |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main |
|
||||
| `stream` | [models.GetOnDeckStream](../models/getondeckstream.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,62 +0,0 @@
|
||||
# GetPlaylistContentsMedia
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPlaylistContentsMedia } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetPlaylistContentsMedia = {
|
||||
id: 15,
|
||||
duration: 141416,
|
||||
bitrate: 2273,
|
||||
width: 1920,
|
||||
height: 814,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 2,
|
||||
audioCodec: "aac",
|
||||
videoCodec: "h264",
|
||||
videoResolution: "1080",
|
||||
container: "mp4",
|
||||
videoFrameRate: "24p",
|
||||
optimizedForStreaming: 0,
|
||||
audioProfile: "lc",
|
||||
has64bitOffsets: false,
|
||||
videoProfile: "high",
|
||||
part: [
|
||||
{
|
||||
id: 15,
|
||||
key: "/library/parts/15/1705637151/file.mp4",
|
||||
duration: 141416,
|
||||
file: "/movies/Serenity (2005)/Serenity (2005).mp4",
|
||||
size: 40271948,
|
||||
audioProfile: "lc",
|
||||
container: "mp4",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "high",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 15 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 141416 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 2273 |
|
||||
| `width` | *number* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `height` | *number* | :heavy_minus_sign: | N/A | 814 |
|
||||
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 2.35 |
|
||||
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | aac |
|
||||
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | h264 |
|
||||
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `optimizedForStreaming` | *number* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
|
||||
| `part` | [models.GetPlaylistContentsPart](../models/getplaylistcontentspart.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetPlaylistContentsPlaylistsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPlaylistContentsPlaylistsResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetPlaylistContentsErrors](../models/getplaylistcontentserrors.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,19 +0,0 @@
|
||||
# GetPlaylistContentsRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPlaylistContentsRequest } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetPlaylistContentsRequest = {
|
||||
playlistID: 9883.74,
|
||||
type: 9589.5,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
|
||||
| `playlistID` | *number* | :heavy_check_mark: | the ID of the playlist |
|
||||
| `type` | *number* | :heavy_check_mark: | the metadata type of the item to return |
|
||||
@@ -1,38 +0,0 @@
|
||||
# GetPlaylistMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPlaylistMediaContainer } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetPlaylistMediaContainer = {
|
||||
size: 1,
|
||||
metadata: [
|
||||
{
|
||||
content:
|
||||
"library://x/directory/%2Flibrary%2Fsections%2F1%2Fall%3Ftype%3D1%26push%3D1%26title%3D2%26or%3D1%26title%3DSerenity%26pop%3D1",
|
||||
ratingKey: "95",
|
||||
key: "/playlists/95/items",
|
||||
guid: "com.plexapp.agents.none://87425529-380f-44b8-a689-9a0537e7ec91",
|
||||
type: "playlist",
|
||||
title: "Smart Movie Playlist",
|
||||
summary: "",
|
||||
smart: true,
|
||||
playlistType: "video",
|
||||
composite: "/playlists/95/composite/1705717387",
|
||||
icon: "playlist://image.smart",
|
||||
duration: 282000,
|
||||
leafCount: 2,
|
||||
addedAt: 1705716493,
|
||||
updatedAt: 1705717387,
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `metadata` | [models.GetPlaylistMetadata](../models/getplaylistmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetPlaylistPlaylistsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPlaylistPlaylistsResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetPlaylistErrors](../models/getplaylisterrors.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,49 +0,0 @@
|
||||
# GetPlaylistResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPlaylistResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetPlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 325047,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 1,
|
||||
metadata: [
|
||||
{
|
||||
content:
|
||||
"library://x/directory/%2Flibrary%2Fsections%2F1%2Fall%3Ftype%3D1%26push%3D1%26title%3D2%26or%3D1%26title%3DSerenity%26pop%3D1",
|
||||
ratingKey: "95",
|
||||
key: "/playlists/95/items",
|
||||
guid: "com.plexapp.agents.none://87425529-380f-44b8-a689-9a0537e7ec91",
|
||||
type: "playlist",
|
||||
title: "Smart Movie Playlist",
|
||||
summary: "",
|
||||
smart: true,
|
||||
playlistType: "video",
|
||||
composite: "/playlists/95/composite/1705717387",
|
||||
icon: "playlist://image.smart",
|
||||
duration: 282000,
|
||||
leafCount: 2,
|
||||
addedAt: 1705716493,
|
||||
updatedAt: 1705717387,
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [models.GetPlaylistResponseBody](../models/getplaylistresponsebody.md) | :heavy_minus_sign: | The playlist |
|
||||
@@ -1,38 +0,0 @@
|
||||
# GetPlaylistsMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPlaylistsMediaContainer } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetPlaylistsMediaContainer = {
|
||||
size: 4,
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "92",
|
||||
key: "/playlists/92/items",
|
||||
guid: "com.plexapp.agents.none://7ca5aaef-58e8-4828-9e21-c009c97f2903",
|
||||
type: "playlist",
|
||||
title: "Static Playlist",
|
||||
summary: "A Great Playlist",
|
||||
smart: false,
|
||||
playlistType: "video",
|
||||
composite: "/playlists/92/composite/1705716440",
|
||||
icon: "playlist://image.smart",
|
||||
viewCount: 1,
|
||||
lastViewedAt: 1705716298,
|
||||
duration: 7328000,
|
||||
leafCount: 32,
|
||||
addedAt: 1705716298,
|
||||
updatedAt: 1705716440,
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 4 |
|
||||
| `metadata` | [models.GetPlaylistsMetadata](../models/getplaylistsmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetPlaylistsPlaylistsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPlaylistsPlaylistsResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetPlaylistsErrors](../models/getplaylistserrors.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,16 +0,0 @@
|
||||
# GetPlaylistsRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPlaylistsRequest } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetPlaylistsRequest = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
|
||||
| `playlistType` | [models.PlaylistType](../models/playlisttype.md) | :heavy_minus_sign: | limit to a type of playlist. |
|
||||
| `smart` | [models.QueryParamSmart](../models/queryparamsmart.md) | :heavy_minus_sign: | type of playlists to return (default is all). |
|
||||
@@ -1,49 +0,0 @@
|
||||
# GetPlaylistsResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPlaylistsResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetPlaylistsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 607831,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 4,
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "92",
|
||||
key: "/playlists/92/items",
|
||||
guid: "com.plexapp.agents.none://7ca5aaef-58e8-4828-9e21-c009c97f2903",
|
||||
type: "playlist",
|
||||
title: "Static Playlist",
|
||||
summary: "A Great Playlist",
|
||||
smart: false,
|
||||
playlistType: "video",
|
||||
composite: "/playlists/92/composite/1705716440",
|
||||
icon: "playlist://image.smart",
|
||||
viewCount: 1,
|
||||
lastViewedAt: 1705716298,
|
||||
duration: 7328000,
|
||||
leafCount: 32,
|
||||
addedAt: 1705716298,
|
||||
updatedAt: 1705716440,
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [models.GetPlaylistsResponseBody](../models/getplaylistsresponsebody.md) | :heavy_minus_sign: | returns all playlists |
|
||||
@@ -1,41 +0,0 @@
|
||||
# GetPlaylistsResponseBody
|
||||
|
||||
returns all playlists
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPlaylistsResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetPlaylistsResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 4,
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "92",
|
||||
key: "/playlists/92/items",
|
||||
guid: "com.plexapp.agents.none://7ca5aaef-58e8-4828-9e21-c009c97f2903",
|
||||
type: "playlist",
|
||||
title: "Static Playlist",
|
||||
summary: "A Great Playlist",
|
||||
smart: false,
|
||||
playlistType: "video",
|
||||
composite: "/playlists/92/composite/1705716440",
|
||||
icon: "playlist://image.smart",
|
||||
viewCount: 1,
|
||||
lastViewedAt: 1705716298,
|
||||
duration: 7328000,
|
||||
leafCount: 32,
|
||||
addedAt: 1705716298,
|
||||
updatedAt: 1705716440,
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [models.GetPlaylistsMediaContainer](../models/getplaylistsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetRecentlyAddedLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetRecentlyAddedLibraryResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetRecentlyAddedErrors](../models/getrecentlyaddederrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,57 +0,0 @@
|
||||
# GetRecentlyAddedMedia
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetRecentlyAddedMedia } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetRecentlyAddedMedia = {
|
||||
id: 120345,
|
||||
duration: 7474422,
|
||||
bitrate: 3623,
|
||||
width: 1920,
|
||||
height: 804,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
audioCodec: "ac3",
|
||||
videoCodec: "h264",
|
||||
videoResolution: 1080,
|
||||
container: "mp4",
|
||||
videoFrameRate: "24p",
|
||||
optimizedForStreaming: 0,
|
||||
videoProfile: "high",
|
||||
part: [
|
||||
{
|
||||
id: 120353,
|
||||
key: "/library/parts/120353/1681803203/file.mp4",
|
||||
duration: 7474422,
|
||||
file: "/movies/Ant-Man and the Wasp Quantumania (2023)/Ant-Man.and.the.Wasp.Quantumania.2023.1080p.mp4",
|
||||
size: 3395307162,
|
||||
container: "mp4",
|
||||
hasThumbnail: 1,
|
||||
videoProfile: "high",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 120345 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 7474422 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 3623 |
|
||||
| `width` | *number* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `height` | *number* | :heavy_minus_sign: | N/A | 804 |
|
||||
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 2.35 |
|
||||
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | ac3 |
|
||||
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | h264 |
|
||||
| `videoResolution` | *number* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `optimizedForStreaming` | *number* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
|
||||
| `part` | [models.Part](../models/part.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetResizedPhotoResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetResizedPhotoResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetResizedPhotoErrors](../models/getresizedphotoerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetResourcesResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetResourcesResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetResourcesErrors](../models/getresourceserrors.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,28 +0,0 @@
|
||||
# GetResourcesStatisticsMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetResourcesStatisticsMediaContainer } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetResourcesStatisticsMediaContainer = {
|
||||
size: 5497,
|
||||
statisticsResources: [
|
||||
{
|
||||
timespan: 6,
|
||||
at: 1718384427,
|
||||
hostCpuUtilization: 1.276,
|
||||
processCpuUtilization: 0.025,
|
||||
hostMemoryUtilization: 17.026,
|
||||
processMemoryUtilization: 0.493,
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 5497 |
|
||||
| `statisticsResources` | [models.StatisticsResources](../models/statisticsresources.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,39 +0,0 @@
|
||||
# GetResourcesStatisticsResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetResourcesStatisticsResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetResourcesStatisticsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 244425,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 5497,
|
||||
statisticsResources: [
|
||||
{
|
||||
timespan: 6,
|
||||
at: 1718384427,
|
||||
hostCpuUtilization: 1.276,
|
||||
processCpuUtilization: 0.025,
|
||||
hostMemoryUtilization: 17.026,
|
||||
processMemoryUtilization: 0.493,
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [models.GetResourcesStatisticsResponseBody](../models/getresourcesstatisticsresponsebody.md) | :heavy_minus_sign: | Resource Statistics |
|
||||
@@ -1,31 +0,0 @@
|
||||
# GetResourcesStatisticsResponseBody
|
||||
|
||||
Resource Statistics
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetResourcesStatisticsResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetResourcesStatisticsResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 5497,
|
||||
statisticsResources: [
|
||||
{
|
||||
timespan: 6,
|
||||
at: 1718384427,
|
||||
hostCpuUtilization: 1.276,
|
||||
processCpuUtilization: 0.025,
|
||||
hostMemoryUtilization: 17.026,
|
||||
processMemoryUtilization: 0.493,
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `mediaContainer` | [models.GetResourcesStatisticsMediaContainer](../models/getresourcesstatisticsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetResourcesStatisticsStatisticsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetResourcesStatisticsStatisticsResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetResourcesStatisticsErrors](../models/getresourcesstatisticserrors.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,56 +0,0 @@
|
||||
# GetSearchResultsMedia
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchResultsMedia } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetSearchResultsMedia = {
|
||||
id: 26610,
|
||||
duration: 6612628,
|
||||
bitrate: 4751,
|
||||
width: 1916,
|
||||
height: 796,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
audioCodec: "aac",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: 1080,
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
audioProfile: "lc",
|
||||
videoProfile: "main 10",
|
||||
part: [
|
||||
{
|
||||
id: 26610,
|
||||
key: "/library/parts/26610/1589234571/file.mkv",
|
||||
duration: 6612628,
|
||||
file: "/movies/Mission Impossible (1996)/Mission Impossible (1996) Bluray-1080p.mkv",
|
||||
size: 3926903851,
|
||||
audioProfile: "lc",
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 26610 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 6612628 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 4751 |
|
||||
| `width` | *number* | :heavy_minus_sign: | N/A | 1916 |
|
||||
| `height` | *number* | :heavy_minus_sign: | N/A | 796 |
|
||||
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 2.35 |
|
||||
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | aac |
|
||||
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `videoResolution` | *number* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `container` | *string* | :heavy_minus_sign: | N/A | mkv |
|
||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `part` | [models.GetSearchResultsPart](../models/getsearchresultspart.md)[] | :heavy_minus_sign: | N/A | |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user