mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
77b0ef9507 | ||
|
|
1cfbd17f28 | ||
|
|
2492807c65 |
File diff suppressed because one or more lines are too long
@@ -12,7 +12,7 @@ generation:
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
typescript:
|
||||
version: 0.24.0
|
||||
version: 0.25.1
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies: {}
|
||||
@@ -22,6 +22,7 @@ typescript:
|
||||
clientServerStatusCodesAsErrors: true
|
||||
enumFormat: enum
|
||||
flattenGlobalSecurity: true
|
||||
flatteningOrder: body-first
|
||||
imports:
|
||||
option: openapi
|
||||
paths:
|
||||
|
||||
@@ -9,8 +9,8 @@ sources:
|
||||
- main
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:c52cde0b8d51e160f7b9f1a3d3ea4dbb1aca6d5caad714e549201fb757fadd57
|
||||
sourceBlobDigest: sha256:f417b03ff71356808554313f24c3d06d670474bf51bc9a0631de1ad49c13a361
|
||||
sourceRevisionDigest: sha256:c6ab8f13847c7cdc4ab3752f517164d7da08266726255aa0d614b1eaea66fb0e
|
||||
sourceBlobDigest: sha256:64c7694915a0828aeb256d10d2fa0ea477681785b818916b6681be8cc5ffb93b
|
||||
tags:
|
||||
- latest
|
||||
- main
|
||||
@@ -18,10 +18,10 @@ targets:
|
||||
plexjs:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:c52cde0b8d51e160f7b9f1a3d3ea4dbb1aca6d5caad714e549201fb757fadd57
|
||||
sourceBlobDigest: sha256:f417b03ff71356808554313f24c3d06d670474bf51bc9a0631de1ad49c13a361
|
||||
sourceRevisionDigest: sha256:c6ab8f13847c7cdc4ab3752f517164d7da08266726255aa0d614b1eaea66fb0e
|
||||
sourceBlobDigest: sha256:64c7694915a0828aeb256d10d2fa0ea477681785b818916b6681be8cc5ffb93b
|
||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||
codeSamplesRevisionDigest: sha256:0f48dbf8695dfd00a5ebd3fec72c0d71282b0d395790fe53811866c2756be38d
|
||||
codeSamplesRevisionDigest: sha256:9667534090efff73eeec1ce4a99b4aebdd251a5eac0cfa5c78ddc0def4d4624e
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
|
||||
10
FUNCTIONS.md
10
FUNCTIONS.md
@@ -27,11 +27,11 @@ import { SDKValidationError } from "@lukehagar/plexjs/sdk/models/errors/sdkvalid
|
||||
// You can create one instance of it to use across an application.
|
||||
const plexAPI = new PlexAPICore({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
clientID: "gcgzw5rz2xovp84b4vha3a40",
|
||||
clientName: "Plex Web",
|
||||
clientVersion: "4.133.0",
|
||||
clientPlatform: "Chrome",
|
||||
deviceName: "Linux",
|
||||
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||
clientName: "Plex for Roku",
|
||||
clientVersion: "2.4.1",
|
||||
platform: "Roku",
|
||||
deviceNickname: "Roku 3",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
140
README.md
140
README.md
@@ -46,7 +46,6 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
|
||||
* [SDK Example Usage](#sdk-example-usage)
|
||||
* [Available Resources and Operations](#available-resources-and-operations)
|
||||
* [Standalone functions](#standalone-functions)
|
||||
* [Global Parameters](#global-parameters)
|
||||
* [Retries](#retries)
|
||||
* [Error Handling](#error-handling)
|
||||
* [Server Selection](#server-selection)
|
||||
@@ -98,11 +97,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
clientID: "gcgzw5rz2xovp84b4vha3a40",
|
||||
clientName: "Plex Web",
|
||||
clientVersion: "4.133.0",
|
||||
clientPlatform: "Chrome",
|
||||
deviceName: "Linux",
|
||||
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||
clientName: "Plex for Roku",
|
||||
clientVersion: "2.4.1",
|
||||
platform: "Roku",
|
||||
deviceNickname: "Roku 3",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -159,6 +158,7 @@ run();
|
||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||
@@ -283,11 +283,11 @@ import {
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
clientID: "gcgzw5rz2xovp84b4vha3a40",
|
||||
clientName: "Plex Web",
|
||||
clientVersion: "4.133.0",
|
||||
clientPlatform: "Chrome",
|
||||
deviceName: "Linux",
|
||||
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||
clientName: "Plex for Roku",
|
||||
clientVersion: "2.4.1",
|
||||
platform: "Roku",
|
||||
deviceNickname: "Roku 3",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -347,11 +347,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
const plexAPI = new PlexAPI({
|
||||
serverIdx: 0,
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
clientID: "gcgzw5rz2xovp84b4vha3a40",
|
||||
clientName: "Plex Web",
|
||||
clientVersion: "4.133.0",
|
||||
clientPlatform: "Chrome",
|
||||
deviceName: "Linux",
|
||||
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||
clientName: "Plex for Roku",
|
||||
clientVersion: "2.4.1",
|
||||
platform: "Roku",
|
||||
deviceNickname: "Roku 3",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -382,11 +382,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
const plexAPI = new PlexAPI({
|
||||
serverURL: "{protocol}://{ip}:{port}",
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
clientID: "gcgzw5rz2xovp84b4vha3a40",
|
||||
clientName: "Plex Web",
|
||||
clientVersion: "4.133.0",
|
||||
clientPlatform: "Chrome",
|
||||
deviceName: "Linux",
|
||||
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||
clientName: "Plex for Roku",
|
||||
clientVersion: "2.4.1",
|
||||
platform: "Roku",
|
||||
deviceNickname: "Roku 3",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -408,11 +408,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
clientID: "gcgzw5rz2xovp84b4vha3a40",
|
||||
clientName: "Plex Web",
|
||||
clientVersion: "4.133.0",
|
||||
clientPlatform: "Chrome",
|
||||
deviceName: "Linux",
|
||||
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||
clientName: "Plex for Roku",
|
||||
clientVersion: "2.4.1",
|
||||
platform: "Roku",
|
||||
deviceNickname: "Roku 3",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -495,11 +495,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
clientID: "gcgzw5rz2xovp84b4vha3a40",
|
||||
clientName: "Plex Web",
|
||||
clientVersion: "4.133.0",
|
||||
clientPlatform: "Chrome",
|
||||
deviceName: "Linux",
|
||||
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||
clientName: "Plex for Roku",
|
||||
clientVersion: "2.4.1",
|
||||
platform: "Roku",
|
||||
deviceNickname: "Roku 3",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -559,6 +559,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
- [libraryGetOnDeck](docs/sdks/library/README.md#getondeck)
|
||||
- [libraryGetRecentlyAddedLibrary](docs/sdks/library/README.md#getrecentlyaddedlibrary)
|
||||
- [libraryGetRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata)
|
||||
- [libraryGetSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries)
|
||||
- [libraryGetSearchLibrary](docs/sdks/library/README.md#getsearchlibrary)
|
||||
- [libraryGetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent)
|
||||
- [logEnablePaperTrail](docs/sdks/log/README.md#enablepapertrail)
|
||||
@@ -615,63 +616,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
</details>
|
||||
<!-- End Standalone functions [standalone-funcs] -->
|
||||
|
||||
<!-- Start Global Parameters [global-parameters] -->
|
||||
## Global Parameters
|
||||
|
||||
Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed.
|
||||
|
||||
For example, you can set `ClientID` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getServerResources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
||||
|
||||
|
||||
### Available Globals
|
||||
|
||||
The following global parameters are available.
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
| ---- | ---- |:--------:| ----------- |
|
||||
| clientID | string | | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) |
|
||||
| clientName | string | | The clientName parameter. |
|
||||
| clientVersion | string | | The clientVersion parameter. |
|
||||
| clientPlatform | string | | The clientPlatform parameter. |
|
||||
| deviceName | string | | The deviceName parameter. |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import {
|
||||
IncludeHttps,
|
||||
IncludeIPv6,
|
||||
IncludeRelay,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
clientID: "gcgzw5rz2xovp84b4vha3a40",
|
||||
clientName: "Plex Web",
|
||||
clientVersion: "4.133.0",
|
||||
clientPlatform: "Chrome",
|
||||
deviceName: "Linux",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.plex.getServerResources(
|
||||
IncludeHttps.Enable,
|
||||
IncludeRelay.Enable,
|
||||
IncludeIPv6.Enable,
|
||||
"gcgzw5rz2xovp84b4vha3a40",
|
||||
);
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End Global Parameters [global-parameters] -->
|
||||
|
||||
<!-- Start Retries [retries] -->
|
||||
## Retries
|
||||
|
||||
@@ -683,11 +627,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
clientID: "gcgzw5rz2xovp84b4vha3a40",
|
||||
clientName: "Plex Web",
|
||||
clientVersion: "4.133.0",
|
||||
clientPlatform: "Chrome",
|
||||
deviceName: "Linux",
|
||||
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||
clientName: "Plex for Roku",
|
||||
clientVersion: "2.4.1",
|
||||
platform: "Roku",
|
||||
deviceNickname: "Roku 3",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -728,11 +672,11 @@ const plexAPI = new PlexAPI({
|
||||
retryConnectionErrors: false,
|
||||
},
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
clientID: "gcgzw5rz2xovp84b4vha3a40",
|
||||
clientName: "Plex Web",
|
||||
clientVersion: "4.133.0",
|
||||
clientPlatform: "Chrome",
|
||||
deviceName: "Linux",
|
||||
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||
clientName: "Plex for Roku",
|
||||
clientVersion: "2.4.1",
|
||||
platform: "Roku",
|
||||
deviceNickname: "Roku 3",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
32
RELEASES.md
32
RELEASES.md
@@ -1078,4 +1078,34 @@ Based on:
|
||||
### Generated
|
||||
- [typescript v0.24.0] .
|
||||
### Releases
|
||||
- [NPM v0.24.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.0 - .
|
||||
- [NPM v0.24.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.0 - .
|
||||
|
||||
## 2024-10-01 15:35:33
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.24.1] .
|
||||
### Releases
|
||||
- [NPM v0.24.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.1 - .
|
||||
|
||||
## 2024-10-02 02:28:25
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.24.2] .
|
||||
### Releases
|
||||
- [NPM v0.24.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.2 - .
|
||||
|
||||
## 2024-10-03 00:09:30
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.25.1] .
|
||||
### Releases
|
||||
- [NPM v0.25.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.25.1 - .
|
||||
10
USAGE.md
10
USAGE.md
@@ -4,11 +4,11 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
clientID: "gcgzw5rz2xovp84b4vha3a40",
|
||||
clientName: "Plex Web",
|
||||
clientVersion: "4.133.0",
|
||||
clientPlatform: "Chrome",
|
||||
deviceName: "Linux",
|
||||
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||
clientName: "Plex for Roku",
|
||||
clientVersion: "2.4.1",
|
||||
platform: "Roku",
|
||||
deviceNickname: "Roku 3",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
787
codeSamples.yaml
787
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
18
docs/sdk/models/errors/getsearchalllibrariesbadrequest.md
Normal file
18
docs/sdk/models/errors/getsearchalllibrariesbadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetSearchAllLibrariesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetSearchAllLibrariesErrors](../../../sdk/models/errors/getsearchalllibrarieserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
21
docs/sdk/models/errors/getsearchalllibrarieserrors.md
Normal file
21
docs/sdk/models/errors/getsearchalllibrarieserrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetSearchAllLibrariesErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetSearchAllLibrariesErrors = {
|
||||
code: 1000,
|
||||
message: "X-Plex-Client-Identifier is missing",
|
||||
status: 400,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/getsearchalllibrarieslibraryerrors.md
Normal file
21
docs/sdk/models/errors/getsearchalllibrarieslibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetSearchAllLibrariesLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetSearchAllLibrariesLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/getsearchalllibrariesunauthorized.md
Normal file
18
docs/sdk/models/errors/getsearchalllibrariesunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetSearchAllLibrariesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetSearchAllLibrariesLibraryErrors](../../../sdk/models/errors/getsearchalllibrarieslibraryerrors.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";
|
||||
|
||||
let value: AddPlaylistContentsRequest = {
|
||||
playlistID: 8966.71,
|
||||
playlistID: 6289.82,
|
||||
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
||||
playQueueID: 123,
|
||||
};
|
||||
|
||||
@@ -7,7 +7,7 @@ import { AddPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operat
|
||||
|
||||
let value: AddPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 502,
|
||||
statusCode: 503,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { ApplyUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ApplyUpdatesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 102,
|
||||
statusCode: 103,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { Billing } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Billing = {
|
||||
internalPaymentMethod: {},
|
||||
paymentMethodId: 730856,
|
||||
paymentMethodId: 374170,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { CheckForUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations
|
||||
|
||||
let value: CheckForUpdatesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 429,
|
||||
statusCode: 201,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ClearPlaylistContentsRequest = {
|
||||
playlistID: 6793.93,
|
||||
playlistID: 3834.64,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { ClearPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/oper
|
||||
|
||||
let value: ClearPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 304,
|
||||
statusCode: 307,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,9 +7,9 @@ import { CreatePlaylistQueryParamType, CreatePlaylistRequest, Smart } from "@luk
|
||||
|
||||
let value: CreatePlaylistRequest = {
|
||||
title: "<value>",
|
||||
type: CreatePlaylistQueryParamType.Video,
|
||||
smart: Smart.Zero,
|
||||
uri: "https://pleased-lox.name",
|
||||
type: CreatePlaylistQueryParamType.Photo,
|
||||
smart: Smart.One,
|
||||
uri: "https://enchanted-disclosure.com/",
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { CreatePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
||||
|
||||
let value: CreatePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 409,
|
||||
statusCode: 302,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: DeletePlaylistRequest = {
|
||||
playlistID: 2543.56,
|
||||
playlistID: 5365.79,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { DeletePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
||||
|
||||
let value: DeletePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 101,
|
||||
statusCode: 511,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { EnablePaperTrailResponse } from "@lukehagar/plexjs/sdk/models/operation
|
||||
|
||||
let value: EnablePaperTrailResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 400,
|
||||
statusCode: 203,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -1,112 +0,0 @@
|
||||
# Features
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Features } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Features = Features.Trailers;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| --------------------------------------- | --------------------------------------- |
|
||||
| `AndroidDolbyVision` | Android - Dolby Vision |
|
||||
| `AndroidPiP` | Android - PiP |
|
||||
| `CUSunset` | CU Sunset |
|
||||
| `HRKEnableEUR` | HRK_enable_EUR |
|
||||
| `TREBLEShowFeatures` | TREBLE-show-features |
|
||||
| `AdCountdownTimer` | ad-countdown-timer |
|
||||
| `AdaptiveBitrate` | adaptive_bitrate |
|
||||
| `AlbumTypes` | album-types |
|
||||
| `AllowDvr` | allow_dvr |
|
||||
| `AmazonLoopDebug` | amazon-loop-debug |
|
||||
| `AvodAdAnalysis` | avod-ad-analysis |
|
||||
| `AvodNewMedia` | avod-new-media |
|
||||
| `BlacklistGetSignin` | blacklist_get_signin |
|
||||
| `BoostVoices` | boost-voices |
|
||||
| `CameraUpload` | camera_upload |
|
||||
| `ClientRadioStations` | client-radio-stations |
|
||||
| `CloudflareTurnstileRequired` | cloudflare-turnstile-required |
|
||||
| `Cloudsync` | cloudsync |
|
||||
| `Collections` | collections |
|
||||
| `CommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications |
|
||||
| `CommunityAccessPlexTv` | community_access_plex_tv |
|
||||
| `CompanionsSonos` | companions_sonos |
|
||||
| `ContentFilter` | content_filter |
|
||||
| `CustomHomeRemoval` | custom-home-removal |
|
||||
| `DisableHomeUserFriendships` | disable_home_user_friendships |
|
||||
| `DisableSharingFriendships` | disable_sharing_friendships |
|
||||
| `DownloadsGating` | downloads-gating |
|
||||
| `DrmSupport` | drm_support |
|
||||
| `Dvr` | dvr |
|
||||
| `DvrBlockUnsupportedCountries` | dvr-block-unsupported-countries |
|
||||
| `EpgRecentChannels` | epg-recent-channels |
|
||||
| `ExcludeRestrictions` | exclude restrictions |
|
||||
| `FederatedAuth` | federated-auth |
|
||||
| `FriendRequestPushNotifications` | friend_request_push_notifications |
|
||||
| `GrandfatherSync` | grandfather-sync |
|
||||
| `GuidedUpgrade` | guided-upgrade |
|
||||
| `HardwareTranscoding` | hardware_transcoding |
|
||||
| `Home` | home |
|
||||
| `Hwtranscode` | hwtranscode |
|
||||
| `ImaggaV2` | imagga-v2 |
|
||||
| `IncreasePasswordComplexity` | increase-password-complexity |
|
||||
| `Ios14PrivacyBanner` | ios14-privacy-banner |
|
||||
| `IterableNotificationTokens` | iterable-notification-tokens |
|
||||
| `ItemClusters` | item_clusters |
|
||||
| `KeepPaymentMethod` | keep-payment-method |
|
||||
| `KevinBacon` | kevin-bacon |
|
||||
| `KoreaConsent` | korea-consent |
|
||||
| `LeIsrgRootX1` | le_isrg_root_x1 |
|
||||
| `LetsEncrypt` | lets_encrypt |
|
||||
| `LightningDvrPivot` | lightning-dvr-pivot |
|
||||
| `LiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments |
|
||||
| `Livetv` | livetv |
|
||||
| `Lyrics` | lyrics |
|
||||
| `MetadataSearch` | metadata_search |
|
||||
| `MusicAnalysis` | music-analysis |
|
||||
| `MusicVideos` | music_videos |
|
||||
| `NewPlexPassPrices` | new_plex_pass_prices |
|
||||
| `NewsProviderSunsetModal` | news-provider-sunset-modal |
|
||||
| `Nominatim` | nominatim |
|
||||
| `Pass` | pass |
|
||||
| `PhotosFavorites` | photos-favorites |
|
||||
| `PhotosMetadataEdition` | photos-metadata-edition |
|
||||
| `PhotosV6Edit` | photosV6-edit |
|
||||
| `PhotosV6TvAlbums` | photosV6-tv-albums |
|
||||
| `PmsHealth` | pms_health |
|
||||
| `PremiumDashboard` | premium-dashboard |
|
||||
| `PremiumMusicMetadata` | premium_music_metadata |
|
||||
| `Radio` | radio |
|
||||
| `RateLimitClientToken` | rate-limit-client-token |
|
||||
| `ScrobblingServicePlexTv` | scrobbling-service-plex-tv |
|
||||
| `SessionBandwidthRestrictions` | session_bandwidth_restrictions |
|
||||
| `SessionKick` | session_kick |
|
||||
| `SharedServerNotification` | shared_server_notification |
|
||||
| `SharedSourceNotification` | shared_source_notification |
|
||||
| `SigninNotification` | signin_notification |
|
||||
| `SigninWithApple` | signin_with_apple |
|
||||
| `SilenceRemoval` | silence-removal |
|
||||
| `SleepTimer` | sleep-timer |
|
||||
| `SpringServeAdProvider` | spring_serve_ad_provider |
|
||||
| `Sync` | sync |
|
||||
| `SweetFades` | sweet-fades |
|
||||
| `TranscoderCache` | transcoder_cache |
|
||||
| `Trailers` | trailers |
|
||||
| `TunerSharing` | tuner-sharing |
|
||||
| `TwoFactorAuthentication` | two-factor-authentication |
|
||||
| `Unsupportedtuners` | unsupportedtuners |
|
||||
| `Upgrade3ds2` | upgrade-3ds2 |
|
||||
| `Visualizers` | visualizers |
|
||||
| `VodSchema` | vod-schema |
|
||||
| `VodCloudflare` | vod_cloudflare |
|
||||
| `VolumeLeveling` | volume-leveling |
|
||||
| `WatchTogetherInvite` | watch-together-invite |
|
||||
| `WatchlistRss` | watchlist-rss |
|
||||
| `WebServerDashboard` | web_server_dashboard |
|
||||
| `Webhooks` | webhooks |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -7,7 +7,7 @@ Filter
|
||||
```typescript
|
||||
import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Filter = Filter.Released;
|
||||
let value: Filter = Filter.Available;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -37,26 +37,26 @@ let value: GetAllLibrariesDirectory = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `composite` | *string* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
|
||||
| `filters` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `refreshing` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | 1 |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Movies |
|
||||
| `agent` | *string* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
|
||||
| `scanner` | *string* | :heavy_check_mark: | N/A | Plex Movie |
|
||||
| `language` | *string* | :heavy_check_mark: | N/A | en-US |
|
||||
| `uuid` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `updatedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `createdAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `scannedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `content` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `directory` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `contentChangedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `hidden` | *number* | :heavy_check_mark: | N/A | 0 |
|
||||
| `location` | [operations.Location](../../../sdk/models/operations/location.md)[] | :heavy_check_mark: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `composite` | *string* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
|
||||
| `filters` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `refreshing` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | 1 |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Movies |
|
||||
| `agent` | *string* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
|
||||
| `scanner` | *string* | :heavy_check_mark: | N/A | Plex Movie |
|
||||
| `language` | *string* | :heavy_check_mark: | N/A | en-US |
|
||||
| `uuid` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `updatedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `createdAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `scannedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `content` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `directory` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `contentChangedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `hidden` | *number* | :heavy_check_mark: | N/A | 0 |
|
||||
| `location` | [operations.GetAllLibrariesLocation](../../../sdk/models/operations/getalllibrarieslocation.md)[] | :heavy_check_mark: | N/A | |
|
||||
19
docs/sdk/models/operations/getalllibrarieslocation.md
Normal file
19
docs/sdk/models/operations/getalllibrarieslocation.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# GetAllLibrariesLocation
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllLibrariesLocation } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllLibrariesLocation = {
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 1 |
|
||||
| `path` | *string* | :heavy_check_mark: | N/A | /movies |
|
||||
@@ -7,7 +7,7 @@ import { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs/sdk/models/ope
|
||||
|
||||
let value: GetBandwidthStatisticsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 102,
|
||||
statusCode: 101,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -24,4 +24,4 @@ let value: GetBannerImageRequest = {
|
||||
| `height` | *number* | :heavy_check_mark: | N/A | 396 |
|
||||
| `minSize` | *number* | :heavy_check_mark: | N/A | 1 |
|
||||
| `upscale` | *number* | :heavy_check_mark: | N/A | 1 |
|
||||
| `xPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
|
||||
| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
|
||||
@@ -14,5 +14,5 @@ let value: GetLibraryDetailsRequest = {
|
||||
|
||||
| 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 |
|
||||
| `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 |
|
||||
17
docs/sdk/models/operations/getlibraryitemslocation.md
Normal file
17
docs/sdk/models/operations/getlibraryitemslocation.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetLibraryItemsLocation
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryItemsLocation } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsLocation = {
|
||||
path: "/TV Shows/House",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `path` | *string* | :heavy_minus_sign: | N/A | /TV Shows/House |
|
||||
@@ -94,19 +94,19 @@ let value: GetLibraryItemsMedia = {
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 119534 |
|
||||
| `duration` | *number* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `bitrate` | *number* | :heavy_check_mark: | N/A | 25025 |
|
||||
| `width` | *number* | :heavy_check_mark: | N/A | 3840 |
|
||||
| `height` | *number* | :heavy_check_mark: | N/A | 2072 |
|
||||
| `aspectRatio` | *number* | :heavy_check_mark: | N/A | 1.85 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 25025 |
|
||||
| `width` | *number* | :heavy_minus_sign: | N/A | 3840 |
|
||||
| `height` | *number* | :heavy_minus_sign: | N/A | 2072 |
|
||||
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 1.85 |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | dts |
|
||||
| `audioChannels` | *number* | :heavy_check_mark: | N/A | 6 |
|
||||
| `audioCodec` | *string* | :heavy_check_mark: | N/A | eac3 |
|
||||
| `videoCodec` | *string* | :heavy_check_mark: | N/A | hevc |
|
||||
| `videoResolution` | *string* | :heavy_check_mark: | N/A | 4k |
|
||||
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | eac3 |
|
||||
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 4k |
|
||||
| `container` | *string* | :heavy_check_mark: | N/A | mkv |
|
||||
| `videoFrameRate` | *string* | :heavy_check_mark: | N/A | 24p |
|
||||
| `videoProfile` | *string* | :heavy_check_mark: | N/A | main 10 |
|
||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `hasVoiceActivity` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | [operations.GetLibraryItemsOptimizedForStreaming](../../../sdk/models/operations/getlibraryitemsoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
|
||||
@@ -248,6 +248,11 @@ let value: GetLibraryItemsMediaContainer = {
|
||||
role: "Self",
|
||||
},
|
||||
],
|
||||
location: [
|
||||
{
|
||||
path: "/TV Shows/House",
|
||||
},
|
||||
],
|
||||
mediaGuid: [
|
||||
{
|
||||
id: "imdb://tt13015952",
|
||||
|
||||
@@ -172,6 +172,11 @@ let value: GetLibraryItemsMetadata = {
|
||||
role: "Self",
|
||||
},
|
||||
],
|
||||
location: [
|
||||
{
|
||||
path: "/TV Shows/House",
|
||||
},
|
||||
],
|
||||
mediaGuid: [
|
||||
{
|
||||
id: "imdb://tt13015952",
|
||||
@@ -273,6 +278,7 @@ let value: GetLibraryItemsMetadata = {
|
||||
| `writer` | [operations.GetLibraryItemsWriter](../../../sdk/models/operations/getlibraryitemswriter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | [operations.GetLibraryItemsCollection](../../../sdk/models/operations/getlibraryitemscollection.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | [operations.GetLibraryItemsRole](../../../sdk/models/operations/getlibraryitemsrole.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `location` | [operations.GetLibraryItemsLocation](../../../sdk/models/operations/getlibraryitemslocation.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `mediaGuid` | [operations.GetLibraryItemsMediaGuid](../../../sdk/models/operations/getlibraryitemsmediaguid.md)[] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||
| `ultraBlurColors` | [operations.GetLibraryItemsUltraBlurColors](../../../sdk/models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `metaDataRating` | [operations.GetLibraryItemsMetaDataRating](../../../sdk/models/operations/getlibraryitemsmetadatarating.md)[] | :heavy_minus_sign: | N/A | |
|
||||
|
||||
@@ -70,14 +70,14 @@ let value: GetLibraryItemsPart = {
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 119542 |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `duration` | *number* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `file` | *string* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `size` | *number* | :heavy_check_mark: | N/A | 36158371307 |
|
||||
| `container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | dts |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `videoProfile` | *string* | :heavy_check_mark: | N/A | main 10 |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `indexes` | *string* | :heavy_minus_sign: | N/A | sd |
|
||||
| `hasThumbnail` | [operations.GetLibraryItemsHasThumbnail](../../../sdk/models/operations/getlibraryitemshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `stream` | [operations.GetLibraryItemsStream](../../../sdk/models/operations/getlibraryitemsstream.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -12,10 +12,10 @@ import {
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsRequest = {
|
||||
sectionKey: 9518,
|
||||
tag: Tag.FirstCharacter,
|
||||
includeGuids: IncludeGuids.Enable,
|
||||
type: GetLibraryItemsQueryParamType.TvShow,
|
||||
sectionKey: 9518,
|
||||
includeMeta: GetLibraryItemsQueryParamIncludeMeta.Enable,
|
||||
xPlexContainerStart: 0,
|
||||
xPlexContainerSize: 50,
|
||||
@@ -26,10 +26,10 @@ let value: GetLibraryItemsRequest = {
|
||||
|
||||
| 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 |
|
||||
| `tag` | [operations.Tag](../../../sdk/models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||
| `includeGuids` | [operations.IncludeGuids](../../../sdk/models/operations/includeguids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
| `type` | [operations.GetLibraryItemsQueryParamType](../../../sdk/models/operations/getlibraryitemsqueryparamtype.md) | :heavy_minus_sign: | The type of media to retrieve.<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 |
|
||||
| `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 |
|
||||
| `includeMeta` | [operations.GetLibraryItemsQueryParamIncludeMeta](../../../sdk/models/operations/getlibraryitemsqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 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 |
|
||||
@@ -253,6 +253,11 @@ let value: GetLibraryItemsResponse = {
|
||||
role: "Self",
|
||||
},
|
||||
],
|
||||
location: [
|
||||
{
|
||||
path: "/TV Shows/House",
|
||||
},
|
||||
],
|
||||
mediaGuid: [
|
||||
{
|
||||
id: "imdb://tt13015952",
|
||||
|
||||
@@ -248,6 +248,11 @@ let value: GetLibraryItemsResponseBody = {
|
||||
role: "Self",
|
||||
},
|
||||
],
|
||||
location: [
|
||||
{
|
||||
path: "/TV Shows/House",
|
||||
},
|
||||
],
|
||||
mediaGuid: [
|
||||
{
|
||||
id: "imdb://tt13015952",
|
||||
|
||||
@@ -12,6 +12,6 @@ let value: GetMediaProvidersRequest = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `xPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
|
||||
@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetMetaDataByRatingKeyResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 506,
|
||||
statusCode: 207,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -50,7 +50,7 @@ let value: GetMetadataChildrenMediaContainer = {
|
||||
parentKey: "/library/metadata/30072",
|
||||
parentTitle: "Reacher",
|
||||
summary:
|
||||
"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.",
|
||||
"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge.",
|
||||
index: 2,
|
||||
parentIndex: 1,
|
||||
viewCount: 11,
|
||||
|
||||
@@ -17,7 +17,7 @@ let value: GetMetadataChildrenMetadata = {
|
||||
parentKey: "/library/metadata/30072",
|
||||
parentTitle: "Reacher",
|
||||
summary:
|
||||
"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.",
|
||||
"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge.",
|
||||
index: 2,
|
||||
parentIndex: 1,
|
||||
viewCount: 11,
|
||||
@@ -51,7 +51,7 @@ let value: GetMetadataChildrenMetadata = {
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Season 2 |
|
||||
| `parentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072 |
|
||||
| `parentTitle` | *string* | :heavy_minus_sign: | N/A | Reacher |
|
||||
| `summary` | *string* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge. |
|
||||
| `summary` | *string* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge. |
|
||||
| `index` | *number* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `parentIndex` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 11 |
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetMetadataChildrenRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMetadataChildrenRequest = {
|
||||
ratingKey: 4071.83,
|
||||
ratingKey: 1716.30,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetMetadataChildrenResponse } from "@lukehagar/plexjs/sdk/models/operat
|
||||
|
||||
let value: GetMetadataChildrenResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 102,
|
||||
statusCode: 300,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
@@ -57,7 +57,7 @@ let value: GetMetadataChildrenResponse = {
|
||||
parentKey: "/library/metadata/30072",
|
||||
parentTitle: "Reacher",
|
||||
summary:
|
||||
"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.",
|
||||
"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge.",
|
||||
index: 2,
|
||||
parentIndex: 1,
|
||||
viewCount: 11,
|
||||
|
||||
@@ -53,7 +53,7 @@ let value: GetMetadataChildrenResponseBody = {
|
||||
parentKey: "/library/metadata/30072",
|
||||
parentTitle: "Reacher",
|
||||
summary:
|
||||
"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.",
|
||||
"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge.",
|
||||
index: 2,
|
||||
parentIndex: 1,
|
||||
viewCount: 11,
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetOnDeckResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetOnDeckResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 511,
|
||||
statusCode: 406,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -10,10 +10,10 @@ let value: GetPinGlobals = {};
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
|
||||
| `clientName` | *string* | :heavy_minus_sign: | N/A | Plex Web |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | N/A | Linux |
|
||||
| `clientVersion` | *string* | :heavy_minus_sign: | N/A | 4.133.0 |
|
||||
| `clientPlatform` | *string* | :heavy_minus_sign: | N/A | Chrome |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
|
||||
| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client application. | Roku |
|
||||
@@ -10,11 +10,11 @@ let value: GetPinRequest = {};
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `strong` | *boolean* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
|
||||
| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
|
||||
| `clientName` | *string* | :heavy_minus_sign: | N/A | Plex Web |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | N/A | Linux |
|
||||
| `clientVersion` | *string* | :heavy_minus_sign: | N/A | 4.133.0 |
|
||||
| `clientPlatform` | *string* | :heavy_minus_sign: | N/A | Chrome |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `strong` | *boolean* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
|
||||
| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
|
||||
| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client application. | Roku |
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetPlaylistContentsQueryParamType, GetPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistContentsRequest = {
|
||||
playlistID: 1796.04,
|
||||
playlistID: 206.51,
|
||||
type: GetPlaylistContentsQueryParamType.TvShow,
|
||||
};
|
||||
```
|
||||
|
||||
@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 100,
|
||||
statusCode: 409,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetPlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistRequest = {
|
||||
playlistID: 7395.51,
|
||||
playlistID: 672.50,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetPlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 302,
|
||||
statusCode: 413,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetPlaylistsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 103,
|
||||
statusCode: 100,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -228,6 +228,11 @@ let value: GetRecentlyAddedMediaContainer = {
|
||||
role: "Self",
|
||||
},
|
||||
],
|
||||
location: [
|
||||
{
|
||||
path: "/TV Shows/House",
|
||||
},
|
||||
],
|
||||
mediaGuid: [
|
||||
{
|
||||
id: "imdb://tt13015952",
|
||||
|
||||
@@ -172,6 +172,11 @@ let value: GetRecentlyAddedMetadata = {
|
||||
role: "Self",
|
||||
},
|
||||
],
|
||||
location: [
|
||||
{
|
||||
path: "/TV Shows/House",
|
||||
},
|
||||
],
|
||||
mediaGuid: [
|
||||
{
|
||||
id: "imdb://tt13015952",
|
||||
@@ -273,6 +278,7 @@ let value: GetRecentlyAddedMetadata = {
|
||||
| `writer` | [operations.Writer](../../../sdk/models/operations/writer.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | [operations.Collection](../../../sdk/models/operations/collection.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | [operations.Role](../../../sdk/models/operations/role.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `location` | [operations.Location](../../../sdk/models/operations/location.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `mediaGuid` | [operations.MediaGuid](../../../sdk/models/operations/mediaguid.md)[] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||
| `ultraBlurColors` | [operations.UltraBlurColors](../../../sdk/models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `metaDataRating` | [operations.MetaDataRating](../../../sdk/models/operations/metadatarating.md)[] | :heavy_minus_sign: | N/A | |
|
||||
|
||||
@@ -235,6 +235,11 @@ let value: GetRecentlyAddedResponse = {
|
||||
role: "Self",
|
||||
},
|
||||
],
|
||||
location: [
|
||||
{
|
||||
path: "/TV Shows/House",
|
||||
},
|
||||
],
|
||||
mediaGuid: [
|
||||
{
|
||||
id: "imdb://tt13015952",
|
||||
|
||||
@@ -231,6 +231,11 @@ let value: GetRecentlyAddedResponseBody = {
|
||||
role: "Self",
|
||||
},
|
||||
],
|
||||
location: [
|
||||
{
|
||||
path: "/TV Shows/House",
|
||||
},
|
||||
],
|
||||
mediaGuid: [
|
||||
{
|
||||
id: "imdb://tt13015952",
|
||||
|
||||
@@ -6,8 +6,8 @@
|
||||
import { Force, GetRefreshLibraryMetadataRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetRefreshLibraryMetadataRequest = {
|
||||
sectionKey: 9518,
|
||||
force: Force.One,
|
||||
sectionKey: 9518,
|
||||
};
|
||||
```
|
||||
|
||||
@@ -15,5 +15,5 @@ let value: GetRefreshLibraryMetadataRequest = {
|
||||
|
||||
| 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 |
|
||||
| `force` | [operations.Force](../../../sdk/models/operations/force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |
|
||||
| `force` | [operations.Force](../../../sdk/models/operations/force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |
|
||||
| `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 |
|
||||
@@ -7,7 +7,7 @@ import { GetResourcesStatisticsResponse } from "@lukehagar/plexjs/sdk/models/ope
|
||||
|
||||
let value: GetResourcesStatisticsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 307,
|
||||
statusCode: 301,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
# GetSearchAllLibrariesCollection
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesCollection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesCollection = {
|
||||
tag: "Working NL Subs",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||
17
docs/sdk/models/operations/getsearchalllibrariescountry.md
Normal file
17
docs/sdk/models/operations/getsearchalllibrariescountry.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetSearchAllLibrariesCountry
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesCountry } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesCountry = {
|
||||
tag: "United States of America",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America |
|
||||
17
docs/sdk/models/operations/getsearchalllibrariesdirector.md
Normal file
17
docs/sdk/models/operations/getsearchalllibrariesdirector.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetSearchAllLibrariesDirector
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesDirector } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesDirector = {
|
||||
tag: "James Cameron",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
@@ -0,0 +1,17 @@
|
||||
# GetSearchAllLibrariesFlattenSeasons
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesFlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesFlattenSeasons =
|
||||
GetSearchAllLibrariesFlattenSeasons.True;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `False` | 0 |
|
||||
| `True` | 1 |
|
||||
17
docs/sdk/models/operations/getsearchalllibrariesgenre.md
Normal file
17
docs/sdk/models/operations/getsearchalllibrariesgenre.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetSearchAllLibrariesGenre
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesGenre } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesGenre = {
|
||||
tag: "Adventure",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Adventure |
|
||||
15
docs/sdk/models/operations/getsearchalllibrariesglobals.md
Normal file
15
docs/sdk/models/operations/getsearchalllibrariesglobals.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# GetSearchAllLibrariesGlobals
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesGlobals } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesGlobals = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||
@@ -0,0 +1,17 @@
|
||||
# GetSearchAllLibrariesHasThumbnail
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesHasThumbnail } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesHasThumbnail =
|
||||
GetSearchAllLibrariesHasThumbnail.True;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `False` | 0 |
|
||||
| `True` | 1 |
|
||||
21
docs/sdk/models/operations/getsearchalllibrariesimage.md
Normal file
21
docs/sdk/models/operations/getsearchalllibrariesimage.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetSearchAllLibrariesImage
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesImage, GetSearchAllLibrariesLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesImage = {
|
||||
alt: "Episode 1",
|
||||
type: GetSearchAllLibrariesLibraryType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||
| `alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
|
||||
| `type` | [operations.GetSearchAllLibrariesLibraryType](../../../sdk/models/operations/getsearchalllibrarieslibrarytype.md) | :heavy_check_mark: | N/A | background |
|
||||
| `url` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||
@@ -0,0 +1,19 @@
|
||||
# GetSearchAllLibrariesLibraryType
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesLibraryType =
|
||||
GetSearchAllLibrariesLibraryType.Background;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
17
docs/sdk/models/operations/getsearchalllibrarieslocation.md
Normal file
17
docs/sdk/models/operations/getsearchalllibrarieslocation.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetSearchAllLibrariesLocation
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesLocation } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesLocation = {
|
||||
path: "/TV Shows/House",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `path` | *string* | :heavy_minus_sign: | N/A | /TV Shows/House |
|
||||
113
docs/sdk/models/operations/getsearchalllibrariesmedia.md
Normal file
113
docs/sdk/models/operations/getsearchalllibrariesmedia.md
Normal file
@@ -0,0 +1,113 @@
|
||||
# GetSearchAllLibrariesMedia
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetSearchAllLibrariesHasThumbnail,
|
||||
GetSearchAllLibrariesMedia,
|
||||
GetSearchAllLibrariesOptimizedForStreaming,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesMedia = {
|
||||
id: 119534,
|
||||
duration: 11558112,
|
||||
bitrate: 25025,
|
||||
width: 3840,
|
||||
height: 2072,
|
||||
aspectRatio: 1.85,
|
||||
audioProfile: "dts",
|
||||
audioChannels: 6,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
optimizedForStreaming: GetSearchAllLibrariesOptimizedForStreaming.Enable,
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
id: 119542,
|
||||
key: "/library/parts/119542/1680457526/file.mkv",
|
||||
duration: 11558112,
|
||||
file:
|
||||
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
||||
size: 36158371307,
|
||||
container: "mkv",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
hasThumbnail: GetSearchAllLibrariesHasThumbnail.True,
|
||||
stream: [
|
||||
{
|
||||
id: 272796,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
selected: true,
|
||||
codec: "h264",
|
||||
index: 0,
|
||||
bitrate: 6273,
|
||||
colorPrimaries: "bt709",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt709",
|
||||
colorTrc: "bt709",
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
streamIdentifier: "2",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1088,
|
||||
codedWidth: 1920,
|
||||
frameRate: 29.97,
|
||||
hasScalingMatrix: false,
|
||||
hearingImpaired: false,
|
||||
closedCaptions: false,
|
||||
embeddedInVideo: "1",
|
||||
height: 1080,
|
||||
level: 40,
|
||||
profile: "main",
|
||||
refFrames: 4,
|
||||
scanType: "progressive",
|
||||
width: 1920,
|
||||
displayTitle: "1080p (H.264)",
|
||||
extendedDisplayTitle: "1080p (H.264)",
|
||||
channels: 2,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
audioChannelLayout: "stereo",
|
||||
samplingRate: 48000,
|
||||
title: "English",
|
||||
canAutoSync: false,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 119534 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 25025 |
|
||||
| `width` | *number* | :heavy_minus_sign: | N/A | 3840 |
|
||||
| `height` | *number* | :heavy_minus_sign: | N/A | 2072 |
|
||||
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 1.85 |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | dts |
|
||||
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | eac3 |
|
||||
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 4k |
|
||||
| `container` | *string* | :heavy_check_mark: | N/A | mkv |
|
||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `hasVoiceActivity` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | [operations.GetSearchAllLibrariesOptimizedForStreaming](../../../sdk/models/operations/getsearchalllibrariesoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `part` | [operations.GetSearchAllLibrariesPart](../../../sdk/models/operations/getsearchalllibrariespart.md)[] | :heavy_check_mark: | N/A | |
|
||||
@@ -0,0 +1,244 @@
|
||||
# GetSearchAllLibrariesMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetSearchAllLibrariesFlattenSeasons,
|
||||
GetSearchAllLibrariesHasThumbnail,
|
||||
GetSearchAllLibrariesLibraryType,
|
||||
GetSearchAllLibrariesMediaContainer,
|
||||
GetSearchAllLibrariesOptimizedForStreaming,
|
||||
GetSearchAllLibrariesShowOrdering,
|
||||
GetSearchAllLibrariesType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetSearchAllLibrariesMediaContainer = {
|
||||
size: 691.67,
|
||||
searchResult: [
|
||||
{
|
||||
score: 6974.29,
|
||||
metadata: {
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
studio: "20th Century Studios",
|
||||
skipChildren: false,
|
||||
librarySectionID: 1,
|
||||
librarySectionTitle: "Movies",
|
||||
librarySectionKey: "/library/sections/1",
|
||||
type: GetSearchAllLibrariesType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
slug: "4-for-texas",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
seasonCount: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.True,
|
||||
showOrdering: GetSearchAllLibrariesShowOrdering.Dvd,
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
banner: "/library/metadata/58683/banner/1703239236",
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14T00:00:00Z"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
grandparentRatingKey: "66",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
parentSlug: "alice-in-borderland-2020",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
media: [
|
||||
{
|
||||
id: 119534,
|
||||
duration: 11558112,
|
||||
bitrate: 25025,
|
||||
width: 3840,
|
||||
height: 2072,
|
||||
aspectRatio: 1.85,
|
||||
audioProfile: "dts",
|
||||
audioChannels: 6,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
optimizedForStreaming:
|
||||
GetSearchAllLibrariesOptimizedForStreaming.Enable,
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
id: 119542,
|
||||
key: "/library/parts/119542/1680457526/file.mkv",
|
||||
duration: 11558112,
|
||||
file:
|
||||
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
||||
size: 36158371307,
|
||||
container: "mkv",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
hasThumbnail: GetSearchAllLibrariesHasThumbnail.True,
|
||||
stream: [
|
||||
{
|
||||
id: 272796,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
selected: true,
|
||||
codec: "h264",
|
||||
index: 0,
|
||||
bitrate: 6273,
|
||||
colorPrimaries: "bt709",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt709",
|
||||
colorTrc: "bt709",
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
streamIdentifier: "2",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1088,
|
||||
codedWidth: 1920,
|
||||
frameRate: 29.97,
|
||||
hasScalingMatrix: false,
|
||||
hearingImpaired: false,
|
||||
closedCaptions: false,
|
||||
embeddedInVideo: "1",
|
||||
height: 1080,
|
||||
level: 40,
|
||||
profile: "main",
|
||||
refFrames: 4,
|
||||
scanType: "progressive",
|
||||
width: 1920,
|
||||
displayTitle: "1080p (H.264)",
|
||||
extendedDisplayTitle: "1080p (H.264)",
|
||||
channels: 2,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
audioChannelLayout: "stereo",
|
||||
samplingRate: 48000,
|
||||
title: "English",
|
||||
canAutoSync: false,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
tag: "Adventure",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "James Cameron",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "James Cameron",
|
||||
},
|
||||
],
|
||||
collection: [
|
||||
{
|
||||
tag: "Working NL Subs",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 294129,
|
||||
filter: "actor=294129",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg",
|
||||
tag: "Mike Smith",
|
||||
tagKey: "668e7e7b22bcad9064350c91",
|
||||
role: "Self",
|
||||
},
|
||||
],
|
||||
location: [
|
||||
{
|
||||
path: "/TV Shows/House",
|
||||
},
|
||||
],
|
||||
mediaGuid: [
|
||||
{
|
||||
id: "imdb://tt13015952",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
metaDataRating: [
|
||||
{
|
||||
image: "themoviedb://image.rating",
|
||||
value: 3,
|
||||
type: "audience",
|
||||
},
|
||||
],
|
||||
image: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetSearchAllLibrariesLibraryType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
titleSort: "Whale",
|
||||
viewCount: 1,
|
||||
lastViewedAt: 1682752242,
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
index: 1,
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
hasPremiumExtras: "1",
|
||||
hasPremiumPrimaryExtra: "1",
|
||||
parentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
parentStudio: "UCP",
|
||||
parentKey: "/library/metadata/66",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentYear: 2010,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
parentTheme: "/library/metadata/66/theme/1705716261",
|
||||
},
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_check_mark: | N/A |
|
||||
| `searchResult` | [operations.SearchResult](../../../sdk/models/operations/searchresult.md)[] | :heavy_check_mark: | N/A |
|
||||
17
docs/sdk/models/operations/getsearchalllibrariesmediaguid.md
Normal file
17
docs/sdk/models/operations/getsearchalllibrariesmediaguid.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetSearchAllLibrariesMediaGuid
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesMediaGuid } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesMediaGuid = {
|
||||
id: "imdb://tt13015952",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `id` | *string* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |
|
||||
307
docs/sdk/models/operations/getsearchalllibrariesmetadata.md
Normal file
307
docs/sdk/models/operations/getsearchalllibrariesmetadata.md
Normal file
@@ -0,0 +1,307 @@
|
||||
# GetSearchAllLibrariesMetadata
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetSearchAllLibrariesFlattenSeasons,
|
||||
GetSearchAllLibrariesHasThumbnail,
|
||||
GetSearchAllLibrariesLibraryType,
|
||||
GetSearchAllLibrariesMetadata,
|
||||
GetSearchAllLibrariesOptimizedForStreaming,
|
||||
GetSearchAllLibrariesShowOrdering,
|
||||
GetSearchAllLibrariesType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetSearchAllLibrariesMetadata = {
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
studio: "20th Century Studios",
|
||||
skipChildren: false,
|
||||
librarySectionID: 1,
|
||||
librarySectionTitle: "Movies",
|
||||
librarySectionKey: "/library/sections/1",
|
||||
type: GetSearchAllLibrariesType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
slug: "4-for-texas",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
seasonCount: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.True,
|
||||
showOrdering: GetSearchAllLibrariesShowOrdering.Dvd,
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
banner: "/library/metadata/58683/banner/1703239236",
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14T00:00:00Z"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
grandparentRatingKey: "66",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
parentSlug: "alice-in-borderland-2020",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
media: [
|
||||
{
|
||||
id: 119534,
|
||||
duration: 11558112,
|
||||
bitrate: 25025,
|
||||
width: 3840,
|
||||
height: 2072,
|
||||
aspectRatio: 1.85,
|
||||
audioProfile: "dts",
|
||||
audioChannels: 6,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
optimizedForStreaming: GetSearchAllLibrariesOptimizedForStreaming.Enable,
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
id: 119542,
|
||||
key: "/library/parts/119542/1680457526/file.mkv",
|
||||
duration: 11558112,
|
||||
file:
|
||||
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
||||
size: 36158371307,
|
||||
container: "mkv",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
hasThumbnail: GetSearchAllLibrariesHasThumbnail.True,
|
||||
stream: [
|
||||
{
|
||||
id: 272796,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
selected: true,
|
||||
codec: "h264",
|
||||
index: 0,
|
||||
bitrate: 6273,
|
||||
colorPrimaries: "bt709",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt709",
|
||||
colorTrc: "bt709",
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
streamIdentifier: "2",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1088,
|
||||
codedWidth: 1920,
|
||||
frameRate: 29.97,
|
||||
hasScalingMatrix: false,
|
||||
hearingImpaired: false,
|
||||
closedCaptions: false,
|
||||
embeddedInVideo: "1",
|
||||
height: 1080,
|
||||
level: 40,
|
||||
profile: "main",
|
||||
refFrames: 4,
|
||||
scanType: "progressive",
|
||||
width: 1920,
|
||||
displayTitle: "1080p (H.264)",
|
||||
extendedDisplayTitle: "1080p (H.264)",
|
||||
channels: 2,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
audioChannelLayout: "stereo",
|
||||
samplingRate: 48000,
|
||||
title: "English",
|
||||
canAutoSync: false,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
tag: "Adventure",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "James Cameron",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "James Cameron",
|
||||
},
|
||||
],
|
||||
collection: [
|
||||
{
|
||||
tag: "Working NL Subs",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 294129,
|
||||
filter: "actor=294129",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg",
|
||||
tag: "Mike Smith",
|
||||
tagKey: "668e7e7b22bcad9064350c91",
|
||||
role: "Self",
|
||||
},
|
||||
],
|
||||
location: [
|
||||
{
|
||||
path: "/TV Shows/House",
|
||||
},
|
||||
],
|
||||
mediaGuid: [
|
||||
{
|
||||
id: "imdb://tt13015952",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
metaDataRating: [
|
||||
{
|
||||
image: "themoviedb://image.rating",
|
||||
value: 3,
|
||||
type: "audience",
|
||||
},
|
||||
],
|
||||
image: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetSearchAllLibrariesLibraryType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
titleSort: "Whale",
|
||||
viewCount: 1,
|
||||
lastViewedAt: 1682752242,
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
index: 1,
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
hasPremiumExtras: "1",
|
||||
hasPremiumPrimaryExtra: "1",
|
||||
parentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
parentStudio: "UCP",
|
||||
parentKey: "/library/metadata/66",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentYear: 2010,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
parentTheme: "/library/metadata/66/theme/1705716261",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 |
|
||||
| `guid` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `studio` | *string* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||
| `skipChildren` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||
| `type` | [operations.GetSearchAllLibrariesType](../../../sdk/models/operations/getsearchalllibrariestype.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||
| `slug` | *string* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *string* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
||||
| `rating` | *number* | :heavy_minus_sign: | N/A | 7.6 |
|
||||
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 9.2 |
|
||||
| `year` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `seasonCount` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||
| `flattenSeasons` | [operations.GetSearchAllLibrariesFlattenSeasons](../../../sdk/models/operations/getsearchalllibrariesflattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `showOrdering` | [operations.GetSearchAllLibrariesShowOrdering](../../../sdk/models/operations/getsearchalllibrariesshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
||||
| `addedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `chapterSource` | *string* | :heavy_minus_sign: | N/A | media |
|
||||
| `primaryExtraKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||
| `ratingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `grandparentRatingKey` | *string* | :heavy_minus_sign: | N/A | 66 |
|
||||
| `grandparentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `grandparentTitle` | *string* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `grandparentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `parentSlug` | *string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `grandparentSlug` | *string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `grandparentArt` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||
| `grandparentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| `media` | [operations.GetSearchAllLibrariesMedia](../../../sdk/models/operations/getsearchalllibrariesmedia.md)[] | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
||||
| `genre` | [operations.GetSearchAllLibrariesGenre](../../../sdk/models/operations/getsearchalllibrariesgenre.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | [operations.GetSearchAllLibrariesCountry](../../../sdk/models/operations/getsearchalllibrariescountry.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `director` | [operations.GetSearchAllLibrariesDirector](../../../sdk/models/operations/getsearchalllibrariesdirector.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | [operations.GetSearchAllLibrariesWriter](../../../sdk/models/operations/getsearchalllibrarieswriter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | [operations.GetSearchAllLibrariesCollection](../../../sdk/models/operations/getsearchalllibrariescollection.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | [operations.GetSearchAllLibrariesRole](../../../sdk/models/operations/getsearchalllibrariesrole.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `location` | [operations.GetSearchAllLibrariesLocation](../../../sdk/models/operations/getsearchalllibrarieslocation.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `mediaGuid` | [operations.GetSearchAllLibrariesMediaGuid](../../../sdk/models/operations/getsearchalllibrariesmediaguid.md)[] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||
| `ultraBlurColors` | [operations.GetSearchAllLibrariesUltraBlurColors](../../../sdk/models/operations/getsearchalllibrariesultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `metaDataRating` | [operations.GetSearchAllLibrariesMetaDataRating](../../../sdk/models/operations/getsearchalllibrariesmetadatarating.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `image` | [operations.GetSearchAllLibrariesImage](../../../sdk/models/operations/getsearchalllibrariesimage.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `titleSort` | *string* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||
| `originalTitle` | *string* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `viewOffset` | *number* | :heavy_minus_sign: | N/A | 5222500 |
|
||||
| `skipCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `index` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `theme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
||||
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 14 |
|
||||
| `viewedLeafCount` | *number* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `childCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `hasPremiumExtras` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `hasPremiumPrimaryExtra` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
||||
| `parentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `parentStudio` | *string* | :heavy_minus_sign: | N/A | UCP |
|
||||
| `parentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `parentTitle` | *string* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `parentIndex` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parentYear` | *number* | :heavy_minus_sign: | N/A | 2010 |
|
||||
| `parentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `parentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
@@ -0,0 +1,21 @@
|
||||
# GetSearchAllLibrariesMetaDataRating
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesMetaDataRating } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesMetaDataRating = {
|
||||
image: "themoviedb://image.rating",
|
||||
value: 3,
|
||||
type: "audience",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `image` | *string* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
|
||||
| `value` | *number* | :heavy_check_mark: | The value of the rating. | 3 |
|
||||
| `type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
||||
@@ -0,0 +1,17 @@
|
||||
# GetSearchAllLibrariesOptimizedForStreaming
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesOptimizedForStreaming } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesOptimizedForStreaming =
|
||||
GetSearchAllLibrariesOptimizedForStreaming.Enable;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
83
docs/sdk/models/operations/getsearchalllibrariespart.md
Normal file
83
docs/sdk/models/operations/getsearchalllibrariespart.md
Normal file
@@ -0,0 +1,83 @@
|
||||
# GetSearchAllLibrariesPart
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesHasThumbnail, GetSearchAllLibrariesPart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesPart = {
|
||||
id: 119542,
|
||||
key: "/library/parts/119542/1680457526/file.mkv",
|
||||
duration: 11558112,
|
||||
file:
|
||||
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
||||
size: 36158371307,
|
||||
container: "mkv",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
hasThumbnail: GetSearchAllLibrariesHasThumbnail.True,
|
||||
stream: [
|
||||
{
|
||||
id: 272796,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
selected: true,
|
||||
codec: "h264",
|
||||
index: 0,
|
||||
bitrate: 6273,
|
||||
colorPrimaries: "bt709",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt709",
|
||||
colorTrc: "bt709",
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
streamIdentifier: "2",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1088,
|
||||
codedWidth: 1920,
|
||||
frameRate: 29.97,
|
||||
hasScalingMatrix: false,
|
||||
hearingImpaired: false,
|
||||
closedCaptions: false,
|
||||
embeddedInVideo: "1",
|
||||
height: 1080,
|
||||
level: 40,
|
||||
profile: "main",
|
||||
refFrames: 4,
|
||||
scanType: "progressive",
|
||||
width: 1920,
|
||||
displayTitle: "1080p (H.264)",
|
||||
extendedDisplayTitle: "1080p (H.264)",
|
||||
channels: 2,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
audioChannelLayout: "stereo",
|
||||
samplingRate: 48000,
|
||||
title: "English",
|
||||
canAutoSync: false,
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 119542 |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `file` | *string* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `size` | *number* | :heavy_check_mark: | N/A | 36158371307 |
|
||||
| `container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | dts |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `indexes` | *string* | :heavy_minus_sign: | N/A | sd |
|
||||
| `hasThumbnail` | [operations.GetSearchAllLibrariesHasThumbnail](../../../sdk/models/operations/getsearchalllibrarieshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `stream` | [operations.GetSearchAllLibrariesStream](../../../sdk/models/operations/getsearchalllibrariesstream.md)[] | :heavy_minus_sign: | N/A | |
|
||||
32
docs/sdk/models/operations/getsearchalllibrariesrequest.md
Normal file
32
docs/sdk/models/operations/getsearchalllibrariesrequest.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# GetSearchAllLibrariesRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetSearchAllLibrariesRequest,
|
||||
QueryParamIncludeCollections,
|
||||
QueryParamIncludeExternalMedia,
|
||||
SearchTypes,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesRequest = {
|
||||
query: "<value>",
|
||||
searchTypes: [
|
||||
SearchTypes.OtherVideos,
|
||||
],
|
||||
includeCollections: QueryParamIncludeCollections.Enable,
|
||||
includeExternalMedia: QueryParamIncludeExternalMedia.Enable,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `query` | *string* | :heavy_check_mark: | The search query term. | |
|
||||
| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||
| `limit` | *number* | :heavy_minus_sign: | Limit the number of results returned. | |
|
||||
| `searchTypes` | [operations.SearchTypes](../../../sdk/models/operations/searchtypes.md)[] | :heavy_minus_sign: | A comma-separated list of search types to include. Valid values are: movies, music, otherVideos, people, tv.<br/> | movies,music,otherVideos,people,tv |
|
||||
| `includeCollections` | [operations.QueryParamIncludeCollections](../../../sdk/models/operations/queryparamincludecollections.md) | :heavy_minus_sign: | Whether to include collections in the search results. | 1 |
|
||||
| `includeExternalMedia` | [operations.QueryParamIncludeExternalMedia](../../../sdk/models/operations/queryparamincludeexternalmedia.md) | :heavy_minus_sign: | Whether to include external media in the search results. | 1 |
|
||||
255
docs/sdk/models/operations/getsearchalllibrariesresponse.md
Normal file
255
docs/sdk/models/operations/getsearchalllibrariesresponse.md
Normal file
@@ -0,0 +1,255 @@
|
||||
# GetSearchAllLibrariesResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetSearchAllLibrariesFlattenSeasons,
|
||||
GetSearchAllLibrariesHasThumbnail,
|
||||
GetSearchAllLibrariesLibraryType,
|
||||
GetSearchAllLibrariesOptimizedForStreaming,
|
||||
GetSearchAllLibrariesResponse,
|
||||
GetSearchAllLibrariesShowOrdering,
|
||||
GetSearchAllLibrariesType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetSearchAllLibrariesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 511,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 8558.03,
|
||||
searchResult: [
|
||||
{
|
||||
score: 117.14,
|
||||
metadata: {
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
studio: "20th Century Studios",
|
||||
skipChildren: false,
|
||||
librarySectionID: 1,
|
||||
librarySectionTitle: "Movies",
|
||||
librarySectionKey: "/library/sections/1",
|
||||
type: GetSearchAllLibrariesType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
slug: "4-for-texas",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
seasonCount: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.True,
|
||||
showOrdering: GetSearchAllLibrariesShowOrdering.Dvd,
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
banner: "/library/metadata/58683/banner/1703239236",
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14T00:00:00Z"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
grandparentRatingKey: "66",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
parentSlug: "alice-in-borderland-2020",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
media: [
|
||||
{
|
||||
id: 119534,
|
||||
duration: 11558112,
|
||||
bitrate: 25025,
|
||||
width: 3840,
|
||||
height: 2072,
|
||||
aspectRatio: 1.85,
|
||||
audioProfile: "dts",
|
||||
audioChannels: 6,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
optimizedForStreaming:
|
||||
GetSearchAllLibrariesOptimizedForStreaming.Enable,
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
id: 119542,
|
||||
key: "/library/parts/119542/1680457526/file.mkv",
|
||||
duration: 11558112,
|
||||
file:
|
||||
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
||||
size: 36158371307,
|
||||
container: "mkv",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
hasThumbnail: GetSearchAllLibrariesHasThumbnail.True,
|
||||
stream: [
|
||||
{
|
||||
id: 272796,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
selected: true,
|
||||
codec: "h264",
|
||||
index: 0,
|
||||
bitrate: 6273,
|
||||
colorPrimaries: "bt709",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt709",
|
||||
colorTrc: "bt709",
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
streamIdentifier: "2",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1088,
|
||||
codedWidth: 1920,
|
||||
frameRate: 29.97,
|
||||
hasScalingMatrix: false,
|
||||
hearingImpaired: false,
|
||||
closedCaptions: false,
|
||||
embeddedInVideo: "1",
|
||||
height: 1080,
|
||||
level: 40,
|
||||
profile: "main",
|
||||
refFrames: 4,
|
||||
scanType: "progressive",
|
||||
width: 1920,
|
||||
displayTitle: "1080p (H.264)",
|
||||
extendedDisplayTitle: "1080p (H.264)",
|
||||
channels: 2,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
audioChannelLayout: "stereo",
|
||||
samplingRate: 48000,
|
||||
title: "English",
|
||||
canAutoSync: false,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
tag: "Adventure",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "James Cameron",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "James Cameron",
|
||||
},
|
||||
],
|
||||
collection: [
|
||||
{
|
||||
tag: "Working NL Subs",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 294129,
|
||||
filter: "actor=294129",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg",
|
||||
tag: "Mike Smith",
|
||||
tagKey: "668e7e7b22bcad9064350c91",
|
||||
role: "Self",
|
||||
},
|
||||
],
|
||||
location: [
|
||||
{
|
||||
path: "/TV Shows/House",
|
||||
},
|
||||
],
|
||||
mediaGuid: [
|
||||
{
|
||||
id: "imdb://tt13015952",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
metaDataRating: [
|
||||
{
|
||||
image: "themoviedb://image.rating",
|
||||
value: 3,
|
||||
type: "audience",
|
||||
},
|
||||
],
|
||||
image: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetSearchAllLibrariesLibraryType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
titleSort: "Whale",
|
||||
viewCount: 1,
|
||||
lastViewedAt: 1682752242,
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
index: 1,
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
hasPremiumExtras: "1",
|
||||
hasPremiumPrimaryExtra: "1",
|
||||
parentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
parentStudio: "UCP",
|
||||
parentKey: "/library/metadata/66",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentYear: 2010,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
parentTheme: "/library/metadata/66/theme/1705716261",
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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.GetSearchAllLibrariesResponseBody](../../../sdk/models/operations/getsearchalllibrariesresponsebody.md) | :heavy_minus_sign: | The libraries available on the Server |
|
||||
247
docs/sdk/models/operations/getsearchalllibrariesresponsebody.md
Normal file
247
docs/sdk/models/operations/getsearchalllibrariesresponsebody.md
Normal file
@@ -0,0 +1,247 @@
|
||||
# GetSearchAllLibrariesResponseBody
|
||||
|
||||
The libraries available on the Server
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetSearchAllLibrariesFlattenSeasons,
|
||||
GetSearchAllLibrariesHasThumbnail,
|
||||
GetSearchAllLibrariesLibraryType,
|
||||
GetSearchAllLibrariesOptimizedForStreaming,
|
||||
GetSearchAllLibrariesResponseBody,
|
||||
GetSearchAllLibrariesShowOrdering,
|
||||
GetSearchAllLibrariesType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetSearchAllLibrariesResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 4535.43,
|
||||
searchResult: [
|
||||
{
|
||||
score: 7220.56,
|
||||
metadata: {
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
studio: "20th Century Studios",
|
||||
skipChildren: false,
|
||||
librarySectionID: 1,
|
||||
librarySectionTitle: "Movies",
|
||||
librarySectionKey: "/library/sections/1",
|
||||
type: GetSearchAllLibrariesType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
slug: "4-for-texas",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
seasonCount: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
flattenSeasons: GetSearchAllLibrariesFlattenSeasons.True,
|
||||
showOrdering: GetSearchAllLibrariesShowOrdering.Dvd,
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
banner: "/library/metadata/58683/banner/1703239236",
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14T00:00:00Z"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
grandparentRatingKey: "66",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
parentSlug: "alice-in-borderland-2020",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
media: [
|
||||
{
|
||||
id: 119534,
|
||||
duration: 11558112,
|
||||
bitrate: 25025,
|
||||
width: 3840,
|
||||
height: 2072,
|
||||
aspectRatio: 1.85,
|
||||
audioProfile: "dts",
|
||||
audioChannels: 6,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
optimizedForStreaming:
|
||||
GetSearchAllLibrariesOptimizedForStreaming.Enable,
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
id: 119542,
|
||||
key: "/library/parts/119542/1680457526/file.mkv",
|
||||
duration: 11558112,
|
||||
file:
|
||||
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
||||
size: 36158371307,
|
||||
container: "mkv",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
hasThumbnail: GetSearchAllLibrariesHasThumbnail.True,
|
||||
stream: [
|
||||
{
|
||||
id: 272796,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
selected: true,
|
||||
codec: "h264",
|
||||
index: 0,
|
||||
bitrate: 6273,
|
||||
colorPrimaries: "bt709",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt709",
|
||||
colorTrc: "bt709",
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
streamIdentifier: "2",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1088,
|
||||
codedWidth: 1920,
|
||||
frameRate: 29.97,
|
||||
hasScalingMatrix: false,
|
||||
hearingImpaired: false,
|
||||
closedCaptions: false,
|
||||
embeddedInVideo: "1",
|
||||
height: 1080,
|
||||
level: 40,
|
||||
profile: "main",
|
||||
refFrames: 4,
|
||||
scanType: "progressive",
|
||||
width: 1920,
|
||||
displayTitle: "1080p (H.264)",
|
||||
extendedDisplayTitle: "1080p (H.264)",
|
||||
channels: 2,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
audioChannelLayout: "stereo",
|
||||
samplingRate: 48000,
|
||||
title: "English",
|
||||
canAutoSync: false,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
tag: "Adventure",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "James Cameron",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "James Cameron",
|
||||
},
|
||||
],
|
||||
collection: [
|
||||
{
|
||||
tag: "Working NL Subs",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 294129,
|
||||
filter: "actor=294129",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg",
|
||||
tag: "Mike Smith",
|
||||
tagKey: "668e7e7b22bcad9064350c91",
|
||||
role: "Self",
|
||||
},
|
||||
],
|
||||
location: [
|
||||
{
|
||||
path: "/TV Shows/House",
|
||||
},
|
||||
],
|
||||
mediaGuid: [
|
||||
{
|
||||
id: "imdb://tt13015952",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
metaDataRating: [
|
||||
{
|
||||
image: "themoviedb://image.rating",
|
||||
value: 3,
|
||||
type: "audience",
|
||||
},
|
||||
],
|
||||
image: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetSearchAllLibrariesLibraryType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
titleSort: "Whale",
|
||||
viewCount: 1,
|
||||
lastViewedAt: 1682752242,
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
index: 1,
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
hasPremiumExtras: "1",
|
||||
hasPremiumPrimaryExtra: "1",
|
||||
parentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
parentStudio: "UCP",
|
||||
parentKey: "/library/metadata/66",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentYear: 2010,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
parentTheme: "/library/metadata/66/theme/1705716261",
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.GetSearchAllLibrariesMediaContainer](../../../sdk/models/operations/getsearchalllibrariesmediacontainer.md) | :heavy_check_mark: | N/A |
|
||||
28
docs/sdk/models/operations/getsearchalllibrariesrole.md
Normal file
28
docs/sdk/models/operations/getsearchalllibrariesrole.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# GetSearchAllLibrariesRole
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesRole } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesRole = {
|
||||
id: 294129,
|
||||
filter: "actor=294129",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg",
|
||||
tag: "Mike Smith",
|
||||
tagKey: "668e7e7b22bcad9064350c91",
|
||||
role: "Self",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 |
|
||||
| `filter` | *string* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
|
||||
| `tag` | *string* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
|
||||
| `tagKey` | *string* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
|
||||
| `role` | *string* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |
|
||||
@@ -0,0 +1,28 @@
|
||||
# GetSearchAllLibrariesShowOrdering
|
||||
|
||||
Setting that indicates the episode ordering for the show
|
||||
None = Library default,
|
||||
tmdbAiring = The Movie Database (Aired),
|
||||
aired = TheTVDB (Aired),
|
||||
dvd = TheTVDB (DVD),
|
||||
absolute = TheTVDB (Absolute)).
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesShowOrdering } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesShowOrdering =
|
||||
GetSearchAllLibrariesShowOrdering.Dvd;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `None` | None |
|
||||
| `TmdbAiring` | tmdbAiring |
|
||||
| `Aired` | aired |
|
||||
| `Dvd` | dvd |
|
||||
| `Absolute` | absolute |
|
||||
91
docs/sdk/models/operations/getsearchalllibrariesstream.md
Normal file
91
docs/sdk/models/operations/getsearchalllibrariesstream.md
Normal file
@@ -0,0 +1,91 @@
|
||||
# GetSearchAllLibrariesStream
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesStream } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesStream = {
|
||||
id: 272796,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
selected: true,
|
||||
codec: "h264",
|
||||
index: 0,
|
||||
bitrate: 6273,
|
||||
colorPrimaries: "bt709",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt709",
|
||||
colorTrc: "bt709",
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
streamIdentifier: "2",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1088,
|
||||
codedWidth: 1920,
|
||||
frameRate: 29.97,
|
||||
hasScalingMatrix: false,
|
||||
hearingImpaired: false,
|
||||
closedCaptions: false,
|
||||
embeddedInVideo: "1",
|
||||
height: 1080,
|
||||
level: 40,
|
||||
profile: "main",
|
||||
refFrames: 4,
|
||||
scanType: "progressive",
|
||||
width: 1920,
|
||||
displayTitle: "1080p (H.264)",
|
||||
extendedDisplayTitle: "1080p (H.264)",
|
||||
channels: 2,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
audioChannelLayout: "stereo",
|
||||
samplingRate: 48000,
|
||||
title: "English",
|
||||
canAutoSync: false,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 272796 |
|
||||
| `streamType` | *number* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
|
||||
| `default` | *boolean* | :heavy_minus_sign: | Indicates if this is the default stream | true |
|
||||
| `selected` | *boolean* | :heavy_minus_sign: | Indicates if the stream is selected | true |
|
||||
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream | h264 |
|
||||
| `index` | *number* | :heavy_check_mark: | The index of the stream | 0 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
|
||||
| `colorPrimaries` | *string* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
|
||||
| `colorRange` | *string* | :heavy_minus_sign: | The color range of the video stream | tv |
|
||||
| `colorSpace` | *string* | :heavy_minus_sign: | The color space of the video stream | bt709 |
|
||||
| `colorTrc` | *string* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
|
||||
| `bitDepth` | *number* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
|
||||
| `chromaLocation` | *string* | :heavy_minus_sign: | The chroma location of the video stream | left |
|
||||
| `streamIdentifier` | *string* | :heavy_minus_sign: | The identifier of the video stream | 2 |
|
||||
| `chromaSubsampling` | *string* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
|
||||
| `codedHeight` | *number* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
|
||||
| `codedWidth` | *number* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
|
||||
| `frameRate` | *number* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
|
||||
| `hasScalingMatrix` | *boolean* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
|
||||
| `hearingImpaired` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `closedCaptions` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `embeddedInVideo` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `height` | *number* | :heavy_minus_sign: | The height of the video stream | 1080 |
|
||||
| `level` | *number* | :heavy_minus_sign: | The level of the video codec | 40 |
|
||||
| `profile` | *string* | :heavy_minus_sign: | The profile of the video codec | main |
|
||||
| `refFrames` | *number* | :heavy_minus_sign: | Number of reference frames | 4 |
|
||||
| `scanType` | *string* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
|
||||
| `width` | *number* | :heavy_minus_sign: | The width of the video stream | 1920 |
|
||||
| `displayTitle` | *string* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
|
||||
| `extendedDisplayTitle` | *string* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
|
||||
| `channels` | *number* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
|
||||
| `language` | *string* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
|
||||
| `languageTag` | *string* | :heavy_minus_sign: | Language tag of the stream | en |
|
||||
| `languageCode` | *string* | :heavy_minus_sign: | Language code of the stream | eng |
|
||||
| `audioChannelLayout` | *string* | :heavy_minus_sign: | The audio channel layout | stereo |
|
||||
| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
|
||||
| `title` | *string* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
|
||||
| `canAutoSync` | *boolean* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |
|
||||
21
docs/sdk/models/operations/getsearchalllibrariestype.md
Normal file
21
docs/sdk/models/operations/getsearchalllibrariestype.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetSearchAllLibrariesType
|
||||
|
||||
The type of media content
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesType = GetSearchAllLibrariesType.Movie;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
@@ -0,0 +1,23 @@
|
||||
# GetSearchAllLibrariesUltraBlurColors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesUltraBlurColors } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesUltraBlurColors = {
|
||||
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/getsearchalllibrarieswriter.md
Normal file
17
docs/sdk/models/operations/getsearchalllibrarieswriter.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetSearchAllLibrariesWriter
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetSearchAllLibrariesWriter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSearchAllLibrariesWriter = {
|
||||
tag: "James Cameron",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
@@ -10,6 +10,6 @@ let value: GetServerResourcesGlobals = {};
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||
@@ -14,9 +14,9 @@ let value: GetServerResourcesRequest = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `includeHttps` | [operations.IncludeHttps](../../../sdk/models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
|
||||
| `includeRelay` | [operations.IncludeRelay](../../../sdk/models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
|
||||
| `includeIPv6` | [operations.IncludeIPv6](../../../sdk/models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
|
||||
| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
||||
| `includeHttps` | [operations.IncludeHttps](../../../sdk/models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
|
||||
| `includeRelay` | [operations.IncludeRelay](../../../sdk/models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
|
||||
| `includeIPv6` | [operations.IncludeIPv6](../../../sdk/models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
|
||||
| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||
@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetSessionHistoryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 205,
|
||||
statusCode: 423,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetSessionsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetSessionsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 102,
|
||||
statusCode: 226,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetSourceConnectionInformationResponse } from "@lukehagar/plexjs/sdk/mo
|
||||
|
||||
let value: GetSourceConnectionInformationResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 506,
|
||||
statusCode: 202,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetStatisticsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetStatisticsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 302,
|
||||
statusCode: 411,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -24,4 +24,4 @@ let value: GetThumbImageRequest = {
|
||||
| `height` | *number* | :heavy_check_mark: | N/A | 396 |
|
||||
| `minSize` | *number* | :heavy_check_mark: | N/A | 1 |
|
||||
| `upscale` | *number* | :heavy_check_mark: | N/A | 1 |
|
||||
| `xPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
|
||||
| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
|
||||
@@ -10,10 +10,10 @@ let value: GetTokenByPinIdGlobals = {};
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
|
||||
| `clientName` | *string* | :heavy_minus_sign: | N/A | Plex Web |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | N/A | Linux |
|
||||
| `clientVersion` | *string* | :heavy_minus_sign: | N/A | 4.133.0 |
|
||||
| `clientPlatform` | *string* | :heavy_minus_sign: | N/A | Chrome |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
|
||||
| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client application. | Roku |
|
||||
@@ -12,11 +12,11 @@ let value: GetTokenByPinIdRequest = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `pinID` | *number* | :heavy_check_mark: | The PinID to retrieve an access token for | |
|
||||
| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
|
||||
| `clientName` | *string* | :heavy_minus_sign: | N/A | Plex Web |
|
||||
| `deviceName` | *string* | :heavy_minus_sign: | N/A | Linux |
|
||||
| `clientVersion` | *string* | :heavy_minus_sign: | N/A | 4.133.0 |
|
||||
| `clientPlatform` | *string* | :heavy_minus_sign: | N/A | Chrome |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `pinID` | *number* | :heavy_check_mark: | The PinID to retrieve an access token for | |
|
||||
| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
|
||||
| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
|
||||
| `platform` | *string* | :heavy_minus_sign: | The platform of the client application. | Roku |
|
||||
@@ -1,113 +0,0 @@
|
||||
# GetTokenDetailsFeatures
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetTokenDetailsFeatures } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetTokenDetailsFeatures =
|
||||
GetTokenDetailsFeatures.DisableSharingFriendships;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| --------------------------------------- | --------------------------------------- |
|
||||
| `AndroidDolbyVision` | Android - Dolby Vision |
|
||||
| `AndroidPiP` | Android - PiP |
|
||||
| `CUSunset` | CU Sunset |
|
||||
| `HRKEnableEUR` | HRK_enable_EUR |
|
||||
| `TREBLEShowFeatures` | TREBLE-show-features |
|
||||
| `AdCountdownTimer` | ad-countdown-timer |
|
||||
| `AdaptiveBitrate` | adaptive_bitrate |
|
||||
| `AlbumTypes` | album-types |
|
||||
| `AllowDvr` | allow_dvr |
|
||||
| `AmazonLoopDebug` | amazon-loop-debug |
|
||||
| `AvodAdAnalysis` | avod-ad-analysis |
|
||||
| `AvodNewMedia` | avod-new-media |
|
||||
| `BlacklistGetSignin` | blacklist_get_signin |
|
||||
| `BoostVoices` | boost-voices |
|
||||
| `CameraUpload` | camera_upload |
|
||||
| `ClientRadioStations` | client-radio-stations |
|
||||
| `CloudflareTurnstileRequired` | cloudflare-turnstile-required |
|
||||
| `Cloudsync` | cloudsync |
|
||||
| `Collections` | collections |
|
||||
| `CommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications |
|
||||
| `CommunityAccessPlexTv` | community_access_plex_tv |
|
||||
| `CompanionsSonos` | companions_sonos |
|
||||
| `ContentFilter` | content_filter |
|
||||
| `CustomHomeRemoval` | custom-home-removal |
|
||||
| `DisableHomeUserFriendships` | disable_home_user_friendships |
|
||||
| `DisableSharingFriendships` | disable_sharing_friendships |
|
||||
| `DownloadsGating` | downloads-gating |
|
||||
| `DrmSupport` | drm_support |
|
||||
| `Dvr` | dvr |
|
||||
| `DvrBlockUnsupportedCountries` | dvr-block-unsupported-countries |
|
||||
| `EpgRecentChannels` | epg-recent-channels |
|
||||
| `ExcludeRestrictions` | exclude restrictions |
|
||||
| `FederatedAuth` | federated-auth |
|
||||
| `FriendRequestPushNotifications` | friend_request_push_notifications |
|
||||
| `GrandfatherSync` | grandfather-sync |
|
||||
| `GuidedUpgrade` | guided-upgrade |
|
||||
| `HardwareTranscoding` | hardware_transcoding |
|
||||
| `Home` | home |
|
||||
| `Hwtranscode` | hwtranscode |
|
||||
| `ImaggaV2` | imagga-v2 |
|
||||
| `IncreasePasswordComplexity` | increase-password-complexity |
|
||||
| `Ios14PrivacyBanner` | ios14-privacy-banner |
|
||||
| `IterableNotificationTokens` | iterable-notification-tokens |
|
||||
| `ItemClusters` | item_clusters |
|
||||
| `KeepPaymentMethod` | keep-payment-method |
|
||||
| `KevinBacon` | kevin-bacon |
|
||||
| `KoreaConsent` | korea-consent |
|
||||
| `LeIsrgRootX1` | le_isrg_root_x1 |
|
||||
| `LetsEncrypt` | lets_encrypt |
|
||||
| `LightningDvrPivot` | lightning-dvr-pivot |
|
||||
| `LiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments |
|
||||
| `Livetv` | livetv |
|
||||
| `Lyrics` | lyrics |
|
||||
| `MetadataSearch` | metadata_search |
|
||||
| `MusicAnalysis` | music-analysis |
|
||||
| `MusicVideos` | music_videos |
|
||||
| `NewPlexPassPrices` | new_plex_pass_prices |
|
||||
| `NewsProviderSunsetModal` | news-provider-sunset-modal |
|
||||
| `Nominatim` | nominatim |
|
||||
| `Pass` | pass |
|
||||
| `PhotosFavorites` | photos-favorites |
|
||||
| `PhotosMetadataEdition` | photos-metadata-edition |
|
||||
| `PhotosV6Edit` | photosV6-edit |
|
||||
| `PhotosV6TvAlbums` | photosV6-tv-albums |
|
||||
| `PmsHealth` | pms_health |
|
||||
| `PremiumDashboard` | premium-dashboard |
|
||||
| `PremiumMusicMetadata` | premium_music_metadata |
|
||||
| `Radio` | radio |
|
||||
| `RateLimitClientToken` | rate-limit-client-token |
|
||||
| `ScrobblingServicePlexTv` | scrobbling-service-plex-tv |
|
||||
| `SessionBandwidthRestrictions` | session_bandwidth_restrictions |
|
||||
| `SessionKick` | session_kick |
|
||||
| `SharedServerNotification` | shared_server_notification |
|
||||
| `SharedSourceNotification` | shared_source_notification |
|
||||
| `SigninNotification` | signin_notification |
|
||||
| `SigninWithApple` | signin_with_apple |
|
||||
| `SilenceRemoval` | silence-removal |
|
||||
| `SleepTimer` | sleep-timer |
|
||||
| `SpringServeAdProvider` | spring_serve_ad_provider |
|
||||
| `Sync` | sync |
|
||||
| `SweetFades` | sweet-fades |
|
||||
| `TranscoderCache` | transcoder_cache |
|
||||
| `Trailers` | trailers |
|
||||
| `TunerSharing` | tuner-sharing |
|
||||
| `TwoFactorAuthentication` | two-factor-authentication |
|
||||
| `Unsupportedtuners` | unsupportedtuners |
|
||||
| `Upgrade3ds2` | upgrade-3ds2 |
|
||||
| `Visualizers` | visualizers |
|
||||
| `VodSchema` | vod-schema |
|
||||
| `VodCloudflare` | vod_cloudflare |
|
||||
| `VolumeLeveling` | volume-leveling |
|
||||
| `WatchTogetherInvite` | watch-together-invite |
|
||||
| `WatchlistRss` | watchlist-rss |
|
||||
| `WebServerDashboard` | web_server_dashboard |
|
||||
| `Webhooks` | webhooks |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -7,10 +7,8 @@ import {
|
||||
AutoSelectSubtitle,
|
||||
DefaultSubtitleAccessibility,
|
||||
DefaultSubtitleForced,
|
||||
Features,
|
||||
GetTokenDetailsAuthenticationResponseStatus,
|
||||
GetTokenDetailsAuthenticationStatus,
|
||||
GetTokenDetailsFeatures,
|
||||
GetTokenDetailsResponse,
|
||||
GetTokenDetailsStatus,
|
||||
MailingListStatus,
|
||||
@@ -20,7 +18,7 @@ import {
|
||||
|
||||
let value: GetTokenDetailsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 103,
|
||||
statusCode: 100,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
@@ -49,7 +47,7 @@ let value: GetTokenDetailsResponse = {
|
||||
joinedAt: 1721154902,
|
||||
locale: null,
|
||||
mailingListActive: false,
|
||||
mailingListStatus: MailingListStatus.Unsubscribed,
|
||||
mailingListStatus: MailingListStatus.Active,
|
||||
maxHomeSize: 15,
|
||||
pin: "string",
|
||||
profile: {
|
||||
@@ -80,7 +78,7 @@ let value: GetTokenDetailsResponse = {
|
||||
],
|
||||
subscription: {
|
||||
features: [
|
||||
Features.AndroidDolbyVision,
|
||||
"Android - Dolby Vision",
|
||||
],
|
||||
active: true,
|
||||
subscribedAt: "2021-04-12T18:21:12Z",
|
||||
@@ -92,7 +90,7 @@ let value: GetTokenDetailsResponse = {
|
||||
subscriptions: [
|
||||
{
|
||||
features: [
|
||||
GetTokenDetailsFeatures.AndroidDolbyVision,
|
||||
"Android - Dolby Vision",
|
||||
],
|
||||
active: true,
|
||||
subscribedAt: "2021-04-12T18:21:12Z",
|
||||
|
||||
@@ -16,7 +16,7 @@ let value: GetTokenDetailsSubscription = {
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `features` | [operations.GetTokenDetailsFeatures](../../../sdk/models/operations/gettokendetailsfeatures.md)[] | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
|
||||
| `features` | *string*[] | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
|
||||
| `active` | *boolean* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
|
||||
| `subscribedAt` | *string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
|
||||
| `status` | [operations.GetTokenDetailsAuthenticationResponseStatus](../../../sdk/models/operations/gettokendetailsauthenticationresponsestatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
|
||||
|
||||
@@ -9,10 +9,8 @@ import {
|
||||
AutoSelectSubtitle,
|
||||
DefaultSubtitleAccessibility,
|
||||
DefaultSubtitleForced,
|
||||
Features,
|
||||
GetTokenDetailsAuthenticationResponseStatus,
|
||||
GetTokenDetailsAuthenticationStatus,
|
||||
GetTokenDetailsFeatures,
|
||||
GetTokenDetailsStatus,
|
||||
GetTokenDetailsUserPlexAccount,
|
||||
MailingListStatus,
|
||||
@@ -76,7 +74,7 @@ let value: GetTokenDetailsUserPlexAccount = {
|
||||
],
|
||||
subscription: {
|
||||
features: [
|
||||
Features.AndroidDolbyVision,
|
||||
"Android - Dolby Vision",
|
||||
],
|
||||
active: true,
|
||||
subscribedAt: "2021-04-12T18:21:12Z",
|
||||
@@ -88,7 +86,7 @@ let value: GetTokenDetailsUserPlexAccount = {
|
||||
subscriptions: [
|
||||
{
|
||||
features: [
|
||||
GetTokenDetailsFeatures.AndroidDolbyVision,
|
||||
"Android - Dolby Vision",
|
||||
],
|
||||
active: true,
|
||||
subscribedAt: "2021-04-12T18:21:12Z",
|
||||
|
||||
@@ -6,8 +6,8 @@
|
||||
import { GetTopWatchedContentQueryParamType, GetTopWatchedContentRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetTopWatchedContentRequest = {
|
||||
type: GetTopWatchedContentQueryParamType.TvShow,
|
||||
includeGuids: 1,
|
||||
type: GetTopWatchedContentQueryParamType.TvShow,
|
||||
};
|
||||
```
|
||||
|
||||
@@ -15,5 +15,5 @@ let value: GetTopWatchedContentRequest = {
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [operations.GetTopWatchedContentQueryParamType](../../../sdk/models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<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 |
|
||||
| `includeGuids` | *number* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
| `includeGuids` | *number* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
| `type` | [operations.GetTopWatchedContentQueryParamType](../../../sdk/models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<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 |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user