mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
Compare commits
13 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
763aa8e800 | ||
|
|
7a950ea773 | ||
|
|
379a408d74 | ||
|
|
2712820397 | ||
|
|
c895213ae8 | ||
|
|
c473c9d326 | ||
|
|
3c13bba9de | ||
|
|
650c5043ef | ||
|
|
0234804578 | ||
|
|
60d913c8f9 | ||
|
|
8d9f4bbaf1 | ||
|
|
5d57cd7c34 | ||
|
|
1a8e227874 |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1,3 +1,5 @@
|
|||||||
|
/mcp-server
|
||||||
|
/bin
|
||||||
/.eslintcache
|
/.eslintcache
|
||||||
/.speakeasy/reports
|
/.speakeasy/reports
|
||||||
/react-query
|
/react-query
|
||||||
|
|||||||
@@ -4,6 +4,7 @@
|
|||||||
!/REACT_QUERY.md
|
!/REACT_QUERY.md
|
||||||
!/**/*.ts
|
!/**/*.ts
|
||||||
!/**/*.js
|
!/**/*.js
|
||||||
|
!/**/*.mjs
|
||||||
!/**/*.json
|
!/**/*.json
|
||||||
!/**/*.map
|
!/**/*.map
|
||||||
|
|
||||||
|
|||||||
File diff suppressed because one or more lines are too long
@@ -7,13 +7,15 @@ generation:
|
|||||||
useClassNamesForArrayFields: true
|
useClassNamesForArrayFields: true
|
||||||
fixes:
|
fixes:
|
||||||
nameResolutionDec2023: true
|
nameResolutionDec2023: true
|
||||||
|
nameResolutionFeb2025: false
|
||||||
parameterOrderingFeb2024: true
|
parameterOrderingFeb2024: true
|
||||||
requestResponseComponentNamesFeb2024: true
|
requestResponseComponentNamesFeb2024: true
|
||||||
|
securityFeb2025: false
|
||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
oAuth2PasswordEnabled: false
|
oAuth2PasswordEnabled: false
|
||||||
typescript:
|
typescript:
|
||||||
version: 0.33.0
|
version: 0.37.0
|
||||||
additionalDependencies:
|
additionalDependencies:
|
||||||
dependencies: {}
|
dependencies: {}
|
||||||
devDependencies: {}
|
devDependencies: {}
|
||||||
@@ -23,6 +25,7 @@ typescript:
|
|||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
defaultErrorName: SDKError
|
defaultErrorName: SDKError
|
||||||
enableCustomCodeRegions: false
|
enableCustomCodeRegions: false
|
||||||
|
enableMCPServer: true
|
||||||
enableReactQuery: false
|
enableReactQuery: false
|
||||||
enumFormat: enum
|
enumFormat: enum
|
||||||
flattenGlobalSecurity: true
|
flattenGlobalSecurity: true
|
||||||
@@ -36,6 +39,7 @@ typescript:
|
|||||||
shared: sdk/models/shared
|
shared: sdk/models/shared
|
||||||
webhooks: sdk/models/webhooks
|
webhooks: sdk/models/webhooks
|
||||||
inputModelSuffix: input
|
inputModelSuffix: input
|
||||||
|
jsonpath: legacy
|
||||||
maxMethodParams: 4
|
maxMethodParams: 4
|
||||||
methodArguments: require-security-and-request
|
methodArguments: require-security-and-request
|
||||||
moduleFormat: commonjs
|
moduleFormat: commonjs
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
speakeasyVersion: 1.487.0
|
speakeasyVersion: 1.535.1
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
@@ -9,20 +9,20 @@ sources:
|
|||||||
- main
|
- main
|
||||||
plexapi:
|
plexapi:
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64
|
sourceRevisionDigest: sha256:b2f9599237ceb13cf8f9c1693e38b290177b65fb389cebf0c3c60b8ef4778615
|
||||||
sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8
|
sourceBlobDigest: sha256:f8df9ef88ada992cd981d601e6c0b45cc82db76aba3d915c2f9d08f90c81ced9
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- speakeasy-sdk-regen-1738886999
|
- speakeasy-sdk-regen-1745021437
|
||||||
- 0.0.3
|
- 0.0.3
|
||||||
targets:
|
targets:
|
||||||
plexjs:
|
plexjs:
|
||||||
source: plexapi
|
source: plexapi
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64
|
sourceRevisionDigest: sha256:b2f9599237ceb13cf8f9c1693e38b290177b65fb389cebf0c3c60b8ef4778615
|
||||||
sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8
|
sourceBlobDigest: sha256:f8df9ef88ada992cd981d601e6c0b45cc82db76aba3d915c2f9d08f90c81ced9
|
||||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||||
codeSamplesRevisionDigest: sha256:cc0edeb64bf898493d4f7f9e628ac369bb39b63de609919e22052c030a54edec
|
codeSamplesRevisionDigest: sha256:86b4c9afc42dfef089cf6e9c6ad9f7df1060563fa04a7b1cdaa1f88b4c8cd902
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
@@ -43,3 +43,5 @@ workflow:
|
|||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||||
|
labelOverride:
|
||||||
|
fixedValue: PlexJS
|
||||||
|
|||||||
@@ -17,3 +17,5 @@ targets:
|
|||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||||
|
labelOverride:
|
||||||
|
fixedValue: PlexJS
|
||||||
|
|||||||
83
README.md
83
README.md
@@ -54,6 +54,7 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
|
|||||||
* [Authentication](#authentication)
|
* [Authentication](#authentication)
|
||||||
* [Requirements](#requirements)
|
* [Requirements](#requirements)
|
||||||
* [Standalone functions](#standalone-functions)
|
* [Standalone functions](#standalone-functions)
|
||||||
|
* [File uploads](#file-uploads)
|
||||||
* [Retries](#retries)
|
* [Retries](#retries)
|
||||||
* [Debugging](#debugging)
|
* [Debugging](#debugging)
|
||||||
* [Development](#development)
|
* [Development](#development)
|
||||||
@@ -159,6 +160,7 @@ run();
|
|||||||
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||||
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
* [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
|
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||||
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||||
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
||||||
@@ -166,9 +168,12 @@ run();
|
|||||||
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors 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
|
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||||
* [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
* [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
|
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||||
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
* [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)
|
### [log](docs/sdks/log/README.md)
|
||||||
|
|
||||||
@@ -343,13 +348,39 @@ In some rare cases, the SDK can fail to get a response from the server or even m
|
|||||||
### Server Variables
|
### 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:
|
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`
|
| Variable | Parameter | Supported Values | Default | Description |
|
||||||
* `port: string`
|
| ---------- | --------------------------------- | -------------------------- | --------------- | ---------------------------------------------- |
|
||||||
|
| `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
|
### 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
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -511,19 +542,23 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|||||||
- [`libraryDeleteLibrary`](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
- [`libraryDeleteLibrary`](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||||
- [`libraryGetActorsLibrary`](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
|
- [`libraryGetActorsLibrary`](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
|
||||||
- [`libraryGetAllLibraries`](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
- [`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
|
- [`libraryGetCountriesLibrary`](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
|
||||||
- [`libraryGetFileHash`](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
- [`libraryGetFileHash`](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||||
- [`libraryGetGenresLibrary`](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
- [`libraryGetGenresLibrary`](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
||||||
- [`libraryGetLibraryDetails`](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
- [`libraryGetLibraryDetails`](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||||
- [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
- [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||||
|
- [`libraryGetMediaArts`](docs/sdks/library/README.md#getmediaarts) - Get Media Background Artwork
|
||||||
- [`libraryGetMediaMetaData`](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
- [`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
|
- [`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
|
- [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
|
||||||
- [`libraryGetRefreshLibraryMetadata`](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
- [`libraryGetRefreshLibraryMetadata`](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||||
- [`libraryGetSearchAllLibraries`](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
- [`libraryGetSearchAllLibraries`](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||||
- [`libraryGetSearchLibrary`](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
- [`libraryGetSearchLibrary`](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||||
- [`libraryGetTopWatchedContent`](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
- [`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
|
- [`logEnablePaperTrail`](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
|
||||||
- [`logLogLine`](docs/sdks/log/README.md#logline) - Logging a single line message.
|
- [`logLogLine`](docs/sdks/log/README.md#logline) - Logging a single line message.
|
||||||
- [`logLogMultiLine`](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
|
- [`logLogMultiLine`](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
|
||||||
@@ -578,6 +613,42 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|||||||
</details>
|
</details>
|
||||||
<!-- End Standalone functions [standalone-funcs] -->
|
<!-- 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] -->
|
<!-- Start Retries [retries] -->
|
||||||
## Retries
|
## Retries
|
||||||
|
|
||||||
|
|||||||
100
RELEASES.md
100
RELEASES.md
@@ -1219,3 +1219,103 @@ Based on:
|
|||||||
- [typescript v0.33.0] .
|
- [typescript v0.33.0] .
|
||||||
### Releases
|
### Releases
|
||||||
- [NPM v0.33.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.33.0 - .
|
- [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 - .
|
||||||
|
|
||||||
|
## 2025-04-19 00:10:19
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.535.1 (2.585.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.37.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.37.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.37.0 - .
|
||||||
282
codeSamples.yaml
282
codeSamples.yaml
@@ -7,7 +7,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getServerCapabilities
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -27,7 +27,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getServerPreferences
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -47,7 +47,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: updatePlayProgress
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -67,7 +67,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: markPlayed
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -87,7 +87,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getTimeline
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { State } from "@lukehagar/plexjs/sdk/models/operations";
|
import { State } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -119,7 +119,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: markUnplayed
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -139,7 +139,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getServerActivities
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -159,7 +159,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: cancelServerActivities
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -179,7 +179,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: stopAllTasks
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -199,7 +199,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getButlerTasks
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -219,7 +219,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: startAllTasks
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -239,7 +239,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: stopTask
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { PathParamTaskName } from "@lukehagar/plexjs/sdk/models/operations";
|
import { PathParamTaskName } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -260,7 +260,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: startTask
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { TaskName } from "@lukehagar/plexjs/sdk/models/operations";
|
import { TaskName } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -281,7 +281,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getAvailableClients
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -301,7 +301,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getCompanionsData
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -321,7 +321,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getDevices
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -341,7 +341,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getUserFriends
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -361,7 +361,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getGeoData
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -379,7 +379,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getHomeData
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -399,7 +399,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getGlobalHubs
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -419,7 +419,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: added
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { Type } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Type } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -444,7 +444,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: performSearch
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -464,7 +464,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: performVoiceSearch
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -484,7 +484,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getLibraryHubs
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -504,7 +504,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: identity
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -522,7 +522,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getTopWatchedContent
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { GetTopWatchedContentQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetTopWatchedContentQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -543,7 +543,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getFileHash
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -563,7 +563,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: data
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -593,12 +593,52 @@ actions:
|
|||||||
console.log(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);
|
||||||
|
}
|
||||||
|
|
||||||
run();
|
run();
|
||||||
- target: $["paths"]["/library/metadata/{ratingKey}/banner"]["get"]
|
- target: $["paths"]["/library/metadata/{ratingKey}/banner"]["get"]
|
||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: image
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -625,7 +665,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getMetadataChildren
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -640,12 +680,52 @@ actions:
|
|||||||
console.log(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);
|
||||||
|
}
|
||||||
|
|
||||||
run();
|
run();
|
||||||
- target: $["paths"]["/library/metadata/{ratingKey}/thumb"]["get"]
|
- target: $["paths"]["/library/metadata/{ratingKey}/thumb"]["get"]
|
||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: image
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -667,32 +747,12 @@ actions:
|
|||||||
console.log(result);
|
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();
|
run();
|
||||||
- target: $["paths"]["/library/recentlyAdded"]["get"]
|
- target: $["paths"]["/library/recentlyAdded"]["get"]
|
||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: library
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { QueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { QueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -731,7 +791,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: libraries
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { SearchTypes } from "@lukehagar/plexjs/sdk/models/operations";
|
import { SearchTypes } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -758,7 +818,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: libraries
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -778,7 +838,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: list
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -802,7 +862,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: deleteLibrary
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -822,7 +882,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: details
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -842,7 +902,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: library
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { GetActorsLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetActorsLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -858,12 +918,36 @@ actions:
|
|||||||
console.log(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();
|
run();
|
||||||
- target: $["paths"]["/library/sections/{sectionKey}/country"]["get"]
|
- target: $["paths"]["/library/sections/{sectionKey}/country"]["get"]
|
||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: library
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { GetCountriesLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetCountriesLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -884,7 +968,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: library
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { GetGenresLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetGenresLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -905,7 +989,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: metadata
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { Force } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Force } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -926,7 +1010,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: library
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { GetSearchLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetSearchLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -947,7 +1031,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: items
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { GetLibraryItemsQueryParamType, Tag } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsQueryParamType, Tag } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -972,7 +1056,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: logLine
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { Level } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Level } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -993,7 +1077,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: logMultiLine
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1015,7 +1099,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: enablePaperTrail
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1035,7 +1119,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: providers
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1055,7 +1139,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getMyPlexAccount
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1075,7 +1159,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getResizedPhoto
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { MinSize, Upscale } from "@lukehagar/plexjs/sdk/models/operations";
|
import { MinSize, Upscale } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -1104,7 +1188,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getPin
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1128,7 +1212,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getTokenByPinId
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1153,7 +1237,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getPlaylists
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1173,7 +1257,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: createPlaylist
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { CreatePlaylistQueryParamType, Smart } from "@lukehagar/plexjs/sdk/models/operations";
|
import { CreatePlaylistQueryParamType, Smart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -1199,7 +1283,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: uploadPlaylist
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { QueryParamForce } from "@lukehagar/plexjs/sdk/models/operations";
|
import { QueryParamForce } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -1220,7 +1304,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: deletePlaylist
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1240,7 +1324,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getPlaylist
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1260,7 +1344,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: updatePlaylist
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1280,7 +1364,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: clearPlaylistContents
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1300,7 +1384,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getPlaylistContents
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { GetPlaylistContentsQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetPlaylistContentsQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -1321,7 +1405,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: addPlaylistContents
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1341,7 +1425,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: resources
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1361,7 +1445,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getSearchResults
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1381,7 +1465,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getSourceConnectionInformation
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1401,7 +1485,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getTransientToken
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -1422,7 +1506,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getServerList
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1442,7 +1526,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getBandwidthStatistics
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1462,7 +1546,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getStatistics
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1482,7 +1566,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getResourcesStatistics
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1502,7 +1586,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getSessions
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1522,7 +1606,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getSessionHistory
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1542,7 +1626,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getTranscodeSessions
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1562,7 +1646,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: stopTranscodeSession
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1582,7 +1666,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: applyUpdates
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { Skip, Tonight } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Skip, Tonight } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -1603,7 +1687,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: checkForUpdates
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { Download } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Download } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
@@ -1624,7 +1708,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getUpdateStatus
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1644,7 +1728,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: getTokenDetails
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1664,7 +1748,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: users
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1696,7 +1780,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: data
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
@@ -1725,7 +1809,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: typescript
|
- lang: typescript
|
||||||
label: startUniversalTranscode
|
label: PlexJS
|
||||||
source: |-
|
source: |-
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
|
|||||||
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 |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetOnDeckErrors
|
# GetAllMediaLibraryErrors
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetOnDeckErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetAllMediaLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetOnDeckErrors = {
|
let value: GetAllMediaLibraryErrors = {
|
||||||
code: 1000,
|
code: 1000,
|
||||||
message: "X-Plex-Client-Identifier is missing",
|
message: "X-Plex-Client-Identifier is missing",
|
||||||
status: 400,
|
status: 400,
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetOnDeckLibraryErrors
|
# GetAllMediaLibraryLibraryErrors
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetOnDeckLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
import { GetAllMediaLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||||
|
|
||||||
let value: GetOnDeckLibraryErrors = {
|
let value: GetAllMediaLibraryLibraryErrors = {
|
||||||
code: 1001,
|
code: 1001,
|
||||||
message: "User could not be authenticated",
|
message: "User could not be authenticated",
|
||||||
status: 401,
|
status: 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 |
|
||||||
@@ -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 |
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# GetOnDeckUnauthorized
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetOnDeckUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
|
||||||
|
|
||||||
// No examples available for this model
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | [errors.GetOnDeckLibraryErrors](../../../sdk/models/errors/getondecklibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
|
||||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
|
||||||
@@ -6,7 +6,7 @@
|
|||||||
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: AddPlaylistContentsRequest = {
|
let value: AddPlaylistContentsRequest = {
|
||||||
playlistID: 6874.88,
|
playlistID: 1207.42,
|
||||||
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
||||||
playQueueID: 123,
|
playQueueID: 123,
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { AddPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operat
|
|||||||
|
|
||||||
let value: AddPlaylistContentsResponse = {
|
let value: AddPlaylistContentsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 226,
|
statusCode: 207,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { ApplyUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: ApplyUpdatesResponse = {
|
let value: ApplyUpdatesResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 101,
|
statusCode: 200,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { Billing } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: Billing = {
|
let value: Billing = {
|
||||||
internalPaymentMethod: {},
|
internalPaymentMethod: {},
|
||||||
paymentMethodId: 517379,
|
paymentMethodId: 395427,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { CancelServerActivitiesResponse } from "@lukehagar/plexjs/sdk/models/ope
|
|||||||
|
|
||||||
let value: CancelServerActivitiesResponse = {
|
let value: CancelServerActivitiesResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 417,
|
statusCode: 405,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { CheckForUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations
|
|||||||
|
|
||||||
let value: CheckForUpdatesResponse = {
|
let value: CheckForUpdatesResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 205,
|
statusCode: 504,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: ClearPlaylistContentsRequest = {
|
let value: ClearPlaylistContentsRequest = {
|
||||||
playlistID: 7980.47,
|
playlistID: 5077.01,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { ClearPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/oper
|
|||||||
|
|
||||||
let value: ClearPlaylistContentsResponse = {
|
let value: ClearPlaylistContentsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 103,
|
statusCode: 504,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -6,12 +6,12 @@
|
|||||||
import { Collection } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Collection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: Collection = {
|
let value: Collection = {
|
||||||
tag: "Working NL Subs",
|
tag: "My Awesome Collection",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Working NL Subs |
|
| `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 = {
|
let value: Connections = {
|
||||||
protocol: Protocol.Http,
|
protocol: Protocol.Http,
|
||||||
address: "21611 Schuster Cliffs",
|
address: "84577 W 9th Street",
|
||||||
port: 54915,
|
port: 40036,
|
||||||
uri: "https://wobbly-instance.org/",
|
uri: "https://dearest-custom.net",
|
||||||
local: false,
|
local: false,
|
||||||
relay: false,
|
relay: false,
|
||||||
iPv6: false,
|
iPv6: false,
|
||||||
|
|||||||
@@ -1,17 +1,23 @@
|
|||||||
# Country
|
# Country
|
||||||
|
|
||||||
|
The filter query string for country media items.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { Country } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Country } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: Country = {
|
let value: Country = {
|
||||||
|
id: 259,
|
||||||
tag: "United States of America",
|
tag: "United States of America",
|
||||||
|
filter: "country=19",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||||
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America |
|
| `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,13 +7,16 @@ type of playlist to create
|
|||||||
```typescript
|
```typescript
|
||||||
import { CreatePlaylistQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { CreatePlaylistQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Audio;
|
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Photo;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||||
| ------- | ------- |
|
|
||||||
| `Audio` | audio |
|
| Name | Value |
|
||||||
| `Video` | video |
|
| ---------------------- | ---------------------- |
|
||||||
| `Photo` | photo |
|
| `Audio` | audio |
|
||||||
|
| `Video` | video |
|
||||||
|
| `Photo` | photo |
|
||||||
|
| - | `Unrecognized<string>` |
|
||||||
@@ -7,9 +7,9 @@ import { CreatePlaylistQueryParamType, CreatePlaylistRequest, Smart } from "@luk
|
|||||||
|
|
||||||
let value: CreatePlaylistRequest = {
|
let value: CreatePlaylistRequest = {
|
||||||
title: "<value>",
|
title: "<value>",
|
||||||
type: CreatePlaylistQueryParamType.Video,
|
type: CreatePlaylistQueryParamType.Audio,
|
||||||
smart: Smart.Zero,
|
smart: Smart.Zero,
|
||||||
uri: "https://humble-confusion.com",
|
uri: "https://courageous-futon.net",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { CreatePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
|||||||
|
|
||||||
let value: CreatePlaylistResponse = {
|
let value: CreatePlaylistResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 102,
|
statusCode: 510,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { DeleteLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: DeleteLibraryResponse = {
|
let value: DeleteLibraryResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 507,
|
statusCode: 102,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: DeletePlaylistRequest = {
|
let value: DeletePlaylistRequest = {
|
||||||
playlistID: 206.51,
|
playlistID: 5840.32,
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { DeletePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
|||||||
|
|
||||||
let value: DeletePlaylistResponse = {
|
let value: DeletePlaylistResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 409,
|
statusCode: 101,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -6,12 +6,12 @@
|
|||||||
import { Director } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Director } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: Director = {
|
let value: Director = {
|
||||||
tag: "James Cameron",
|
tag: "Danny Boyle",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||||
| `tag` | *string* | :heavy_minus_sign: | N/A | James Cameron |
|
| `tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||||
@@ -13,7 +13,10 @@ let value: EnableCreditsMarkerGeneration =
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||||
| ---------------- | ---------------- |
|
|
||||||
| `LibraryDefault` | -1 |
|
| Name | Value |
|
||||||
| `Disabled` | 0 |
|
| ---------------------- | ---------------------- |
|
||||||
|
| `LibraryDefault` | -1 |
|
||||||
|
| `Disabled` | 0 |
|
||||||
|
| - | `Unrecognized<string>` |
|
||||||
@@ -7,7 +7,7 @@ import { EnablePaperTrailResponse } from "@lukehagar/plexjs/sdk/models/operation
|
|||||||
|
|
||||||
let value: EnablePaperTrailResponse = {
|
let value: EnablePaperTrailResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 302,
|
statusCode: 416,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -12,8 +12,11 @@ let value: EpisodeSort = EpisodeSort.OldestFirst;
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||||
| ---------------- | ---------------- |
|
|
||||||
| `LibraryDefault` | -1 |
|
| Name | Value |
|
||||||
| `OldestFirst` | 0 |
|
| ---------------------- | ---------------------- |
|
||||||
| `NewestFirst` | 1 |
|
| `LibraryDefault` | -1 |
|
||||||
|
| `OldestFirst` | 0 |
|
||||||
|
| `NewestFirst` | 1 |
|
||||||
|
| - | `Unrecognized<string>` |
|
||||||
@@ -12,8 +12,11 @@ let value: Filter = Filter.Available;
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||||
| ----------- | ----------- |
|
|
||||||
| `All` | all |
|
| Name | Value |
|
||||||
| `Available` | available |
|
| ---------------------- | ---------------------- |
|
||||||
| `Released` | released |
|
| `All` | all |
|
||||||
|
| `Available` | available |
|
||||||
|
| `Released` | released |
|
||||||
|
| - | `Unrecognized<string>` |
|
||||||
@@ -12,8 +12,11 @@ let value: FlattenSeasons = FlattenSeasons.Show;
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||||
| ---------------- | ---------------- |
|
|
||||||
| `LibraryDefault` | -1 |
|
| Name | Value |
|
||||||
| `Hide` | 0 |
|
| ---------------------- | ---------------------- |
|
||||||
| `Show` | 1 |
|
| `LibraryDefault` | -1 |
|
||||||
|
| `Hide` | 0 |
|
||||||
|
| `Show` | 1 |
|
||||||
|
| - | `Unrecognized<string>` |
|
||||||
@@ -1,17 +1,23 @@
|
|||||||
# Genre
|
# Genre
|
||||||
|
|
||||||
|
The filter query string for similar items.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { Genre } from "@lukehagar/plexjs/sdk/models/operations";
|
import { Genre } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: Genre = {
|
let value: Genre = {
|
||||||
tag: "Adventure",
|
id: 259,
|
||||||
|
filter: "genre=19",
|
||||||
|
tag: "Crime",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Adventure |
|
| `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 |
|
||||||
@@ -34,7 +34,7 @@ let value: GetActorsLibraryMediaContainer = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||||
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
|
| `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 |
|
| `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 |
|
| `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 |
|
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
|
|||||||
@@ -19,12 +19,15 @@ let value: GetActorsLibraryQueryParamType =
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||||
| --------- | --------- |
|
|
||||||
| `Movie` | 1 |
|
| Name | Value |
|
||||||
| `TvShow` | 2 |
|
| ---------------------- | ---------------------- |
|
||||||
| `Season` | 3 |
|
| `Movie` | 1 |
|
||||||
| `Episode` | 4 |
|
| `TvShow` | 2 |
|
||||||
| `Audio` | 8 |
|
| `Season` | 3 |
|
||||||
| `Album` | 9 |
|
| `Episode` | 4 |
|
||||||
| `Track` | 10 |
|
| `Audio` | 8 |
|
||||||
|
| `Album` | 9 |
|
||||||
|
| `Track` | 10 |
|
||||||
|
| - | `Unrecognized<number>` |
|
||||||
@@ -7,7 +7,7 @@ import { GetActorsLibraryResponse } from "@lukehagar/plexjs/sdk/models/operation
|
|||||||
|
|
||||||
let value: GetActorsLibraryResponse = {
|
let value: GetActorsLibraryResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 413,
|
statusCode: 101,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -3,33 +3,32 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetAllLibrariesDirectory } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetAllLibrariesDirectory, GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetAllLibrariesDirectory = {
|
let value: GetAllLibrariesDirectory = {
|
||||||
allowSync: true,
|
allowSync: false,
|
||||||
art: "/:/resources/movie-fanart.jpg",
|
art: "/:/resources/show-fanart.jpg",
|
||||||
composite: "/library/sections/1/composite/1705615584",
|
composite: "/library/sections/1/composite/1743824484",
|
||||||
filters: true,
|
filters: true,
|
||||||
refreshing: false,
|
refreshing: true,
|
||||||
thumb: "/:/resources/movie.png",
|
thumb: "/:/resources/show.png",
|
||||||
key: "1",
|
key: "1",
|
||||||
type: "movie",
|
type: GetAllLibrariesType.Movie,
|
||||||
title: "Movies",
|
title: "Movies",
|
||||||
agent: "tv.plex.agents.movie",
|
agent: "tv.plex.agents.movie",
|
||||||
scanner: "Plex Movie",
|
scanner: "Plex Movie",
|
||||||
language: "en-US",
|
language: "en-US",
|
||||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
uuid: "e69655a2-ef48-4aba-bb19-01e7d3cc34d6",
|
||||||
updatedAt: 1556281940,
|
updatedAt: 1556281940,
|
||||||
createdAt: 1556281940,
|
createdAt: 1556281940,
|
||||||
scannedAt: 1556281940,
|
scannedAt: 1556281940,
|
||||||
content: true,
|
content: true,
|
||||||
directory: true,
|
directory: true,
|
||||||
contentChangedAt: 1556281940,
|
contentChangedAt: 9173960,
|
||||||
hidden: 0,
|
|
||||||
location: [
|
location: [
|
||||||
{
|
{
|
||||||
id: 1,
|
id: 1,
|
||||||
path: "/movies",
|
path: "/Movies",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
};
|
};
|
||||||
@@ -37,26 +36,26 @@ let value: GetAllLibrariesDirectory = {
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
| `composite` | *string* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
|
| `composite` | *string* | :heavy_check_mark: | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
|
||||||
| `filters` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `filters` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||||
| `refreshing` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `refreshing` | *boolean* | :heavy_check_mark: | Indicates whether the library is currently being refreshed or updated | true |
|
||||||
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
| `key` | *string* | :heavy_check_mark: | N/A | 1 |
|
| `key` | *string* | :heavy_check_mark: | The library key representing the unique identifier | 1 |
|
||||||
| `type` | *string* | :heavy_check_mark: | N/A | movie |
|
| `type` | [operations.GetAllLibrariesType](../../../sdk/models/operations/getalllibrariestype.md) | :heavy_check_mark: | N/A | movie |
|
||||||
| `title` | *string* | :heavy_check_mark: | N/A | Movies |
|
| `title` | *string* | :heavy_check_mark: | The title of the library | Movies |
|
||||||
| `agent` | *string* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
|
| `agent` | *string* | :heavy_check_mark: | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
|
||||||
| `scanner` | *string* | :heavy_check_mark: | N/A | Plex Movie |
|
| `scanner` | *string* | :heavy_check_mark: | UNKNOWN | Plex Movie |
|
||||||
| `language` | *string* | :heavy_check_mark: | N/A | en-US |
|
| `language` | *string* | :heavy_check_mark: | The Plex library language that has been set | en-US |
|
||||||
| `uuid` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
| `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 |
|
| `updatedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `createdAt` | *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 |
|
| `scannedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `content` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `content` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||||
| `directory` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `directory` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||||
| `contentChangedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
| `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` | *number* | :heavy_check_mark: | N/A | 0 |
|
| `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 | |
|
| `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 = {
|
let value: GetAllLibrariesLocation = {
|
||||||
id: 1,
|
id: 1,
|
||||||
path: "/movies",
|
path: "/Movies",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- |
|
||||||
| `id` | *number* | :heavy_check_mark: | N/A | 1 |
|
| `id` | *number* | :heavy_check_mark: | The ID of the location. | 1 |
|
||||||
| `path` | *string* | :heavy_check_mark: | N/A | /movies |
|
| `path` | *string* | :heavy_check_mark: | The path to the media item. | /Movies |
|
||||||
@@ -3,38 +3,37 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetAllLibrariesMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetAllLibrariesMediaContainer, GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetAllLibrariesMediaContainer = {
|
let value: GetAllLibrariesMediaContainer = {
|
||||||
size: 5,
|
size: 50,
|
||||||
allowSync: false,
|
allowSync: false,
|
||||||
title1: "Plex Library",
|
title1: "TV Series",
|
||||||
directory: [
|
directory: [
|
||||||
{
|
{
|
||||||
allowSync: true,
|
allowSync: false,
|
||||||
art: "/:/resources/movie-fanart.jpg",
|
art: "/:/resources/show-fanart.jpg",
|
||||||
composite: "/library/sections/1/composite/1705615584",
|
composite: "/library/sections/1/composite/1743824484",
|
||||||
filters: true,
|
filters: true,
|
||||||
refreshing: false,
|
refreshing: true,
|
||||||
thumb: "/:/resources/movie.png",
|
thumb: "/:/resources/show.png",
|
||||||
key: "1",
|
key: "1",
|
||||||
type: "movie",
|
type: GetAllLibrariesType.Movie,
|
||||||
title: "Movies",
|
title: "Movies",
|
||||||
agent: "tv.plex.agents.movie",
|
agent: "tv.plex.agents.movie",
|
||||||
scanner: "Plex Movie",
|
scanner: "Plex Movie",
|
||||||
language: "en-US",
|
language: "en-US",
|
||||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
uuid: "e69655a2-ef48-4aba-bb19-01e7d3cc34d6",
|
||||||
updatedAt: 1556281940,
|
updatedAt: 1556281940,
|
||||||
createdAt: 1556281940,
|
createdAt: 1556281940,
|
||||||
scannedAt: 1556281940,
|
scannedAt: 1556281940,
|
||||||
content: true,
|
content: true,
|
||||||
directory: true,
|
directory: true,
|
||||||
contentChangedAt: 1556281940,
|
contentChangedAt: 9173960,
|
||||||
hidden: 0,
|
|
||||||
location: [
|
location: [
|
||||||
{
|
{
|
||||||
id: 1,
|
id: 1,
|
||||||
path: "/movies",
|
path: "/Movies",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
@@ -46,7 +45,7 @@ let value: GetAllLibrariesMediaContainer = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||||
| `size` | *number* | :heavy_check_mark: | N/A | 5 |
|
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `title1` | *string* | :heavy_check_mark: | N/A | Plex Library |
|
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
| `directory` | [operations.GetAllLibrariesDirectory](../../../sdk/models/operations/getalllibrariesdirectory.md)[] | :heavy_check_mark: | N/A | |
|
| `directory` | [operations.GetAllLibrariesDirectory](../../../sdk/models/operations/getalllibrariesdirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
@@ -3,45 +3,44 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetAllLibrariesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetAllLibrariesResponse, GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetAllLibrariesResponse = {
|
let value: GetAllLibrariesResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 308,
|
statusCode: 101,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
object: {
|
object: {
|
||||||
mediaContainer: {
|
mediaContainer: {
|
||||||
size: 5,
|
size: 50,
|
||||||
allowSync: false,
|
allowSync: false,
|
||||||
title1: "Plex Library",
|
title1: "TV Series",
|
||||||
directory: [
|
directory: [
|
||||||
{
|
{
|
||||||
allowSync: true,
|
allowSync: false,
|
||||||
art: "/:/resources/movie-fanart.jpg",
|
art: "/:/resources/show-fanart.jpg",
|
||||||
composite: "/library/sections/1/composite/1705615584",
|
composite: "/library/sections/1/composite/1743824484",
|
||||||
filters: true,
|
filters: true,
|
||||||
refreshing: false,
|
refreshing: true,
|
||||||
thumb: "/:/resources/movie.png",
|
thumb: "/:/resources/show.png",
|
||||||
key: "1",
|
key: "1",
|
||||||
type: "movie",
|
type: GetAllLibrariesType.Movie,
|
||||||
title: "Movies",
|
title: "Movies",
|
||||||
agent: "tv.plex.agents.movie",
|
agent: "tv.plex.agents.movie",
|
||||||
scanner: "Plex Movie",
|
scanner: "Plex Movie",
|
||||||
language: "en-US",
|
language: "en-US",
|
||||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
uuid: "e69655a2-ef48-4aba-bb19-01e7d3cc34d6",
|
||||||
updatedAt: 1556281940,
|
updatedAt: 1556281940,
|
||||||
createdAt: 1556281940,
|
createdAt: 1556281940,
|
||||||
scannedAt: 1556281940,
|
scannedAt: 1556281940,
|
||||||
content: true,
|
content: true,
|
||||||
directory: true,
|
directory: true,
|
||||||
contentChangedAt: 1556281940,
|
contentChangedAt: 9173960,
|
||||||
hidden: 0,
|
|
||||||
location: [
|
location: [
|
||||||
{
|
{
|
||||||
id: 1,
|
id: 1,
|
||||||
path: "/movies",
|
path: "/Movies",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -5,39 +5,38 @@ The libraries available on the Server
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetAllLibrariesResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetAllLibrariesResponseBody, GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetAllLibrariesResponseBody = {
|
let value: GetAllLibrariesResponseBody = {
|
||||||
mediaContainer: {
|
mediaContainer: {
|
||||||
size: 5,
|
size: 50,
|
||||||
allowSync: false,
|
allowSync: false,
|
||||||
title1: "Plex Library",
|
title1: "TV Series",
|
||||||
directory: [
|
directory: [
|
||||||
{
|
{
|
||||||
allowSync: true,
|
allowSync: false,
|
||||||
art: "/:/resources/movie-fanart.jpg",
|
art: "/:/resources/show-fanart.jpg",
|
||||||
composite: "/library/sections/1/composite/1705615584",
|
composite: "/library/sections/1/composite/1743824484",
|
||||||
filters: true,
|
filters: true,
|
||||||
refreshing: false,
|
refreshing: true,
|
||||||
thumb: "/:/resources/movie.png",
|
thumb: "/:/resources/show.png",
|
||||||
key: "1",
|
key: "1",
|
||||||
type: "movie",
|
type: GetAllLibrariesType.Movie,
|
||||||
title: "Movies",
|
title: "Movies",
|
||||||
agent: "tv.plex.agents.movie",
|
agent: "tv.plex.agents.movie",
|
||||||
scanner: "Plex Movie",
|
scanner: "Plex Movie",
|
||||||
language: "en-US",
|
language: "en-US",
|
||||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
uuid: "e69655a2-ef48-4aba-bb19-01e7d3cc34d6",
|
||||||
updatedAt: 1556281940,
|
updatedAt: 1556281940,
|
||||||
createdAt: 1556281940,
|
createdAt: 1556281940,
|
||||||
scannedAt: 1556281940,
|
scannedAt: 1556281940,
|
||||||
content: true,
|
content: true,
|
||||||
directory: true,
|
directory: true,
|
||||||
contentChangedAt: 1556281940,
|
contentChangedAt: 9173960,
|
||||||
hidden: 0,
|
|
||||||
location: [
|
location: [
|
||||||
{
|
{
|
||||||
id: 1,
|
id: 1,
|
||||||
path: "/movies",
|
path: "/Movies",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
@@ -50,4 +49,4 @@ let value: GetAllLibrariesResponseBody = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| 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 |
|
||||||
25
docs/sdk/models/operations/getalllibrariestype.md
Normal file
25
docs/sdk/models/operations/getalllibrariestype.md
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
# GetAllLibrariesType
|
||||||
|
|
||||||
|
The library type
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetAllLibrariesType = GetAllLibrariesType.Movie;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------------- | ---------------------- |
|
||||||
|
| `Movie` | movie |
|
||||||
|
| `TvShow` | show |
|
||||||
|
| `Season` | season |
|
||||||
|
| `Episode` | episode |
|
||||||
|
| `Artist` | artist |
|
||||||
|
| `Album` | album |
|
||||||
|
| - | `Unrecognized<string>` |
|
||||||
@@ -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,22 @@
|
|||||||
|
# GetAllMediaLibraryLibraryResponseType
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllMediaLibraryLibraryResponseType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibraryLibraryResponseType =
|
||||||
|
GetAllMediaLibraryLibraryResponseType.Background;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------------- | ---------------------- |
|
||||||
|
| `CoverPoster` | coverPoster |
|
||||||
|
| `Background` | background |
|
||||||
|
| `Snapshot` | snapshot |
|
||||||
|
| `ClearLogo` | clearLogo |
|
||||||
|
| - | `Unrecognized<string>` |
|
||||||
26
docs/sdk/models/operations/getallmedialibrarylibrarytype.md
Normal file
26
docs/sdk/models/operations/getallmedialibrarylibrarytype.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# GetAllMediaLibraryLibraryType
|
||||||
|
|
||||||
|
The type of media content
|
||||||
|
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllMediaLibraryLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibraryLibraryType = GetAllMediaLibraryLibraryType.Movie;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------------- | ---------------------- |
|
||||||
|
| `Movie` | movie |
|
||||||
|
| `TvShow` | show |
|
||||||
|
| `Season` | season |
|
||||||
|
| `Episode` | episode |
|
||||||
|
| `Artist` | artist |
|
||||||
|
| `Album` | album |
|
||||||
|
| - | `Unrecognized<string>` |
|
||||||
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 |
|
||||||
284
docs/sdk/models/operations/getallmedialibrarymetadata.md
Normal file
284
docs/sdk/models/operations/getallmedialibrarymetadata.md
Normal file
@@ -0,0 +1,284 @@
|
|||||||
|
# GetAllMediaLibraryMetadata
|
||||||
|
|
||||||
|
Unknown
|
||||||
|
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import {
|
||||||
|
GetAllMediaLibraryLibraryResponseType,
|
||||||
|
GetAllMediaLibraryLibraryType,
|
||||||
|
GetAllMediaLibraryMetadata,
|
||||||
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||||
|
|
||||||
|
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:
|
||||||
|
"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 |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `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 | |
|
||||||
19
docs/sdk/models/operations/getallmedialibraryoperator.md
Normal file
19
docs/sdk/models/operations/getallmedialibraryoperator.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# GetAllMediaLibraryOperator
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllMediaLibraryOperator } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibraryOperator = {
|
||||||
|
key: "=",
|
||||||
|
title: "is",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | N/A | = |
|
||||||
|
| `title` | *string* | :heavy_check_mark: | N/A | is |
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
# GetAllMediaLibraryOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### `operations.OptimizedForStreaming1`
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const value: operations.OptimizedForStreaming1 = OptimizedForStreaming1.One;
|
||||||
|
```
|
||||||
|
|
||||||
|
### `boolean`
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const value: boolean = false;
|
||||||
|
```
|
||||||
|
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
# GetAllMediaLibraryOptimizedForStreaming1
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllMediaLibraryOptimizedForStreaming1 } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibraryOptimizedForStreaming1 =
|
||||||
|
GetAllMediaLibraryOptimizedForStreaming1.One;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `Zero` | 0 |
|
||||||
|
| `One` | 1 |
|
||||||
97
docs/sdk/models/operations/getallmedialibrarypart.md
Normal file
97
docs/sdk/models/operations/getallmedialibrarypart.md
Normal file
@@ -0,0 +1,97 @@
|
|||||||
|
# GetAllMediaLibraryPart
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllMediaLibraryPart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibraryPart = {
|
||||||
|
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 |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `accessible` | *boolean* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||||
|
| `exists` | *boolean* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||||
|
| `indexes` | *string* | :heavy_minus_sign: | N/A | sd |
|
||||||
|
| `duration` | *number* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||||
|
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||||
|
| `size` | *number* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
||||||
|
| `packetLength` | *number* | :heavy_minus_sign: | N/A | 188 |
|
||||||
|
| `container` | *string* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||||
|
| `videoProfile` | *string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||||
|
| `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
|
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `optimizedForStreaming` | *operations.GetAllMediaLibraryLibraryOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
|
| `hasThumbnail` | [operations.GetAllMediaLibraryHasThumbnail](../../../sdk/models/operations/getallmedialibraryhasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `stream` | [operations.GetAllMediaLibraryStream](../../../sdk/models/operations/getallmedialibrarystream.md)[] | :heavy_minus_sign: | An array of streams for this part. | |
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
# GetAllMediaLibraryQueryParamIncludeMeta
|
||||||
|
|
||||||
|
Adds the Meta object to the response
|
||||||
|
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllMediaLibraryQueryParamIncludeMeta } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibraryQueryParamIncludeMeta =
|
||||||
|
GetAllMediaLibraryQueryParamIncludeMeta.Enable;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
# GetAllMediaLibraryQueryParamType
|
||||||
|
|
||||||
|
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 { GetAllMediaLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibraryQueryParamType =
|
||||||
|
GetAllMediaLibraryQueryParamType.TvShow;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------------- | ---------------------- |
|
||||||
|
| `Movie` | 1 |
|
||||||
|
| `TvShow` | 2 |
|
||||||
|
| `Season` | 3 |
|
||||||
|
| `Episode` | 4 |
|
||||||
|
| `Audio` | 8 |
|
||||||
|
| `Album` | 9 |
|
||||||
|
| `Track` | 10 |
|
||||||
|
| - | `Unrecognized<number>` |
|
||||||
26
docs/sdk/models/operations/getallmedialibraryrequest.md
Normal file
26
docs/sdk/models/operations/getallmedialibraryrequest.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# GetAllMediaLibraryRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllMediaLibraryQueryParamType, GetAllMediaLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibraryRequest = {
|
||||||
|
sectionKey: 9518,
|
||||||
|
type: GetAllMediaLibraryQueryParamType.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.GetAllMediaLibraryQueryParamType](../../../sdk/models/operations/getallmedialibraryqueryparamtype.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 |
|
||||||
|
| `includeMeta` | [operations.GetAllMediaLibraryQueryParamIncludeMeta](../../../sdk/models/operations/getallmedialibraryqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||||
|
| `includeGuids` | [operations.QueryParamIncludeGuids](../../../sdk/models/operations/queryparamincludeguids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
|
||||||
|
| `includeAdvanced` | [operations.IncludeAdvanced](../../../sdk/models/operations/includeadvanced.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `includeCollections` | [operations.QueryParamIncludeCollections](../../../sdk/models/operations/queryparamincludecollections.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `includeExternalMedia` | [operations.QueryParamIncludeExternalMedia](../../../sdk/models/operations/queryparamincludeexternalmedia.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `xPlexContainerStart` | *number* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
||||||
|
| `xPlexContainerSize` | *number* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
||||||
301
docs/sdk/models/operations/getallmedialibraryresponse.md
Normal file
301
docs/sdk/models/operations/getallmedialibraryresponse.md
Normal file
@@ -0,0 +1,301 @@
|
|||||||
|
# GetAllMediaLibraryResponse
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import {
|
||||||
|
GetAllMediaLibraryLibraryResponseType,
|
||||||
|
GetAllMediaLibraryLibraryType,
|
||||||
|
GetAllMediaLibraryResponse,
|
||||||
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibraryResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 505,
|
||||||
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
}),
|
||||||
|
object: {
|
||||||
|
mediaContainer: {
|
||||||
|
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 |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `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.GetAllMediaLibraryResponseBody](../../../sdk/models/operations/getallmedialibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||||
293
docs/sdk/models/operations/getallmedialibraryresponsebody.md
Normal file
293
docs/sdk/models/operations/getallmedialibraryresponsebody.md
Normal file
@@ -0,0 +1,293 @@
|
|||||||
|
# GetAllMediaLibraryResponseBody
|
||||||
|
|
||||||
|
Successful response containing media container data.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import {
|
||||||
|
GetAllMediaLibraryLibraryResponseType,
|
||||||
|
GetAllMediaLibraryLibraryType,
|
||||||
|
GetAllMediaLibraryResponseBody,
|
||||||
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibraryResponseBody = {
|
||||||
|
mediaContainer: {
|
||||||
|
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 |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `mediaContainer` | [operations.GetAllMediaLibraryMediaContainer](../../../sdk/models/operations/getallmedialibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
17
docs/sdk/models/operations/getallmedialibraryrole.md
Normal file
17
docs/sdk/models/operations/getallmedialibraryrole.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetAllMediaLibraryRole
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllMediaLibraryRole } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibraryRole = {
|
||||||
|
tag: "Teller",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||||
|
| `tag` | *string* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
|
||||||
29
docs/sdk/models/operations/getallmedialibrarysort.md
Normal file
29
docs/sdk/models/operations/getallmedialibrarysort.md
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
# GetAllMediaLibrarySort
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllMediaLibrarySort } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibrarySort = {
|
||||||
|
default: "asc",
|
||||||
|
active: false,
|
||||||
|
descKey: "titleSort:desc",
|
||||||
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
|
key: "titleSort",
|
||||||
|
title: "Title",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `default` | *string* | :heavy_minus_sign: | N/A | asc |
|
||||||
|
| `active` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `activeDirection` | [operations.GetAllMediaLibraryActiveDirection](../../../sdk/models/operations/getallmedialibraryactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||||
|
| `defaultDirection` | [operations.GetAllMediaLibraryDefaultDirection](../../../sdk/models/operations/getallmedialibrarydefaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||||
|
| `descKey` | *string* | :heavy_minus_sign: | N/A | titleSort:desc |
|
||||||
|
| `firstCharacterKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | N/A | titleSort |
|
||||||
|
| `title` | *string* | :heavy_check_mark: | N/A | Title |
|
||||||
113
docs/sdk/models/operations/getallmedialibrarystream.md
Normal file
113
docs/sdk/models/operations/getallmedialibrarystream.md
Normal file
@@ -0,0 +1,113 @@
|
|||||||
|
# GetAllMediaLibraryStream
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllMediaLibraryStream } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibraryStream = {
|
||||||
|
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 stream identifier. | 1002625 |
|
||||||
|
| `streamType` | *number* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
|
||||||
|
| `default` | *boolean* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||||
|
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||||
|
| `index` | *number* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||||
|
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||||
|
| `language` | *string* | :heavy_minus_sign: | Language of the stream. | English |
|
||||||
|
| `languageTag` | *string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||||
|
| `languageCode` | *string* | :heavy_minus_sign: | ISO language code. | eng |
|
||||||
|
| `headerCompression` | *boolean* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||||
|
| `doviblCompatID` | *number* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||||
|
| `doviblPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||||
|
| `dovielPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||||
|
| `doviLevel` | *number* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||||
|
| `doviPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||||
|
| `doviProfile` | *number* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||||
|
| `dovirpuPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||||
|
| `doviVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||||
|
| `bitDepth` | *number* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||||
|
| `chromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||||
|
| `chromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||||
|
| `codedHeight` | *number* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||||
|
| `codedWidth` | *number* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||||
|
| `closedCaptions` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `colorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||||
|
| `colorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||||
|
| `colorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||||
|
| `colorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||||
|
| `frameRate` | *number* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||||
|
| `height` | *number* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||||
|
| `level` | *number* | :heavy_minus_sign: | Video level. | 150 |
|
||||||
|
| `original` | *boolean* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||||
|
| `hasScalingMatrix` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||||
|
| `scanType` | *string* | :heavy_minus_sign: | N/A | progressive |
|
||||||
|
| `embeddedInVideo` | *string* | :heavy_minus_sign: | N/A | progressive |
|
||||||
|
| `refFrames` | *number* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||||
|
| `width` | *number* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||||
|
| `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
|
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
|
| `selected` | *boolean* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||||
|
| `forced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `channels` | *number* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||||
|
| `audioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||||
|
| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||||
|
| `canAutoSync` | *boolean* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||||
|
| `hearingImpaired` | *boolean* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||||
|
| `dub` | *boolean* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||||
56
docs/sdk/models/operations/getallmedialibrarytype.md
Normal file
56
docs/sdk/models/operations/getallmedialibrarytype.md
Normal file
@@ -0,0 +1,56 @@
|
|||||||
|
# GetAllMediaLibraryType
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllMediaLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibraryType = {
|
||||||
|
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",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||||
|
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||||
|
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||||
|
| `subtype` | *string* | :heavy_minus_sign: | N/A | clip |
|
||||||
|
| `title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||||
|
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||||
|
| `filter` | [operations.GetAllMediaLibraryFilter](../../../sdk/models/operations/getallmedialibraryfilter.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `sort` | [operations.GetAllMediaLibrarySort](../../../sdk/models/operations/getallmedialibrarysort.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `field` | [operations.GetAllMediaLibraryField](../../../sdk/models/operations/getallmedialibraryfield.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
# GetAllMediaLibraryUltraBlurColors
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllMediaLibraryUltraBlurColors } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibraryUltraBlurColors = {
|
||||||
|
topLeft: "11333b",
|
||||||
|
topRight: "0a232d",
|
||||||
|
bottomRight: "73958",
|
||||||
|
bottomLeft: "1f5066",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `topLeft` | *string* | :heavy_check_mark: | N/A | 11333b |
|
||||||
|
| `topRight` | *string* | :heavy_check_mark: | N/A | 0a232d |
|
||||||
|
| `bottomRight` | *string* | :heavy_check_mark: | N/A | 73958 |
|
||||||
|
| `bottomLeft` | *string* | :heavy_check_mark: | N/A | 1f5066 |
|
||||||
17
docs/sdk/models/operations/getallmedialibrarywriter.md
Normal file
17
docs/sdk/models/operations/getallmedialibrarywriter.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetAllMediaLibraryWriter
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetAllMediaLibraryWriter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetAllMediaLibraryWriter = {
|
||||||
|
tag: "Jamie P. Hanson",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `tag` | *string* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
|
||||||
@@ -7,7 +7,7 @@ import { GetAvailableClientsResponse } from "@lukehagar/plexjs/sdk/models/operat
|
|||||||
|
|
||||||
let value: GetAvailableClientsResponse = {
|
let value: GetAvailableClientsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 305,
|
statusCode: 308,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs/sdk/models/ope
|
|||||||
|
|
||||||
let value: GetBandwidthStatisticsResponse = {
|
let value: GetBandwidthStatisticsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 500,
|
statusCode: 101,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { GetButlerTasksResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
|||||||
|
|
||||||
let value: GetButlerTasksResponse = {
|
let value: GetButlerTasksResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 431,
|
statusCode: 402,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { GetCompanionsDataResponse } from "@lukehagar/plexjs/sdk/models/operatio
|
|||||||
|
|
||||||
let value: GetCompanionsDataResponse = {
|
let value: GetCompanionsDataResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 308,
|
statusCode: 301,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,16 +7,16 @@ import { GetCountriesLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/
|
|||||||
|
|
||||||
let value: GetCountriesLibraryMediaContainer = {
|
let value: GetCountriesLibraryMediaContainer = {
|
||||||
size: 50,
|
size: 50,
|
||||||
identifier: "com.plexapp.plugins.library",
|
|
||||||
allowSync: false,
|
allowSync: false,
|
||||||
art: "/:/resources/show-fanart.jpg",
|
art: "/:/resources/show-fanart.jpg",
|
||||||
content: "secondary",
|
content: "secondary",
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
mediaTagVersion: 1734362201,
|
mediaTagVersion: 1734362201,
|
||||||
nocache: true,
|
nocache: true,
|
||||||
thumb: "/:/resources/show.png",
|
thumb: "/:/resources/show.png",
|
||||||
title1: "TV Series",
|
title1: "TV Series",
|
||||||
title2: "By Country",
|
title2: "By Starring Actor",
|
||||||
viewGroup: "secondary",
|
viewGroup: "secondary",
|
||||||
directory: [
|
directory: [
|
||||||
{
|
{
|
||||||
@@ -32,18 +32,16 @@ let value: GetCountriesLibraryMediaContainer = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
|
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
| `offset` | *number* | :heavy_minus_sign: | N/A | |
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `totalSize` | *number* | :heavy_minus_sign: | N/A | |
|
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
| `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
| `content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
|
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
| `content` | *string* | :heavy_check_mark: | N/A | secondary |
|
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||||
| `mediaTagVersion` | *number* | :heavy_check_mark: | N/A | 1734362201 |
|
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
| `nocache` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/show.png |
|
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||||
| `title1` | *string* | :heavy_check_mark: | N/A | TV Series |
|
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||||
| `title2` | *string* | :heavy_check_mark: | N/A | By Country |
|
|
||||||
| `viewGroup` | *string* | :heavy_check_mark: | N/A | secondary |
|
|
||||||
| `directory` | [operations.GetCountriesLibraryDirectory](../../../sdk/models/operations/getcountrieslibrarydirectory.md)[] | :heavy_minus_sign: | N/A | |
|
| `directory` | [operations.GetCountriesLibraryDirectory](../../../sdk/models/operations/getcountrieslibrarydirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
@@ -19,12 +19,15 @@ let value: GetCountriesLibraryQueryParamType =
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||||
| --------- | --------- |
|
|
||||||
| `Movie` | 1 |
|
| Name | Value |
|
||||||
| `TvShow` | 2 |
|
| ---------------------- | ---------------------- |
|
||||||
| `Season` | 3 |
|
| `Movie` | 1 |
|
||||||
| `Episode` | 4 |
|
| `TvShow` | 2 |
|
||||||
| `Audio` | 8 |
|
| `Season` | 3 |
|
||||||
| `Album` | 9 |
|
| `Episode` | 4 |
|
||||||
| `Track` | 10 |
|
| `Audio` | 8 |
|
||||||
|
| `Album` | 9 |
|
||||||
|
| `Track` | 10 |
|
||||||
|
| - | `Unrecognized<number>` |
|
||||||
@@ -7,23 +7,23 @@ import { GetCountriesLibraryResponse } from "@lukehagar/plexjs/sdk/models/operat
|
|||||||
|
|
||||||
let value: GetCountriesLibraryResponse = {
|
let value: GetCountriesLibraryResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 300,
|
statusCode: 404,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
object: {
|
object: {
|
||||||
mediaContainer: {
|
mediaContainer: {
|
||||||
size: 50,
|
size: 50,
|
||||||
identifier: "com.plexapp.plugins.library",
|
|
||||||
allowSync: false,
|
allowSync: false,
|
||||||
art: "/:/resources/show-fanart.jpg",
|
art: "/:/resources/show-fanart.jpg",
|
||||||
content: "secondary",
|
content: "secondary",
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
mediaTagVersion: 1734362201,
|
mediaTagVersion: 1734362201,
|
||||||
nocache: true,
|
nocache: true,
|
||||||
thumb: "/:/resources/show.png",
|
thumb: "/:/resources/show.png",
|
||||||
title1: "TV Series",
|
title1: "TV Series",
|
||||||
title2: "By Country",
|
title2: "By Starring Actor",
|
||||||
viewGroup: "secondary",
|
viewGroup: "secondary",
|
||||||
directory: [
|
directory: [
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -10,16 +10,16 @@ import { GetCountriesLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/op
|
|||||||
let value: GetCountriesLibraryResponseBody = {
|
let value: GetCountriesLibraryResponseBody = {
|
||||||
mediaContainer: {
|
mediaContainer: {
|
||||||
size: 50,
|
size: 50,
|
||||||
identifier: "com.plexapp.plugins.library",
|
|
||||||
allowSync: false,
|
allowSync: false,
|
||||||
art: "/:/resources/show-fanart.jpg",
|
art: "/:/resources/show-fanart.jpg",
|
||||||
content: "secondary",
|
content: "secondary",
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
mediaTagVersion: 1734362201,
|
mediaTagVersion: 1734362201,
|
||||||
nocache: true,
|
nocache: true,
|
||||||
thumb: "/:/resources/show.png",
|
thumb: "/:/resources/show.png",
|
||||||
title1: "TV Series",
|
title1: "TV Series",
|
||||||
title2: "By Country",
|
title2: "By Starring Actor",
|
||||||
viewGroup: "secondary",
|
viewGroup: "secondary",
|
||||||
directory: [
|
directory: [
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { GetDevicesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: GetDevicesResponse = {
|
let value: GetDevicesResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 308,
|
statusCode: 301,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { GetFileHashResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: GetFileHashResponse = {
|
let value: GetFileHashResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 305,
|
statusCode: 102,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,16 +7,16 @@ import { GetGenresLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/ope
|
|||||||
|
|
||||||
let value: GetGenresLibraryMediaContainer = {
|
let value: GetGenresLibraryMediaContainer = {
|
||||||
size: 50,
|
size: 50,
|
||||||
identifier: "com.plexapp.plugins.library",
|
|
||||||
allowSync: false,
|
allowSync: false,
|
||||||
art: "/:/resources/show-fanart.jpg",
|
art: "/:/resources/show-fanart.jpg",
|
||||||
content: "secondary",
|
content: "secondary",
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
mediaTagVersion: 1734362201,
|
mediaTagVersion: 1734362201,
|
||||||
nocache: true,
|
nocache: true,
|
||||||
thumb: "/:/resources/show.png",
|
thumb: "/:/resources/show.png",
|
||||||
title1: "TV Shows (Reality)",
|
title1: "TV Series",
|
||||||
title2: "By Genre",
|
title2: "By Starring Actor",
|
||||||
viewGroup: "secondary",
|
viewGroup: "secondary",
|
||||||
directory: [
|
directory: [
|
||||||
{
|
{
|
||||||
@@ -33,18 +33,16 @@ let value: GetGenresLibraryMediaContainer = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||||
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
|
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
| `offset` | *number* | :heavy_minus_sign: | N/A | |
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `totalSize` | *number* | :heavy_minus_sign: | N/A | |
|
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
| `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
| `content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
|
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
| `content` | *string* | :heavy_check_mark: | N/A | secondary |
|
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||||
| `mediaTagVersion` | *number* | :heavy_check_mark: | N/A | 1734362201 |
|
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
| `nocache` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/show.png |
|
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||||
| `title1` | *string* | :heavy_check_mark: | N/A | TV Shows (Reality) |
|
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||||
| `title2` | *string* | :heavy_check_mark: | N/A | By Genre |
|
|
||||||
| `viewGroup` | *string* | :heavy_check_mark: | N/A | secondary |
|
|
||||||
| `directory` | [operations.GetGenresLibraryDirectory](../../../sdk/models/operations/getgenreslibrarydirectory.md)[] | :heavy_minus_sign: | N/A | |
|
| `directory` | [operations.GetGenresLibraryDirectory](../../../sdk/models/operations/getgenreslibrarydirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
@@ -19,12 +19,15 @@ let value: GetGenresLibraryQueryParamType =
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||||
| --------- | --------- |
|
|
||||||
| `Movie` | 1 |
|
| Name | Value |
|
||||||
| `TvShow` | 2 |
|
| ---------------------- | ---------------------- |
|
||||||
| `Season` | 3 |
|
| `Movie` | 1 |
|
||||||
| `Episode` | 4 |
|
| `TvShow` | 2 |
|
||||||
| `Audio` | 8 |
|
| `Season` | 3 |
|
||||||
| `Album` | 9 |
|
| `Episode` | 4 |
|
||||||
| `Track` | 10 |
|
| `Audio` | 8 |
|
||||||
|
| `Album` | 9 |
|
||||||
|
| `Track` | 10 |
|
||||||
|
| - | `Unrecognized<number>` |
|
||||||
@@ -7,23 +7,23 @@ import { GetGenresLibraryResponse } from "@lukehagar/plexjs/sdk/models/operation
|
|||||||
|
|
||||||
let value: GetGenresLibraryResponse = {
|
let value: GetGenresLibraryResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 506,
|
statusCode: 301,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
object: {
|
object: {
|
||||||
mediaContainer: {
|
mediaContainer: {
|
||||||
size: 50,
|
size: 50,
|
||||||
identifier: "com.plexapp.plugins.library",
|
|
||||||
allowSync: false,
|
allowSync: false,
|
||||||
art: "/:/resources/show-fanart.jpg",
|
art: "/:/resources/show-fanart.jpg",
|
||||||
content: "secondary",
|
content: "secondary",
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
mediaTagVersion: 1734362201,
|
mediaTagVersion: 1734362201,
|
||||||
nocache: true,
|
nocache: true,
|
||||||
thumb: "/:/resources/show.png",
|
thumb: "/:/resources/show.png",
|
||||||
title1: "TV Shows (Reality)",
|
title1: "TV Series",
|
||||||
title2: "By Genre",
|
title2: "By Starring Actor",
|
||||||
viewGroup: "secondary",
|
viewGroup: "secondary",
|
||||||
directory: [
|
directory: [
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -10,16 +10,16 @@ import { GetGenresLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/opera
|
|||||||
let value: GetGenresLibraryResponseBody = {
|
let value: GetGenresLibraryResponseBody = {
|
||||||
mediaContainer: {
|
mediaContainer: {
|
||||||
size: 50,
|
size: 50,
|
||||||
identifier: "com.plexapp.plugins.library",
|
|
||||||
allowSync: false,
|
allowSync: false,
|
||||||
art: "/:/resources/show-fanart.jpg",
|
art: "/:/resources/show-fanart.jpg",
|
||||||
content: "secondary",
|
content: "secondary",
|
||||||
|
identifier: "com.plexapp.plugins.library",
|
||||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
mediaTagVersion: 1734362201,
|
mediaTagVersion: 1734362201,
|
||||||
nocache: true,
|
nocache: true,
|
||||||
thumb: "/:/resources/show.png",
|
thumb: "/:/resources/show.png",
|
||||||
title1: "TV Shows (Reality)",
|
title1: "TV Series",
|
||||||
title2: "By Genre",
|
title2: "By Starring Actor",
|
||||||
viewGroup: "secondary",
|
viewGroup: "secondary",
|
||||||
directory: [
|
directory: [
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { GetGeoDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: GetGeoDataResponse = {
|
let value: GetGeoDataResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 102,
|
statusCode: 103,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { GetGlobalHubsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: GetGlobalHubsResponse = {
|
let value: GetGlobalHubsResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 423,
|
statusCode: 306,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { GetHomeDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
|||||||
|
|
||||||
let value: GetHomeDataResponse = {
|
let value: GetHomeDataResponse = {
|
||||||
contentType: "<value>",
|
contentType: "<value>",
|
||||||
statusCode: 204,
|
statusCode: 404,
|
||||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||||
headers: { "Content-Type": "application/json" },
|
headers: { "Content-Type": "application/json" },
|
||||||
}),
|
}),
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ let value: GetLibraryDetailsRequest = {
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `includeDetails` | [operations.IncludeDetails](../../../sdk/models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
| `includeDetails` | [operations.IncludeDetails](../../../sdk/models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts).<br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
||||||
| `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 |
|
| `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 |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user