mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
Compare commits
18 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
7a950ea773 | ||
|
|
379a408d74 | ||
|
|
2712820397 | ||
|
|
c895213ae8 | ||
|
|
c473c9d326 | ||
|
|
3c13bba9de | ||
|
|
650c5043ef | ||
|
|
0234804578 | ||
|
|
60d913c8f9 | ||
|
|
8d9f4bbaf1 | ||
|
|
5d57cd7c34 | ||
|
|
1a8e227874 | ||
|
|
8360d057ab | ||
|
|
18b64727c3 | ||
|
|
3152372037 | ||
|
|
13cd8a7fe5 | ||
|
|
cdcdc0ca8e | ||
|
|
b03cc6a609 |
@@ -1,28 +0,0 @@
|
||||
/* eslint-env node */
|
||||
module.exports = {
|
||||
root: true,
|
||||
extends: [
|
||||
"eslint:recommended",
|
||||
"plugin:@typescript-eslint/recommended",
|
||||
"plugin:import/recommended",
|
||||
"plugin:import/typescript",
|
||||
],
|
||||
parser: "@typescript-eslint/parser",
|
||||
plugins: ["@typescript-eslint"],
|
||||
settings: {
|
||||
"import/resolver": {
|
||||
typescript: true,
|
||||
node: true,
|
||||
},
|
||||
},
|
||||
rules: {
|
||||
// Handled by typescript compiler
|
||||
"@typescript-eslint/no-unused-vars": "off",
|
||||
"@typescript-eslint/ban-types": "off",
|
||||
"@typescript-eslint/no-namespace": "off",
|
||||
"@typescript-eslint/no-explicit-any": "off",
|
||||
"import/no-named-as-default-member": "off",
|
||||
|
||||
"import/no-default-export": "error",
|
||||
},
|
||||
};
|
||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -1,3 +1,7 @@
|
||||
/mcp-server
|
||||
/bin
|
||||
/.eslintcache
|
||||
/.speakeasy/reports
|
||||
/react-query
|
||||
/sdk/models/errors
|
||||
/sdk/types
|
||||
|
||||
@@ -4,9 +4,11 @@
|
||||
!/REACT_QUERY.md
|
||||
!/**/*.ts
|
||||
!/**/*.js
|
||||
!/**/*.mjs
|
||||
!/**/*.json
|
||||
!/**/*.map
|
||||
|
||||
/.eslintrc.js
|
||||
/eslint.config.mjs
|
||||
/cjs
|
||||
/.tshy
|
||||
/.tshy-*
|
||||
|
||||
1823
.speakeasy/gen.lock
1823
.speakeasy/gen.lock
File diff suppressed because one or more lines are too long
@@ -7,13 +7,15 @@ generation:
|
||||
useClassNamesForArrayFields: true
|
||||
fixes:
|
||||
nameResolutionDec2023: true
|
||||
nameResolutionFeb2025: false
|
||||
parameterOrderingFeb2024: true
|
||||
requestResponseComponentNamesFeb2024: true
|
||||
securityFeb2025: false
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
oAuth2PasswordEnabled: false
|
||||
typescript:
|
||||
version: 0.32.0
|
||||
version: 0.36.2
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies: {}
|
||||
@@ -22,6 +24,8 @@ typescript:
|
||||
author: LukeHagar
|
||||
clientServerStatusCodesAsErrors: true
|
||||
defaultErrorName: SDKError
|
||||
enableCustomCodeRegions: false
|
||||
enableMCPServer: true
|
||||
enableReactQuery: false
|
||||
enumFormat: enum
|
||||
flattenGlobalSecurity: true
|
||||
@@ -35,6 +39,7 @@ typescript:
|
||||
shared: sdk/models/shared
|
||||
webhooks: sdk/models/webhooks
|
||||
inputModelSuffix: input
|
||||
jsonpath: legacy
|
||||
maxMethodParams: 4
|
||||
methodArguments: require-security-and-request
|
||||
moduleFormat: commonjs
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.456.1
|
||||
speakeasyVersion: 1.531.4
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
@@ -9,20 +9,20 @@ sources:
|
||||
- main
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:ccba0c42f1644923e2209e28da7a78195a843e48da1aeaaedbf8759f1a8a0fe0
|
||||
sourceBlobDigest: sha256:b362c110ef633288220a55ab50627374b996c64f2d9b8e020944e84ea2840332
|
||||
sourceRevisionDigest: sha256:db75a06885b897418dcb580679b5f744348573ad317155172346d32442420e5e
|
||||
sourceBlobDigest: sha256:ac0a3c3a6df002378b3522325c2330ba4309fbbbfa503a04b8267398f20033f5
|
||||
tags:
|
||||
- latest
|
||||
- speakeasy-sdk-regen-1734710483
|
||||
- speakeasy-sdk-regen-1744589502
|
||||
- 0.0.3
|
||||
targets:
|
||||
plexjs:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:ccba0c42f1644923e2209e28da7a78195a843e48da1aeaaedbf8759f1a8a0fe0
|
||||
sourceBlobDigest: sha256:b362c110ef633288220a55ab50627374b996c64f2d9b8e020944e84ea2840332
|
||||
sourceRevisionDigest: sha256:db75a06885b897418dcb580679b5f744348573ad317155172346d32442420e5e
|
||||
sourceBlobDigest: sha256:ac0a3c3a6df002378b3522325c2330ba4309fbbbfa503a04b8267398f20033f5
|
||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||
codeSamplesRevisionDigest: sha256:f1245ceff6a26548b804c05954169ae215f024ea7b77438a4d6b86fdcd5a080c
|
||||
codeSamplesRevisionDigest: sha256:2542621903a932e966c28b4970e8b3a9e7f8b459e42d63ebebdc3940e551cd76
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
@@ -43,3 +43,5 @@ workflow:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||
labelOverride:
|
||||
fixedValue: PlexJS
|
||||
|
||||
@@ -17,3 +17,5 @@ targets:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||
labelOverride:
|
||||
fixedValue: PlexJS
|
||||
|
||||
98
README.md
98
README.md
@@ -54,6 +54,7 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
|
||||
* [Authentication](#authentication)
|
||||
* [Requirements](#requirements)
|
||||
* [Standalone functions](#standalone-functions)
|
||||
* [File uploads](#file-uploads)
|
||||
* [Retries](#retries)
|
||||
* [Debugging](#debugging)
|
||||
* [Development](#development)
|
||||
@@ -159,13 +160,20 @@ run();
|
||||
* [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
|
||||
* [getAllMediaLibrary](docs/sdks/library/README.md#getallmedialibrary) - Get all media of library
|
||||
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
||||
* [getCountriesLibrary](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
|
||||
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
|
||||
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
||||
* [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
||||
* [getMediaArts](docs/sdks/library/README.md#getmediaarts) - Get Media Background Artwork
|
||||
* [postMediaArts](docs/sdks/library/README.md#postmediaarts) - Upload Media Background Artwork
|
||||
* [getMediaPosters](docs/sdks/library/README.md#getmediaposters) - Get Media Posters
|
||||
* [postMediaPoster](docs/sdks/library/README.md#postmediaposter) - Upload Media Poster
|
||||
* [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
|
||||
|
||||
### [log](docs/sdks/log/README.md)
|
||||
|
||||
@@ -241,6 +249,10 @@ run();
|
||||
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
||||
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
||||
|
||||
### [users](docs/sdks/users/README.md)
|
||||
|
||||
* [getUsers](docs/sdks/users/README.md#getusers) - Get list of all connected users
|
||||
|
||||
### [video](docs/sdks/video/README.md)
|
||||
|
||||
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
||||
@@ -336,13 +348,39 @@ In some rare cases, the SDK can fail to get a response from the server or even m
|
||||
### Server Variables
|
||||
|
||||
The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following parameters are available when initializing the SDK client instance:
|
||||
* `protocol: models.ServerProtocol`
|
||||
* `ip: string`
|
||||
* `port: string`
|
||||
|
||||
| Variable | Parameter | Supported Values | Default | Description |
|
||||
| ---------- | --------------------------------- | -------------------------- | --------------- | ---------------------------------------------- |
|
||||
| `protocol` | `protocol: models.ServerProtocol` | - `"http"`<br/>- `"https"` | `"https"` | The protocol to use for the server connection |
|
||||
| `ip` | `ip: string` | string | `"10.10.10.47"` | The IP address or hostname of your Plex Server |
|
||||
| `port` | `port: string` | string | `"32400"` | The port of your Plex Server |
|
||||
|
||||
#### Example
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
protocol: "https",
|
||||
ip: "e0c3:bcc0:6bac:dccc:c4ec:34b1:ca98:4cb9",
|
||||
port: "40311",
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.server.getServerCapabilities();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
|
||||
### Override Server URL Per-Client
|
||||
|
||||
The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
|
||||
The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -502,18 +540,25 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
- [`hubsGetLibraryHubs`](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
||||
- [`hubsGetRecentlyAdded`](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
|
||||
- [`libraryDeleteLibrary`](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||
- [`libraryGetActorsLibrary`](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
|
||||
- [`libraryGetAllLibraries`](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
||||
- [`libraryGetAllMediaLibrary`](docs/sdks/library/README.md#getallmedialibrary) - Get all media of library
|
||||
- [`libraryGetCountriesLibrary`](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
|
||||
- [`libraryGetFileHash`](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||
- [`libraryGetGenresLibrary`](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
||||
- [`libraryGetLibraryDetails`](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||
- [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||
- [`libraryGetMetaDataByRatingKey`](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
||||
- [`libraryGetMediaArts`](docs/sdks/library/README.md#getmediaarts) - Get Media Background Artwork
|
||||
- [`libraryGetMediaMetaData`](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
||||
- [`libraryGetMediaPosters`](docs/sdks/library/README.md#getmediaposters) - Get Media Posters
|
||||
- [`libraryGetMetadataChildren`](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||
- [`libraryGetOnDeck`](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||
- [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
|
||||
- [`libraryGetRefreshLibraryMetadata`](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||
- [`libraryGetSearchAllLibraries`](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||
- [`libraryGetSearchLibrary`](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||
- [`libraryGetTopWatchedContent`](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||
- [`libraryPostMediaArts`](docs/sdks/library/README.md#postmediaarts) - Upload Media Background Artwork
|
||||
- [`libraryPostMediaPoster`](docs/sdks/library/README.md#postmediaposter) - Upload Media Poster
|
||||
- [`logEnablePaperTrail`](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
|
||||
- [`logLogLine`](docs/sdks/log/README.md#logline) - Logging a single line message.
|
||||
- [`logLogMultiLine`](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
|
||||
@@ -560,6 +605,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
- [`updaterApplyUpdates`](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
||||
- [`updaterCheckForUpdates`](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
||||
- [`updaterGetUpdateStatus`](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
|
||||
- [`usersGetUsers`](docs/sdks/users/README.md#getusers) - Get list of all connected users
|
||||
- [`videoGetTimeline`](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
||||
- [`videoStartUniversalTranscode`](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
|
||||
- [`watchlistGetWatchList`](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
|
||||
@@ -567,6 +613,42 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
</details>
|
||||
<!-- End Standalone functions [standalone-funcs] -->
|
||||
|
||||
<!-- Start File uploads [file-upload] -->
|
||||
## File uploads
|
||||
|
||||
Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
|
||||
|
||||
> [!TIP]
|
||||
>
|
||||
> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
|
||||
>
|
||||
> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
|
||||
> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.
|
||||
> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `<input type="file">` element.
|
||||
> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.postMediaArts(
|
||||
2268,
|
||||
"https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b",
|
||||
);
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End File uploads [file-upload] -->
|
||||
|
||||
<!-- Start Retries [retries] -->
|
||||
## Retries
|
||||
|
||||
|
||||
152
RELEASES.md
152
RELEASES.md
@@ -1158,4 +1158,154 @@ Based on:
|
||||
### Generated
|
||||
- [typescript v0.32.0] .
|
||||
### Releases
|
||||
- [NPM v0.32.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.0 - .
|
||||
- [NPM v0.32.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.0 - .
|
||||
|
||||
## 2024-12-22 00:10:48
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.459.2 (2.483.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.32.1] .
|
||||
### Releases
|
||||
- [NPM v0.32.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.1 - .
|
||||
|
||||
## 2025-01-24 00:09:35
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.474.0 (2.495.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.32.2] .
|
||||
### Releases
|
||||
- [NPM v0.32.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.2 - .
|
||||
|
||||
## 2025-01-27 00:09:48
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.476.1 (2.495.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.32.3] .
|
||||
### Releases
|
||||
- [NPM v0.32.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.3 - .
|
||||
|
||||
## 2025-02-05 00:09:58
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.32.4] .
|
||||
### Releases
|
||||
- [NPM v0.32.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.4 - .
|
||||
|
||||
## 2025-02-06 00:09:46
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.32.5] .
|
||||
### Releases
|
||||
- [NPM v0.32.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.5 - .
|
||||
|
||||
## 2025-02-07 00:09:41
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.487.0 (2.506.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.33.0] .
|
||||
### Releases
|
||||
- [NPM v0.33.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.33.0 - .
|
||||
|
||||
## 2025-02-10 00:10:04
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.487.1 (2.506.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.34.0] .
|
||||
### Releases
|
||||
- [NPM v0.34.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.34.0 - .
|
||||
|
||||
## 2025-03-07 00:09:55
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.513.2 (2.545.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.35.0] .
|
||||
### Releases
|
||||
- [NPM v0.35.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.0 - .
|
||||
|
||||
## 2025-03-09 00:09:12
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.513.4 (2.545.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.35.1] .
|
||||
### Releases
|
||||
- [NPM v0.35.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.1 - .
|
||||
|
||||
## 2025-03-31 16:31:46
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.35.2] .
|
||||
### Releases
|
||||
- [NPM v0.35.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.2 - .
|
||||
|
||||
## 2025-03-31 19:33:46
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.35.3] .
|
||||
### Releases
|
||||
- [NPM v0.35.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.3 - .
|
||||
|
||||
## 2025-03-31 19:42:25
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.35.4] .
|
||||
### Releases
|
||||
- [NPM v0.35.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.4 - .
|
||||
|
||||
## 2025-04-03 00:10:29
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.528.1 (2.565.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.36.0] .
|
||||
### Releases
|
||||
- [NPM v0.36.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.36.0 - .
|
||||
|
||||
## 2025-04-06 00:11:19
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.529.1 (2.566.5) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.36.1] .
|
||||
### Releases
|
||||
- [NPM v0.36.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.36.1 - .
|
||||
|
||||
## 2025-04-14 00:11:23
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.531.4 (2.570.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.36.2] .
|
||||
### Releases
|
||||
- [NPM v0.36.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.36.2 - .
|
||||
28
RUNTIMES.md
28
RUNTIMES.md
@@ -1,6 +1,6 @@
|
||||
# Supported JavaScript runtimes
|
||||
|
||||
This SDK is intended to be used in JavaScript runtimes that support the following features:
|
||||
This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
|
||||
|
||||
* [Web Fetch API][web-fetch]
|
||||
* [Web Streams API][web-streams] and in particular `ReadableStream`
|
||||
@@ -20,3 +20,29 @@ Runtime environments that are explicitly supported are:
|
||||
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
|
||||
|
||||
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
|
||||
|
||||
## Recommended TypeScript compiler options
|
||||
|
||||
The following `tsconfig.json` options are recommended for projects using this
|
||||
SDK in order to get static type support for features like async iterables,
|
||||
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
|
||||
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
|
||||
so on):
|
||||
|
||||
[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
|
||||
[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
|
||||
[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
|
||||
[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
|
||||
|
||||
```jsonc
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "es2020", // or higher
|
||||
"lib": ["es2020", "dom", "dom.iterable"],
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
While `target` can be set to older ECMAScript versions, it may result in extra,
|
||||
unnecessary compatibility code being generated if you are not targeting old
|
||||
runtimes.
|
||||
426
codeSamples.yaml
426
codeSamples.yaml
@@ -7,7 +7,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getServerCapabilities
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -27,7 +27,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getServerPreferences
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -47,7 +47,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: updatePlayProgress
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -67,7 +67,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: markPlayed
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -87,7 +87,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getTimeline
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { State } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -119,7 +119,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: markUnplayed
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -139,7 +139,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getServerActivities
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -159,7 +159,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: cancelServerActivities
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -179,7 +179,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: stopAllTasks
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -199,7 +199,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getButlerTasks
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -219,7 +219,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: startAllTasks
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -239,7 +239,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: stopTask
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { PathParamTaskName } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -260,7 +260,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: startTask
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { TaskName } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -281,7 +281,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getAvailableClients
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -301,7 +301,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getCompanionsData
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -321,7 +321,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getDevices
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -341,7 +341,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getUserFriends
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -361,7 +361,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getGeoData
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -379,7 +379,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getHomeData
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -399,7 +399,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getGlobalHubs
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -419,10 +419,10 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: added
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { IncludeMeta, Type } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { Type } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
@@ -433,9 +433,6 @@ actions:
|
||||
contentDirectoryID: 470161,
|
||||
sectionID: 2,
|
||||
type: Type.TvShow,
|
||||
includeMeta: IncludeMeta.Enable,
|
||||
xPlexContainerStart: 0,
|
||||
xPlexContainerSize: 50,
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
@@ -447,7 +444,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: performSearch
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -456,7 +453,7 @@ actions:
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.search.performSearch("dylan", 5);
|
||||
const result = await plexAPI.search.performSearch("dylan");
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
@@ -467,7 +464,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: performVoiceSearch
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -476,7 +473,7 @@ actions:
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.search.performVoiceSearch("dead+poop", 5);
|
||||
const result = await plexAPI.search.performVoiceSearch("dead+poop");
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
@@ -487,7 +484,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getLibraryHubs
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -507,7 +504,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: identity
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -525,7 +522,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getTopWatchedContent
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetTopWatchedContentQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -546,7 +543,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getFileHash
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -566,7 +563,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: key
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -575,7 +572,62 @@ actions:
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getMetaDataByRatingKey(9518);
|
||||
const result = await plexAPI.library.getMediaMetaData({
|
||||
ratingKey: 9518,
|
||||
includeConcerts: true,
|
||||
includeExtras: true,
|
||||
includeOnDeck: true,
|
||||
includePopularLeaves: true,
|
||||
includePreferences: true,
|
||||
includeReviews: true,
|
||||
includeChapters: true,
|
||||
includeStations: true,
|
||||
includeExternalMedia: true,
|
||||
asyncAugmentMetadata: true,
|
||||
asyncCheckFiles: true,
|
||||
asyncRefreshAnalysis: true,
|
||||
asyncRefreshLocalMediaAgent: true,
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/arts"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getMediaArts(16099);
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/arts"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.postMediaArts(2268, "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b");
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
@@ -586,7 +638,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: image
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -613,7 +665,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getMetadataChildren
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -622,7 +674,47 @@ actions:
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getMetadataChildren(1539.15, "Stream");
|
||||
const result = await plexAPI.library.getMetadataChildren(1539.14, "Stream");
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/posters"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getMediaPosters(16099);
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/posters"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.postMediaPoster(2268, "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b");
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
@@ -633,7 +725,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: image
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -655,35 +747,15 @@ actions:
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/onDeck"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getOnDeck
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getOnDeck();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/recentlyAdded"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: library
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { QueryParamIncludeMeta, QueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { QueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
@@ -708,9 +780,6 @@ actions:
|
||||
],
|
||||
sectionID: 2,
|
||||
type: QueryParamType.TvShow,
|
||||
includeMeta: QueryParamIncludeMeta.Enable,
|
||||
xPlexContainerStart: 0,
|
||||
xPlexContainerSize: 50,
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
@@ -722,10 +791,10 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: libraries
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { QueryParamIncludeCollections, QueryParamIncludeExternalMedia, SearchTypes } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { SearchTypes } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
@@ -738,8 +807,6 @@ actions:
|
||||
searchTypes: [
|
||||
SearchTypes.People,
|
||||
],
|
||||
includeCollections: QueryParamIncludeCollections.Enable,
|
||||
includeExternalMedia: QueryParamIncludeExternalMedia.Enable,
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
@@ -751,7 +818,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: libraries
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -771,7 +838,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: list
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -783,8 +850,6 @@ actions:
|
||||
async function run() {
|
||||
const result = await plexAPI.watchlist.getWatchList({
|
||||
filter: Filter.Available,
|
||||
xPlexContainerStart: 0,
|
||||
xPlexContainerSize: 50,
|
||||
xPlexToken: "CV5xoxjTpFKUzBTShsaf",
|
||||
});
|
||||
|
||||
@@ -797,7 +862,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: deleteLibrary
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -817,7 +882,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: details
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -832,12 +897,99 @@ actions:
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/actor"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetActorsLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getActorsLibrary(9518, GetActorsLibraryQueryParamType.TvShow);
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/all"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetAllMediaLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getAllMediaLibrary({
|
||||
sectionKey: 9518,
|
||||
type: GetAllMediaLibraryQueryParamType.TvShow,
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/country"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetCountriesLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getCountriesLibrary(9518, GetCountriesLibraryQueryParamType.TvShow);
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/genre"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetGenresLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getGenresLibrary(9518, GetGenresLibraryQueryParamType.TvShow);
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/refresh"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: metadata
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Force } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -858,7 +1010,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: library
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetSearchLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -879,15 +1031,10 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: items
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import {
|
||||
GetLibraryItemsQueryParamIncludeMeta,
|
||||
GetLibraryItemsQueryParamType,
|
||||
IncludeGuids,
|
||||
Tag,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetLibraryItemsQueryParamType, Tag } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
@@ -896,12 +1043,8 @@ actions:
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getLibraryItems({
|
||||
tag: Tag.Edition,
|
||||
includeGuids: IncludeGuids.Enable,
|
||||
type: GetLibraryItemsQueryParamType.TvShow,
|
||||
sectionKey: 9518,
|
||||
includeMeta: GetLibraryItemsQueryParamIncludeMeta.Enable,
|
||||
xPlexContainerStart: 0,
|
||||
xPlexContainerSize: 50,
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
@@ -913,7 +1056,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: logLine
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Level } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -934,7 +1077,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: logMultiLine
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -956,7 +1099,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: enablePaperTrail
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -976,7 +1119,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: providers
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -996,7 +1139,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getMyPlexAccount
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1016,7 +1159,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getResizedPhoto
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { MinSize, Upscale } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1045,7 +1188,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getPin
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1069,7 +1212,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getTokenByPinId
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1094,7 +1237,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getPlaylists
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1114,7 +1257,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: createPlaylist
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { CreatePlaylistQueryParamType, Smart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1140,7 +1283,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: uploadPlaylist
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { QueryParamForce } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1161,7 +1304,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: deletePlaylist
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1181,7 +1324,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getPlaylist
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1201,7 +1344,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: updatePlaylist
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1210,7 +1353,7 @@ actions:
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.playlists.updatePlaylist(3915.00);
|
||||
const result = await plexAPI.playlists.updatePlaylist(3915);
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
@@ -1221,7 +1364,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: clearPlaylistContents
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1241,7 +1384,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getPlaylistContents
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetPlaylistContentsQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1262,7 +1405,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: addPlaylistContents
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1271,7 +1414,7 @@ actions:
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.playlists.addPlaylistContents(8502.00, "server://12345/com.plexapp.plugins.library/library/metadata/1", 123);
|
||||
const result = await plexAPI.playlists.addPlaylistContents(8502.01, "server://12345/com.plexapp.plugins.library/library/metadata/1", 123);
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
@@ -1282,17 +1425,16 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: resources
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { IncludeHttps, IncludeIPv6, IncludeRelay } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.plex.getServerResources("3381b62b-9ab7-4e37-827b-203e9809eb58", IncludeHttps.Enable, IncludeRelay.Enable, IncludeIPv6.Enable);
|
||||
const result = await plexAPI.plex.getServerResources("3381b62b-9ab7-4e37-827b-203e9809eb58");
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
@@ -1303,7 +1445,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getSearchResults
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1323,7 +1465,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getSourceConnectionInformation
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1343,7 +1485,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getTransientToken
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1364,7 +1506,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getServerList
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1384,7 +1526,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getBandwidthStatistics
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1404,7 +1546,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getStatistics
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1424,7 +1566,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getResourcesStatistics
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1444,7 +1586,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getSessions
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1464,7 +1606,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getSessionHistory
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1484,7 +1626,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getTranscodeSessions
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1504,7 +1646,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: stopTranscodeSession
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1524,7 +1666,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: applyUpdates
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Skip, Tonight } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1545,7 +1687,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: checkForUpdates
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Download } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1566,7 +1708,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getUpdateStatus
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1586,7 +1728,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getTokenDetails
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1601,12 +1743,44 @@ actions:
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/users"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI();
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.users.getUsers({
|
||||
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||
clientName: "Plex for Roku",
|
||||
deviceNickname: "Roku 3",
|
||||
deviceName: "Chrome",
|
||||
deviceScreenResolution: "1487x1165,2560x1440",
|
||||
clientVersion: "2.4.1",
|
||||
platform: "Roku",
|
||||
clientFeatures: "external-media,indirect-media,hub-style-list",
|
||||
model: "4200X",
|
||||
xPlexSessionId: "97e136ef-4ddd-4ff3-89a7-a5820c96c2ca",
|
||||
xPlexLanguage: "en",
|
||||
platformVersion: "4.3 build 1057",
|
||||
xPlexToken: "CV5xoxjTpFKUzBTShsaf",
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/users/signin"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: data
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1635,7 +1809,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: startUniversalTranscode
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetOnDeckUnauthorized
|
||||
# GetActorsLibraryBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetActorsLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -14,5 +14,5 @@ import { GetOnDeckUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetOnDeckLibraryErrors](../../../sdk/models/errors/getondecklibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `errors` | [errors.GetActorsLibraryErrors](../../../sdk/models/errors/getactorslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMetaDataByRatingKeyErrors
|
||||
# GetActorsLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetaDataByRatingKeyErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetActorsLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetMetaDataByRatingKeyErrors = {
|
||||
let value: GetActorsLibraryErrors = {
|
||||
code: 1000,
|
||||
message: "X-Plex-Client-Identifier is missing",
|
||||
status: 400,
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMetaDataByRatingKeyLibraryErrors
|
||||
# GetActorsLibraryLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetaDataByRatingKeyLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetActorsLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetMetaDataByRatingKeyLibraryErrors = {
|
||||
let value: GetActorsLibraryLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
18
docs/sdk/models/errors/getactorslibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getactorslibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetActorsLibraryUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetActorsLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetActorsLibraryLibraryErrors](../../../sdk/models/errors/getactorslibrarylibraryerrors.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 |
|
||||
18
docs/sdk/models/errors/getallmedialibrarybadrequest.md
Normal file
18
docs/sdk/models/errors/getallmedialibrarybadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetAllMediaLibraryBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetAllMediaLibraryErrors](../../../sdk/models/errors/getallmedialibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
21
docs/sdk/models/errors/getallmedialibraryerrors.md
Normal file
21
docs/sdk/models/errors/getallmedialibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetAllMediaLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetAllMediaLibraryErrors = {
|
||||
code: 1000,
|
||||
message: "X-Plex-Client-Identifier is missing",
|
||||
status: 400,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/getallmedialibrarylibraryerrors.md
Normal file
21
docs/sdk/models/errors/getallmedialibrarylibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetAllMediaLibraryLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetAllMediaLibraryLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/getallmedialibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getallmedialibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetAllMediaLibraryUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetAllMediaLibraryLibraryErrors](../../../sdk/models/errors/getallmedialibrarylibraryerrors.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 |
|
||||
18
docs/sdk/models/errors/getcountrieslibrarybadrequest.md
Normal file
18
docs/sdk/models/errors/getcountrieslibrarybadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetCountriesLibraryBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetCountriesLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetCountriesLibraryErrors](../../../sdk/models/errors/getcountrieslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
21
docs/sdk/models/errors/getcountrieslibraryerrors.md
Normal file
21
docs/sdk/models/errors/getcountrieslibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetCountriesLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetCountriesLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetCountriesLibraryErrors = {
|
||||
code: 1000,
|
||||
message: "X-Plex-Client-Identifier is missing",
|
||||
status: 400,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/getcountrieslibrarylibraryerrors.md
Normal file
21
docs/sdk/models/errors/getcountrieslibrarylibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetCountriesLibraryLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetCountriesLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetCountriesLibraryLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/getcountrieslibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getcountrieslibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetCountriesLibraryUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetCountriesLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetCountriesLibraryLibraryErrors](../../../sdk/models/errors/getcountrieslibrarylibraryerrors.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 |
|
||||
18
docs/sdk/models/errors/getgenreslibrarybadrequest.md
Normal file
18
docs/sdk/models/errors/getgenreslibrarybadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetGenresLibraryBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGenresLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetGenresLibraryErrors](../../../sdk/models/errors/getgenreslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
21
docs/sdk/models/errors/getgenreslibraryerrors.md
Normal file
21
docs/sdk/models/errors/getgenreslibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetGenresLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGenresLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetGenresLibraryErrors = {
|
||||
code: 1000,
|
||||
message: "X-Plex-Client-Identifier is missing",
|
||||
status: 400,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/getgenreslibrarylibraryerrors.md
Normal file
21
docs/sdk/models/errors/getgenreslibrarylibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetGenresLibraryLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGenresLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetGenresLibraryLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/getgenreslibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getgenreslibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetGenresLibraryUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGenresLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetGenresLibraryLibraryErrors](../../../sdk/models/errors/getgenreslibrarylibraryerrors.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 |
|
||||
18
docs/sdk/models/errors/getmediametadatabadrequest.md
Normal file
18
docs/sdk/models/errors/getmediametadatabadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetMediaMetaDataBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetMediaMetaDataErrors](../../../sdk/models/errors/getmediametadataerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
21
docs/sdk/models/errors/getmediametadataerrors.md
Normal file
21
docs/sdk/models/errors/getmediametadataerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetMediaMetaDataErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetMediaMetaDataErrors = {
|
||||
code: 1000,
|
||||
message: "X-Plex-Client-Identifier is missing",
|
||||
status: 400,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/getmediametadatalibraryerrors.md
Normal file
21
docs/sdk/models/errors/getmediametadatalibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetMediaMetaDataLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetMediaMetaDataLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/getmediametadataunauthorized.md
Normal file
18
docs/sdk/models/errors/getmediametadataunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetMediaMetaDataUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetMediaMetaDataLibraryErrors](../../../sdk/models/errors/getmediametadatalibraryerrors.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 @@
|
||||
# GetMetaDataByRatingKeyBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetaDataByRatingKeyBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetMetaDataByRatingKeyErrors](../../../sdk/models/errors/getmetadatabyratingkeyerrors.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 @@
|
||||
# GetMetaDataByRatingKeyUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetaDataByRatingKeyUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetMetaDataByRatingKeyLibraryErrors](../../../sdk/models/errors/getmetadatabyratingkeylibraryerrors.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 @@
|
||||
# GetOnDeckBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetOnDeckErrors](../../../sdk/models/errors/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 |
|
||||
18
docs/sdk/models/errors/getusersbadrequest.md
Normal file
18
docs/sdk/models/errors/getusersbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetUsersBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetUsersBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetUsersErrors](../../../sdk/models/errors/getuserserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetOnDeckErrors
|
||||
# GetUsersErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetUsersErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetOnDeckErrors = {
|
||||
let value: GetUsersErrors = {
|
||||
code: 1000,
|
||||
message: "X-Plex-Client-Identifier is missing",
|
||||
status: 400,
|
||||
18
docs/sdk/models/errors/getusersunauthorized.md
Normal file
18
docs/sdk/models/errors/getusersunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetUsersUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetUsersUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetUsersUsersErrors](../../../sdk/models/errors/getusersuserserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetOnDeckLibraryErrors
|
||||
# GetUsersUsersErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetUsersUsersErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetOnDeckLibraryErrors = {
|
||||
let value: GetUsersUsersErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
@@ -6,7 +6,7 @@
|
||||
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddPlaylistContentsRequest = {
|
||||
playlistID: 6289.82,
|
||||
playlistID: 1207.42,
|
||||
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
||||
playQueueID: 123,
|
||||
};
|
||||
|
||||
@@ -7,7 +7,7 @@ import { AddPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operat
|
||||
|
||||
let value: AddPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 503,
|
||||
statusCode: 207,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
18
docs/sdk/models/operations/alllibraries.md
Normal file
18
docs/sdk/models/operations/alllibraries.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# AllLibraries
|
||||
|
||||
Indicates if the user has access to all libraries.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AllLibraries } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AllLibraries = AllLibraries.Enable;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
18
docs/sdk/models/operations/allowcameraupload.md
Normal file
18
docs/sdk/models/operations/allowcameraupload.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# AllowCameraUpload
|
||||
|
||||
Indicates if the user is allowed to upload from a camera.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AllowCameraUpload } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AllowCameraUpload = AllowCameraUpload.Enable;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
18
docs/sdk/models/operations/allowchannels.md
Normal file
18
docs/sdk/models/operations/allowchannels.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# AllowChannels
|
||||
|
||||
Indicates if the user has access to channels.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AllowChannels } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AllowChannels = AllowChannels.Enable;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
18
docs/sdk/models/operations/allowsubtitleadmin.md
Normal file
18
docs/sdk/models/operations/allowsubtitleadmin.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# AllowSubtitleAdmin
|
||||
|
||||
Indicates if the user can manage subtitles.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AllowSubtitleAdmin } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AllowSubtitleAdmin = AllowSubtitleAdmin.Enable;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
18
docs/sdk/models/operations/allowsync.md
Normal file
18
docs/sdk/models/operations/allowsync.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# AllowSync
|
||||
|
||||
Indicates if the user is allowed to sync media.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AllowSync } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AllowSync = AllowSync.Enable;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
18
docs/sdk/models/operations/allowtuners.md
Normal file
18
docs/sdk/models/operations/allowtuners.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# AllowTuners
|
||||
|
||||
Indicates if the user is allowed to use tuners.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AllowTuners } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AllowTuners = AllowTuners.Enable;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
@@ -7,7 +7,7 @@ import { ApplyUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ApplyUpdatesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 103,
|
||||
statusCode: 200,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { Billing } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Billing = {
|
||||
internalPaymentMethod: {},
|
||||
paymentMethodId: 374170,
|
||||
paymentMethodId: 395427,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { CancelServerActivitiesResponse } from "@lukehagar/plexjs/sdk/models/ope
|
||||
|
||||
let value: CancelServerActivitiesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 417,
|
||||
statusCode: 405,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { CheckForUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations
|
||||
|
||||
let value: CheckForUpdatesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 201,
|
||||
statusCode: 504,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ClearPlaylistContentsRequest = {
|
||||
playlistID: 3834.64,
|
||||
playlistID: 5077.01,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { ClearPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/oper
|
||||
|
||||
let value: ClearPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 307,
|
||||
statusCode: 504,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,12 +6,12 @@
|
||||
import { Collection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Collection = {
|
||||
tag: "Working NL Subs",
|
||||
tag: "My Awesome Collection",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||
@@ -7,9 +7,9 @@ import { Connections, Protocol } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Connections = {
|
||||
protocol: Protocol.Http,
|
||||
address: "21611 Schuster Cliffs",
|
||||
port: 54915,
|
||||
uri: "https://wobbly-instance.org/",
|
||||
address: "84577 W 9th Street",
|
||||
port: 40036,
|
||||
uri: "https://dearest-custom.net",
|
||||
local: false,
|
||||
relay: false,
|
||||
iPv6: false,
|
||||
|
||||
@@ -1,17 +1,23 @@
|
||||
# Country
|
||||
|
||||
The filter query string for country media items.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Country } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Country = {
|
||||
id: 259,
|
||||
tag: "United States of America",
|
||||
filter: "country=19",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 259 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||
| `filter` | *string* | :heavy_minus_sign: | N/A | country=19 |
|
||||
@@ -7,7 +7,7 @@ type of playlist to create
|
||||
```typescript
|
||||
import { CreatePlaylistQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Audio;
|
||||
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Photo;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -7,9 +7,9 @@ import { CreatePlaylistQueryParamType, CreatePlaylistRequest, Smart } from "@luk
|
||||
|
||||
let value: CreatePlaylistRequest = {
|
||||
title: "<value>",
|
||||
type: CreatePlaylistQueryParamType.Photo,
|
||||
smart: Smart.One,
|
||||
uri: "https://enchanted-disclosure.com/",
|
||||
type: CreatePlaylistQueryParamType.Audio,
|
||||
smart: Smart.Zero,
|
||||
uri: "https://courageous-futon.net",
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { CreatePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
||||
|
||||
let value: CreatePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 302,
|
||||
statusCode: 510,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { DeleteLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: DeleteLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 507,
|
||||
statusCode: 102,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: DeletePlaylistRequest = {
|
||||
playlistID: 5365.79,
|
||||
playlistID: 5840.32,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { DeletePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
||||
|
||||
let value: DeletePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 511,
|
||||
statusCode: 101,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,12 +6,12 @@
|
||||
import { Director } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Director = {
|
||||
tag: "James Cameron",
|
||||
tag: "Danny Boyle",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||
19
docs/sdk/models/operations/enablecreditsmarkergeneration.md
Normal file
19
docs/sdk/models/operations/enablecreditsmarkergeneration.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# EnableCreditsMarkerGeneration
|
||||
|
||||
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { EnableCreditsMarkerGeneration } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: EnableCreditsMarkerGeneration =
|
||||
EnableCreditsMarkerGeneration.LibraryDefault;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Disabled` | 0 |
|
||||
@@ -7,7 +7,7 @@ import { EnablePaperTrailResponse } from "@lukehagar/plexjs/sdk/models/operation
|
||||
|
||||
let value: EnablePaperTrailResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 203,
|
||||
statusCode: 416,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
19
docs/sdk/models/operations/episodesort.md
Normal file
19
docs/sdk/models/operations/episodesort.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# EpisodeSort
|
||||
|
||||
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { EpisodeSort } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: EpisodeSort = EpisodeSort.OldestFirst;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `OldestFirst` | 0 |
|
||||
| `NewestFirst` | 1 |
|
||||
@@ -1,16 +1,19 @@
|
||||
# FlattenSeasons
|
||||
|
||||
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { FlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: FlattenSeasons = FlattenSeasons.True;
|
||||
let value: FlattenSeasons = FlattenSeasons.Show;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `False` | 0 |
|
||||
| `True` | 1 |
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Hide` | 0 |
|
||||
| `Show` | 1 |
|
||||
@@ -10,13 +10,8 @@ let value: Friend = {
|
||||
friendlyName: "exampleUser",
|
||||
home: true,
|
||||
id: 0,
|
||||
restricted: false,
|
||||
sharedServers: [
|
||||
{},
|
||||
],
|
||||
sharedSources: [
|
||||
{},
|
||||
],
|
||||
sharedServers: [],
|
||||
sharedSources: [],
|
||||
status: Status.Accepted,
|
||||
thumb: "https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578",
|
||||
title: "username123",
|
||||
|
||||
@@ -1,17 +1,23 @@
|
||||
# Genre
|
||||
|
||||
The filter query string for similar items.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Genre } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Genre = {
|
||||
tag: "Adventure",
|
||||
id: 259,
|
||||
filter: "genre=19",
|
||||
tag: "Crime",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Adventure |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 259 |
|
||||
| `filter` | *string* | :heavy_check_mark: | N/A | genre=19 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||
@@ -12,11 +12,8 @@ let value: GeoData = {
|
||||
continentCode: "NA",
|
||||
country: "United States Virgin Islands",
|
||||
city: "Amsterdam",
|
||||
europeanUnionMember: true,
|
||||
timeZone: "America/St_Thomas",
|
||||
postalCode: "802",
|
||||
inPrivacyRestrictedCountry: true,
|
||||
inPrivacyRestrictedRegion: true,
|
||||
subdivisions: "Saint Thomas",
|
||||
coordinates: "18.3381, -64.8941",
|
||||
};
|
||||
|
||||
24
docs/sdk/models/operations/getactorslibrarydirectory.md
Normal file
24
docs/sdk/models/operations/getactorslibrarydirectory.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# GetActorsLibraryDirectory
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetActorsLibraryDirectory } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetActorsLibraryDirectory = {
|
||||
fastKey: "/library/sections/2/all?actor=134671",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
|
||||
key: "134671",
|
||||
title: "Aaron Paul",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `fastKey` | *string* | :heavy_check_mark: | A fast lookup key for the actor relative url. | /library/sections/2/all?actor=134671 |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the actor. | https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg |
|
||||
| `key` | *string* | :heavy_check_mark: | A unique key representing the actor. | 134671 |
|
||||
| `title` | *string* | :heavy_check_mark: | The name of the actor. | Aaron Paul |
|
||||
49
docs/sdk/models/operations/getactorslibrarymediacontainer.md
Normal file
49
docs/sdk/models/operations/getactorslibrarymediacontainer.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# GetActorsLibraryMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetActorsLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetActorsLibraryMediaContainer = {
|
||||
size: 50,
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
nocache: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
viewMode: "131131",
|
||||
directory: [
|
||||
{
|
||||
fastKey: "/library/sections/2/all?actor=134671",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
|
||||
key: "134671",
|
||||
title: "Aaron Paul",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||
| `viewMode` | *string* | :heavy_check_mark: | Identifier for the view mode. | 131131 |
|
||||
| `directory` | [operations.GetActorsLibraryDirectory](../../../sdk/models/operations/getactorslibrarydirectory.md)[] | :heavy_minus_sign: | An array of actor entries for media items. | |
|
||||
30
docs/sdk/models/operations/getactorslibraryqueryparamtype.md
Normal file
30
docs/sdk/models/operations/getactorslibraryqueryparamtype.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# GetActorsLibraryQueryParamType
|
||||
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetActorsLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetActorsLibraryQueryParamType =
|
||||
GetActorsLibraryQueryParamType.TvShow;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
19
docs/sdk/models/operations/getactorslibraryrequest.md
Normal file
19
docs/sdk/models/operations/getactorslibraryrequest.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# GetActorsLibraryRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetActorsLibraryQueryParamType, GetActorsLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetActorsLibraryRequest = {
|
||||
sectionKey: 9518,
|
||||
type: GetActorsLibraryQueryParamType.TvShow,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `type` | [operations.GetActorsLibraryQueryParamType](../../../sdk/models/operations/getactorslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
49
docs/sdk/models/operations/getactorslibraryresponse.md
Normal file
49
docs/sdk/models/operations/getactorslibraryresponse.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# GetActorsLibraryResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetActorsLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetActorsLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 101,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
nocache: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
viewMode: "131131",
|
||||
directory: [
|
||||
{
|
||||
fastKey: "/library/sections/2/all?actor=134671",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
|
||||
key: "134671",
|
||||
title: "Aaron Paul",
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## 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` | [operations.GetActorsLibraryResponseBody](../../../sdk/models/operations/getactorslibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||
41
docs/sdk/models/operations/getactorslibraryresponsebody.md
Normal file
41
docs/sdk/models/operations/getactorslibraryresponsebody.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# GetActorsLibraryResponseBody
|
||||
|
||||
Successful response containing media container data.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetActorsLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetActorsLibraryResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
nocache: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
viewMode: "131131",
|
||||
directory: [
|
||||
{
|
||||
fastKey: "/library/sections/2/all?actor=134671",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
|
||||
key: "134671",
|
||||
title: "Aaron Paul",
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.GetActorsLibraryMediaContainer](../../../sdk/models/operations/getactorslibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -3,33 +3,32 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllLibrariesDirectory } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetAllLibrariesDirectory, GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllLibrariesDirectory = {
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1705615584",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1743824484",
|
||||
filters: true,
|
||||
refreshing: false,
|
||||
thumb: "/:/resources/movie.png",
|
||||
refreshing: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
key: "1",
|
||||
type: "movie",
|
||||
type: GetAllLibrariesType.Movie,
|
||||
title: "Movies",
|
||||
agent: "tv.plex.agents.movie",
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
uuid: "e69655a2-ef48-4aba-bb19-01e7d3cc34d6",
|
||||
updatedAt: 1556281940,
|
||||
createdAt: 1556281940,
|
||||
scannedAt: 1556281940,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 1556281940,
|
||||
hidden: 0,
|
||||
contentChangedAt: 9173960,
|
||||
location: [
|
||||
{
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
path: "/Movies",
|
||||
},
|
||||
],
|
||||
};
|
||||
@@ -37,26 +36,26 @@ let value: GetAllLibrariesDirectory = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `composite` | *string* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
|
||||
| `filters` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `refreshing` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | 1 |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Movies |
|
||||
| `agent` | *string* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
|
||||
| `scanner` | *string* | :heavy_check_mark: | N/A | Plex Movie |
|
||||
| `language` | *string* | :heavy_check_mark: | N/A | en-US |
|
||||
| `uuid` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `updatedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `createdAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `scannedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `content` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `directory` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `contentChangedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `hidden` | *number* | :heavy_check_mark: | N/A | 0 |
|
||||
| `location` | [operations.GetAllLibrariesLocation](../../../sdk/models/operations/getalllibrarieslocation.md)[] | :heavy_check_mark: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||
| `composite` | *string* | :heavy_check_mark: | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
|
||||
| `filters` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `refreshing` | *boolean* | :heavy_check_mark: | Indicates whether the library is currently being refreshed or updated | true |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `key` | *string* | :heavy_check_mark: | The library key representing the unique identifier | 1 |
|
||||
| `type` | [operations.GetAllLibrariesType](../../../sdk/models/operations/getalllibrariestype.md) | :heavy_check_mark: | N/A | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | The title of the library | Movies |
|
||||
| `agent` | *string* | :heavy_check_mark: | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
|
||||
| `scanner` | *string* | :heavy_check_mark: | UNKNOWN | Plex Movie |
|
||||
| `language` | *string* | :heavy_check_mark: | The Plex library language that has been set | en-US |
|
||||
| `uuid` | *string* | :heavy_check_mark: | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-01e7d3cc34d6 |
|
||||
| `updatedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `createdAt` | *number* | :heavy_minus_sign: | N/A | 1556281940 |
|
||||
| `scannedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `content` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `directory` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `contentChangedAt` | *number* | :heavy_check_mark: | Timestamp (in seconds) representing the last time the content was modified.<br/>NOTE: Some Plex server have some absurd values for this field, like 8457612157633039800 so it should be int64<br/> | 9173960 |
|
||||
| `hidden` | [operations.Hidden](../../../sdk/models/operations/hidden.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `location` | [operations.GetAllLibrariesLocation](../../../sdk/models/operations/getalllibrarieslocation.md)[] | :heavy_check_mark: | N/A | |
|
||||
@@ -7,13 +7,13 @@ import { GetAllLibrariesLocation } from "@lukehagar/plexjs/sdk/models/operations
|
||||
|
||||
let value: GetAllLibrariesLocation = {
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
path: "/Movies",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 1 |
|
||||
| `path` | *string* | :heavy_check_mark: | N/A | /movies |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | The ID of the location. | 1 |
|
||||
| `path` | *string* | :heavy_check_mark: | The path to the media item. | /Movies |
|
||||
@@ -3,38 +3,37 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllLibrariesMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetAllLibrariesMediaContainer, GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllLibrariesMediaContainer = {
|
||||
size: 5,
|
||||
size: 50,
|
||||
allowSync: false,
|
||||
title1: "Plex Library",
|
||||
title1: "TV Series",
|
||||
directory: [
|
||||
{
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1705615584",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1743824484",
|
||||
filters: true,
|
||||
refreshing: false,
|
||||
thumb: "/:/resources/movie.png",
|
||||
refreshing: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
key: "1",
|
||||
type: "movie",
|
||||
type: GetAllLibrariesType.Movie,
|
||||
title: "Movies",
|
||||
agent: "tv.plex.agents.movie",
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
uuid: "e69655a2-ef48-4aba-bb19-01e7d3cc34d6",
|
||||
updatedAt: 1556281940,
|
||||
createdAt: 1556281940,
|
||||
scannedAt: 1556281940,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 1556281940,
|
||||
hidden: 0,
|
||||
contentChangedAt: 9173960,
|
||||
location: [
|
||||
{
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
path: "/Movies",
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -46,7 +45,7 @@ let value: GetAllLibrariesMediaContainer = {
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_check_mark: | N/A | 5 |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `title1` | *string* | :heavy_check_mark: | N/A | Plex Library |
|
||||
| `directory` | [operations.GetAllLibrariesDirectory](../../../sdk/models/operations/getalllibrariesdirectory.md)[] | :heavy_check_mark: | N/A | |
|
||||
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||
| `directory` | [operations.GetAllLibrariesDirectory](../../../sdk/models/operations/getalllibrariesdirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -3,45 +3,44 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllLibrariesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetAllLibrariesResponse, GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllLibrariesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 308,
|
||||
statusCode: 101,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 5,
|
||||
size: 50,
|
||||
allowSync: false,
|
||||
title1: "Plex Library",
|
||||
title1: "TV Series",
|
||||
directory: [
|
||||
{
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1705615584",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1743824484",
|
||||
filters: true,
|
||||
refreshing: false,
|
||||
thumb: "/:/resources/movie.png",
|
||||
refreshing: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
key: "1",
|
||||
type: "movie",
|
||||
type: GetAllLibrariesType.Movie,
|
||||
title: "Movies",
|
||||
agent: "tv.plex.agents.movie",
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
uuid: "e69655a2-ef48-4aba-bb19-01e7d3cc34d6",
|
||||
updatedAt: 1556281940,
|
||||
createdAt: 1556281940,
|
||||
scannedAt: 1556281940,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 1556281940,
|
||||
hidden: 0,
|
||||
contentChangedAt: 9173960,
|
||||
location: [
|
||||
{
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
path: "/Movies",
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
@@ -5,39 +5,38 @@ The libraries available on the Server
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllLibrariesResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetAllLibrariesResponseBody, GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllLibrariesResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 5,
|
||||
size: 50,
|
||||
allowSync: false,
|
||||
title1: "Plex Library",
|
||||
title1: "TV Series",
|
||||
directory: [
|
||||
{
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1705615584",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1743824484",
|
||||
filters: true,
|
||||
refreshing: false,
|
||||
thumb: "/:/resources/movie.png",
|
||||
refreshing: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
key: "1",
|
||||
type: "movie",
|
||||
type: GetAllLibrariesType.Movie,
|
||||
title: "Movies",
|
||||
agent: "tv.plex.agents.movie",
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
uuid: "e69655a2-ef48-4aba-bb19-01e7d3cc34d6",
|
||||
updatedAt: 1556281940,
|
||||
createdAt: 1556281940,
|
||||
scannedAt: 1556281940,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 1556281940,
|
||||
hidden: 0,
|
||||
contentChangedAt: 9173960,
|
||||
location: [
|
||||
{
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
path: "/Movies",
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -50,4 +49,4 @@ let value: GetAllLibrariesResponseBody = {
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.GetAllLibrariesMediaContainer](../../../sdk/models/operations/getalllibrariesmediacontainer.md) | :heavy_check_mark: | N/A |
|
||||
| `mediaContainer` | [operations.GetAllLibrariesMediaContainer](../../../sdk/models/operations/getalllibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
22
docs/sdk/models/operations/getalllibrariestype.md
Normal file
22
docs/sdk/models/operations/getalllibrariestype.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# GetAllLibrariesType
|
||||
|
||||
The library type
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllLibrariesType = GetAllLibrariesType.Movie;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
@@ -0,0 +1,20 @@
|
||||
# GetAllMediaLibraryActiveDirection
|
||||
|
||||
The direction of the sort. Can be either `asc` or `desc`.
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryActiveDirection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryActiveDirection =
|
||||
GetAllMediaLibraryActiveDirection.Ascending;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `Ascending` | asc |
|
||||
| `Descending` | desc |
|
||||
17
docs/sdk/models/operations/getallmedialibrarycollection.md
Normal file
17
docs/sdk/models/operations/getallmedialibrarycollection.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryCollection
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryCollection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryCollection = {
|
||||
tag: "My Awesome Collection",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||
17
docs/sdk/models/operations/getallmedialibrarycountry.md
Normal file
17
docs/sdk/models/operations/getallmedialibrarycountry.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryCountry
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryCountry } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryCountry = {
|
||||
tag: "United States of America",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||
@@ -0,0 +1,20 @@
|
||||
# GetAllMediaLibraryDefaultDirection
|
||||
|
||||
The direction of the sort. Can be either `asc` or `desc`.
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryDefaultDirection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryDefaultDirection =
|
||||
GetAllMediaLibraryDefaultDirection.Ascending;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `Ascending` | asc |
|
||||
| `Descending` | desc |
|
||||
17
docs/sdk/models/operations/getallmedialibrarydirector.md
Normal file
17
docs/sdk/models/operations/getallmedialibrarydirector.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryDirector
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryDirector } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryDirector = {
|
||||
tag: "Danny Boyle",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||
23
docs/sdk/models/operations/getallmedialibraryfield.md
Normal file
23
docs/sdk/models/operations/getallmedialibraryfield.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# GetAllMediaLibraryField
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryField } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryField = {
|
||||
key: "show.title",
|
||||
title: "Show Title",
|
||||
type: "string",
|
||||
subType: "rating",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | show.title |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Show Title |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | string |
|
||||
| `subType` | *string* | :heavy_minus_sign: | N/A | rating |
|
||||
24
docs/sdk/models/operations/getallmedialibraryfieldtype.md
Normal file
24
docs/sdk/models/operations/getallmedialibraryfieldtype.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# GetAllMediaLibraryFieldType
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryFieldType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryFieldType = {
|
||||
type: "tag",
|
||||
operator: [
|
||||
{
|
||||
key: "=",
|
||||
title: "is",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | tag |
|
||||
| `operator` | [operations.GetAllMediaLibraryOperator](../../../sdk/models/operations/getallmedialibraryoperator.md)[] | :heavy_check_mark: | N/A | |
|
||||
27
docs/sdk/models/operations/getallmedialibraryfilter.md
Normal file
27
docs/sdk/models/operations/getallmedialibraryfilter.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# GetAllMediaLibraryFilter
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryFilter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryFilter = {
|
||||
filter: "genre",
|
||||
filterType: "string",
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||
| `filter` | *string* | :heavy_check_mark: | N/A | genre |
|
||||
| `filterType` | *string* | :heavy_check_mark: | N/A | string |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Genre |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||
| `advanced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
17
docs/sdk/models/operations/getallmedialibrarygenre.md
Normal file
17
docs/sdk/models/operations/getallmedialibrarygenre.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryGenre
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryGenre } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryGenre = {
|
||||
tag: "Crime",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||
17
docs/sdk/models/operations/getallmedialibraryguids.md
Normal file
17
docs/sdk/models/operations/getallmedialibraryguids.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryGuids
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryGuids } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryGuids = {
|
||||
id: "tvdb://2337",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| `id` | *string* | :heavy_minus_sign: | The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337<br/> | tvdb://2337 |
|
||||
18
docs/sdk/models/operations/getallmedialibraryhasthumbnail.md
Normal file
18
docs/sdk/models/operations/getallmedialibraryhasthumbnail.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetAllMediaLibraryHasThumbnail
|
||||
|
||||
Indicates if the part has a thumbnail.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryHasThumbnail } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryHasThumbnail = GetAllMediaLibraryHasThumbnail.True;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `False` | 0 |
|
||||
| `True` | 1 |
|
||||
21
docs/sdk/models/operations/getallmedialibraryimage.md
Normal file
21
docs/sdk/models/operations/getallmedialibraryimage.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetAllMediaLibraryImage
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryImage, GetAllMediaLibraryLibraryResponseType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryImage = {
|
||||
alt: "Episode 1",
|
||||
type: GetAllMediaLibraryLibraryResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
|
||||
| `type` | [operations.GetAllMediaLibraryLibraryResponseType](../../../sdk/models/operations/getallmedialibrarylibraryresponsetype.md) | :heavy_check_mark: | N/A | background |
|
||||
| `url` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||
@@ -0,0 +1,20 @@
|
||||
# GetAllMediaLibraryLibraryOptimizedForStreaming
|
||||
|
||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `operations.GetAllMediaLibraryOptimizedForStreaming1`
|
||||
|
||||
```typescript
|
||||
const value: operations.GetAllMediaLibraryOptimizedForStreaming1 =
|
||||
GetAllMediaLibraryOptimizedForStreaming1.One;
|
||||
```
|
||||
|
||||
### `boolean`
|
||||
|
||||
```typescript
|
||||
const value: boolean = false;
|
||||
```
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
# GetAllMediaLibraryLibraryResponseType
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryLibraryResponseType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryLibraryResponseType =
|
||||
GetAllMediaLibraryLibraryResponseType.Background;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
23
docs/sdk/models/operations/getallmedialibrarylibrarytype.md
Normal file
23
docs/sdk/models/operations/getallmedialibrarylibrarytype.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# GetAllMediaLibraryLibraryType
|
||||
|
||||
The type of media content
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryLibraryType = GetAllMediaLibraryLibraryType.Movie;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
121
docs/sdk/models/operations/getallmedialibrarymedia.md
Normal file
121
docs/sdk/models/operations/getallmedialibrarymedia.md
Normal file
@@ -0,0 +1,121 @@
|
||||
# GetAllMediaLibraryMedia
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryMedia } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryMedia = {
|
||||
id: 387322,
|
||||
duration: 9610350,
|
||||
bitrate: 25512,
|
||||
width: 3840,
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
accessible: true,
|
||||
exists: true,
|
||||
id: 418385,
|
||||
key: "/library/parts/418385/1735864239/file.mkv",
|
||||
indexes: "sd",
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *number* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||
| `height` | *number* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||
| `aspectRatio` | *number* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||
| `audioChannels` | *number* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||
| `displayOffset` | *number* | :heavy_minus_sign: | N/A | 50 |
|
||||
| `audioCodec` | *string* | :heavy_minus_sign: | Audio codec used. | eac3 |
|
||||
| `videoCodec` | *string* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||
| `videoResolution` | *string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||
| `container` | *string* | :heavy_minus_sign: | File container type. | mkv |
|
||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||
| `hasVoiceActivity` | *boolean* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `optimizedForStreaming` | *operations.GetAllMediaLibraryOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `part` | [operations.GetAllMediaLibraryPart](../../../sdk/models/operations/getallmedialibrarypart.md)[] | :heavy_minus_sign: | An array of parts for this media item. | |
|
||||
307
docs/sdk/models/operations/getallmedialibrarymediacontainer.md
Normal file
307
docs/sdk/models/operations/getallmedialibrarymediacontainer.md
Normal file
@@ -0,0 +1,307 @@
|
||||
# GetAllMediaLibraryMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetAllMediaLibraryLibraryResponseType,
|
||||
GetAllMediaLibraryLibraryType,
|
||||
GetAllMediaLibraryMediaContainer,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetAllMediaLibraryMediaContainer = {
|
||||
size: 50,
|
||||
totalSize: 50,
|
||||
offset: 0,
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
librarySectionID: 2,
|
||||
librarySectionTitle: "TV Series",
|
||||
librarySectionUUID: "e69655a2-ef48-4aba-bb19-0cc34d1e7d36",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
thumb: "/:/resources/show.png",
|
||||
nocache: true,
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
meta: {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
{
|
||||
filter: "genre",
|
||||
filterType: "string",
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
title: "Title",
|
||||
},
|
||||
],
|
||||
field: [
|
||||
{
|
||||
key: "show.title",
|
||||
title: "Show Title",
|
||||
type: "string",
|
||||
subType: "rating",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
fieldType: [
|
||||
{
|
||||
type: "tag",
|
||||
operator: [
|
||||
{
|
||||
key: "=",
|
||||
title: "is",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
type: GetAllMediaLibraryLibraryType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
titleSort: "Whale",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||
+ "",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
index: 1,
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
seasonCount: 2022,
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
parentRatingKey: "66",
|
||||
grandparentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
parentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
viewCount: 1,
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
subtype: "clip",
|
||||
lastRatedAt: 1721813113,
|
||||
createdAtAccuracy: "epoch,local",
|
||||
createdAtTZOffset: "0",
|
||||
lastViewedAt: 1682752242,
|
||||
userRating: 10,
|
||||
image: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetAllMediaLibraryLibraryResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
media: [
|
||||
{
|
||||
id: 387322,
|
||||
duration: 9610350,
|
||||
bitrate: 25512,
|
||||
width: 3840,
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
accessible: true,
|
||||
exists: true,
|
||||
id: 418385,
|
||||
key: "/library/parts/418385/1735864239/file.mkv",
|
||||
indexes: "sd",
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
tag: "Crime",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "Jamie P. Hanson",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
tag: "Teller",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
{
|
||||
id: "tvdb://2337",
|
||||
},
|
||||
],
|
||||
collection: [
|
||||
{
|
||||
tag: "My Awesome Collection",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `totalSize` | *number* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
||||
| `offset` | *number* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||
| `content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `librarySectionID` | *number* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
||||
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
|
||||
| `librarySectionUUID` | *string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||
| `meta` | [operations.GetAllMediaLibraryMeta](../../../sdk/models/operations/getallmedialibrarymeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||
| `metadata` | [operations.GetAllMediaLibraryMetadata](../../../sdk/models/operations/getallmedialibrarymetadata.md)[] | :heavy_minus_sign: | An array of metadata items. | |
|
||||
68
docs/sdk/models/operations/getallmedialibrarymeta.md
Normal file
68
docs/sdk/models/operations/getallmedialibrarymeta.md
Normal file
@@ -0,0 +1,68 @@
|
||||
# GetAllMediaLibraryMeta
|
||||
|
||||
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryMeta } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryMeta = {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
{
|
||||
filter: "genre",
|
||||
filterType: "string",
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
title: "Title",
|
||||
},
|
||||
],
|
||||
field: [
|
||||
{
|
||||
key: "show.title",
|
||||
title: "Show Title",
|
||||
type: "string",
|
||||
subType: "rating",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
fieldType: [
|
||||
{
|
||||
type: "tag",
|
||||
operator: [
|
||||
{
|
||||
key: "=",
|
||||
title: "is",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [operations.GetAllMediaLibraryType](../../../sdk/models/operations/getallmedialibrarytype.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `fieldType` | [operations.GetAllMediaLibraryFieldType](../../../sdk/models/operations/getallmedialibraryfieldtype.md)[] | :heavy_minus_sign: | N/A |
|
||||
@@ -1,101 +1,175 @@
|
||||
# GetMetaDataByRatingKeyMetadata
|
||||
# GetAllMediaLibraryMetadata
|
||||
|
||||
Unknown
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetaDataByRatingKeyMetadata } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import {
|
||||
GetAllMediaLibraryLibraryResponseType,
|
||||
GetAllMediaLibraryLibraryType,
|
||||
GetAllMediaLibraryMetadata,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetMetaDataByRatingKeyMetadata = {
|
||||
ratingKey: "17",
|
||||
key: "/library/metadata/17",
|
||||
guid: "plex://movie/5d77683f6f4521001ea9dc53",
|
||||
studio: "Universal Pictures",
|
||||
type: "movie",
|
||||
title: "Serenity",
|
||||
librarySectionTitle: "Movies",
|
||||
librarySectionID: 1,
|
||||
librarySectionKey: "/library/sections/1",
|
||||
let value: GetAllMediaLibraryMetadata = {
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
type: GetAllMediaLibraryLibraryType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
titleSort: "Whale",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.",
|
||||
rating: 8.2,
|
||||
audienceRating: 9.1,
|
||||
year: 2005,
|
||||
tagline: "They aim to misbehave.",
|
||||
thumb: "/library/metadata/17/thumb/1705637165",
|
||||
art: "/library/metadata/17/art/1705637165",
|
||||
duration: 141417,
|
||||
originallyAvailableAt: new RFCDate("2005-09-29T00:00:00Z"),
|
||||
addedAt: 1705637164,
|
||||
updatedAt: 1705637165,
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||
+ "",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
index: 1,
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
seasonCount: 2022,
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
hasPremiumPrimaryExtra: "1",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
parentRatingKey: "66",
|
||||
grandparentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
parentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
viewCount: 1,
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
subtype: "clip",
|
||||
lastRatedAt: 1721813113,
|
||||
createdAtAccuracy: "epoch,local",
|
||||
createdAtTZOffset: "0",
|
||||
lastViewedAt: 1682752242,
|
||||
userRating: 10,
|
||||
image: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetAllMediaLibraryLibraryResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
media: [
|
||||
{
|
||||
id: 15,
|
||||
duration: 141417,
|
||||
bitrate: 2278,
|
||||
width: 1920,
|
||||
height: 814,
|
||||
id: 387322,
|
||||
duration: 9610350,
|
||||
bitrate: 25512,
|
||||
width: 3840,
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 2,
|
||||
audioCodec: "aac",
|
||||
videoCodec: "h264",
|
||||
videoResolution: "1080",
|
||||
container: "mp4",
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
optimizedForStreaming: 0,
|
||||
audioProfile: "lc",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
audioProfile: "dts",
|
||||
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",
|
||||
accessible: true,
|
||||
exists: true,
|
||||
id: 418385,
|
||||
key: "/library/parts/418385/1735864239/file.mkv",
|
||||
indexes: "sd",
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "high",
|
||||
stream: [
|
||||
{
|
||||
id: 29,
|
||||
streamType: 2,
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "aac",
|
||||
codec: "hevc",
|
||||
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,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
samplingRate: 44100,
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -104,69 +178,37 @@ let value: GetMetaDataByRatingKeyMetadata = {
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
id: 184,
|
||||
filter: "genre=184",
|
||||
tag: "Thriller",
|
||||
tag: "Crime",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
id: 116,
|
||||
filter: "country=116",
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "Jamie P. Hanson",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
tag: "Teller",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
{
|
||||
id: "tvdb://2337",
|
||||
},
|
||||
],
|
||||
ratings: [
|
||||
collection: [
|
||||
{
|
||||
image: "themoviedb://image.rating",
|
||||
value: 7.4,
|
||||
type: "audience",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
id: 130,
|
||||
filter: "director=130",
|
||||
tag: "Joss Whedon",
|
||||
tagKey: "5d776828880197001ec90e8f",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 132,
|
||||
filter: "writer=132",
|
||||
tag: "Joss Whedon",
|
||||
tagKey: "5d776828880197001ec90e8f",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 220,
|
||||
filter: "actor=220",
|
||||
tag: "Dennis Keiffer",
|
||||
tagKey: "5d77683554f42c001f8c4708",
|
||||
role: "Bar Guy (uncredited)",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 221,
|
||||
filter: "producer=221",
|
||||
tag: "Barry Mendel",
|
||||
tagKey: "5d776826961905001eb90e2b",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg",
|
||||
tag: "My Awesome Collection",
|
||||
},
|
||||
],
|
||||
};
|
||||
@@ -174,43 +216,69 @@ let value: GetMetaDataByRatingKeyMetadata = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 17 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/17 |
|
||||
| `guid` | *string* | :heavy_minus_sign: | N/A | plex://movie/5d77683f6f4521001ea9dc53 |
|
||||
| `studio` | *string* | :heavy_minus_sign: | N/A | Universal Pictures |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Serenity |
|
||||
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||
| `grandparentTitle` | *string* | :heavy_minus_sign: | The name of the album artist for the track when audio, and the name of the TV show for the episode when video. | |
|
||||
| `parentTitle` | *string* | :heavy_minus_sign: | The name of the album for the track when audio, and the name of the season for the episode when TV show. | |
|
||||
| `originalTitle` | *string* | :heavy_minus_sign: | The orginal untranslated name of the media item when non-english. | |
|
||||
| `index` | *number* | :heavy_minus_sign: | The index starting from 0 of this media item in the MetaData array. | |
|
||||
| `parentIndex` | *number* | :heavy_minus_sign: | The parent index starting from 0 of this media item in the parent MetaData array. | |
|
||||
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *string* | :heavy_minus_sign: | N/A | Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job. |
|
||||
| `rating` | *number* | :heavy_minus_sign: | N/A | 8.2 |
|
||||
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 9.1 |
|
||||
| `year` | *number* | :heavy_minus_sign: | N/A | 2005 |
|
||||
| `tagline` | *string* | :heavy_minus_sign: | N/A | They aim to misbehave. |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/17/thumb/1705637165 |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/17/art/1705637165 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2005-09-29 00:00:00 +0000 UTC |
|
||||
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1705637164 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705637165 |
|
||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `hasPremiumPrimaryExtra` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `ratingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `media` | [operations.GetMetaDataByRatingKeyMedia](../../../sdk/models/operations/getmetadatabyratingkeymedia.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | [operations.GetMetaDataByRatingKeyGenre](../../../sdk/models/operations/getmetadatabyratingkeygenre.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | [operations.GetMetaDataByRatingKeyCountry](../../../sdk/models/operations/getmetadatabyratingkeycountry.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | [operations.Guids](../../../sdk/models/operations/guids.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `ratings` | [operations.Ratings](../../../sdk/models/operations/ratings.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `director` | [operations.GetMetaDataByRatingKeyDirector](../../../sdk/models/operations/getmetadatabyratingkeydirector.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | [operations.GetMetaDataByRatingKeyWriter](../../../sdk/models/operations/getmetadatabyratingkeywriter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | [operations.GetMetaDataByRatingKeyRole](../../../sdk/models/operations/getmetadatabyratingkeyrole.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `producer` | [operations.Producer](../../../sdk/models/operations/producer.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. | 58683 |
|
||||
| `key` | *string* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
|
||||
| `guid` | *string* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `slug` | *string* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
||||
| `studio` | *string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
||||
| `type` | [operations.GetAllMediaLibraryLibraryType](../../../sdk/models/operations/getallmedialibrarylibrarytype.md) | :heavy_check_mark: | N/A | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||
| `titleSort` | *string* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
||||
| `contentRating` | *string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||
| `summary` | *string* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
|
||||
| `rating` | *number* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||||
| `audienceRating` | *number* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||
| `year` | *number* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||
| `tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||
| `thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||
| `theme` | *string* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
|
||||
| `index` | *number* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||||
| `leafCount` | *number* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||
| `viewedLeafCount` | *number* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||
| `childCount` | *number* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||
| `seasonCount` | *number* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||
| `duration` | *number* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
||||
| `addedAt` | *number* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||
| `chapterSource` | *string* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||||
| `primaryExtraKey` | *string* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||||
| `originalTitle` | *string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `parentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||||
| `grandparentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||||
| `parentGuid` | *string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentGuid` | *string* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentSlug` | *string* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||||
| `grandparentKey` | *string* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||||
| `parentKey` | *string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||
| `grandparentTitle` | *string* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||||
| `grandparentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `grandparentTheme` | *string* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||||
| `grandparentArt` | *string* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||||
| `parentTitle` | *string* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||||
| `parentIndex` | *number* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||
| `parentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `ratingImage` | *string* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||||
| `viewCount` | *number* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||||
| `viewOffset` | *number* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||
| `skipCount` | *number* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||||
| `subtype` | *string* | :heavy_minus_sign: | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
|
||||
| `lastRatedAt` | *number* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||
| `createdAtAccuracy` | *string* | :heavy_minus_sign: | The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). | epoch,local |
|
||||
| `createdAtTZOffset` | *string* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
|
||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||
| `userRating` | *number* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||
| `image` | [operations.GetAllMediaLibraryImage](../../../sdk/models/operations/getallmedialibraryimage.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `ultraBlurColors` | [operations.GetAllMediaLibraryUltraBlurColors](../../../sdk/models/operations/getallmedialibraryultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `media` | [operations.GetAllMediaLibraryMedia](../../../sdk/models/operations/getallmedialibrarymedia.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | [operations.GetAllMediaLibraryGenre](../../../sdk/models/operations/getallmedialibrarygenre.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | [operations.GetAllMediaLibraryCountry](../../../sdk/models/operations/getallmedialibrarycountry.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `director` | [operations.GetAllMediaLibraryDirector](../../../sdk/models/operations/getallmedialibrarydirector.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | [operations.GetAllMediaLibraryWriter](../../../sdk/models/operations/getallmedialibrarywriter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | [operations.GetAllMediaLibraryRole](../../../sdk/models/operations/getallmedialibraryrole.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | [operations.GetAllMediaLibraryGuids](../../../sdk/models/operations/getallmedialibraryguids.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | [operations.GetAllMediaLibraryCollection](../../../sdk/models/operations/getallmedialibrarycollection.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