Compare commits

...

1 Commits

Author SHA1 Message Date
speakeasybot
8360d057ab ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.487.0 2025-02-07 00:11:14 +00:00
153 changed files with 6606 additions and 3407 deletions

File diff suppressed because one or more lines are too long

View File

@@ -13,7 +13,7 @@ generation:
oAuth2ClientCredentialsEnabled: true oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false oAuth2PasswordEnabled: false
typescript: typescript:
version: 0.32.5 version: 0.33.0
additionalDependencies: additionalDependencies:
dependencies: {} dependencies: {}
devDependencies: {} devDependencies: {}

View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.484.1 speakeasyVersion: 1.487.0
sources: sources:
my-source: my-source:
sourceNamespace: my-source sourceNamespace: my-source
@@ -9,20 +9,20 @@ sources:
- main - main
plexapi: plexapi:
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:e6ab335dd91a4165f4510e4a3af8a55819c6310b7e66251266d2384376f3ccae sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64
sourceBlobDigest: sha256:89d1b1133e400c89f0d06efe5e5168f5ba25a413e1ab8380d442d6b233e2e5a9 sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8
tags: tags:
- latest - latest
- speakeasy-sdk-regen-1738800605 - speakeasy-sdk-regen-1738886999
- 0.0.3 - 0.0.3
targets: targets:
plexjs: plexjs:
source: plexapi source: plexapi
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:e6ab335dd91a4165f4510e4a3af8a55819c6310b7e66251266d2384376f3ccae sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64
sourceBlobDigest: sha256:89d1b1133e400c89f0d06efe5e5168f5ba25a413e1ab8380d442d6b233e2e5a9 sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8
codeSamplesNamespace: code-samples-typescript-plexjs codeSamplesNamespace: code-samples-typescript-plexjs
codeSamplesRevisionDigest: sha256:214b9a57e050598b3c15f0f8504a591973e8399cad8b8be2917772c3f75861a9 codeSamplesRevisionDigest: sha256:cc0edeb64bf898493d4f7f9e628ac369bb39b63de609919e22052c030a54edec
workflow: workflow:
workflowVersion: 1.0.0 workflowVersion: 1.0.0
speakeasyVersion: latest speakeasyVersion: latest

View File

@@ -163,8 +163,9 @@ run();
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library * [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media * [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
* [getCountriesLibrary](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media * [getCountriesLibrary](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries * [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey * [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children * [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content * [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck * [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
@@ -508,13 +509,14 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`hubsGetLibraryHubs`](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs - [`hubsGetLibraryHubs`](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
- [`hubsGetRecentlyAdded`](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added - [`hubsGetRecentlyAdded`](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
- [`libraryDeleteLibrary`](docs/sdks/library/README.md#deletelibrary) - Delete Library Section - [`libraryDeleteLibrary`](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
- [`libraryGetActorsLibrary`](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
- [`libraryGetAllLibraries`](docs/sdks/library/README.md#getalllibraries) - Get All Libraries - [`libraryGetAllLibraries`](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
- [`libraryGetCountriesLibrary`](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media - [`libraryGetCountriesLibrary`](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
- [`libraryGetFileHash`](docs/sdks/library/README.md#getfilehash) - Get Hash Value - [`libraryGetFileHash`](docs/sdks/library/README.md#getfilehash) - Get Hash Value
- [`libraryGetGenresLibrary`](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media - [`libraryGetGenresLibrary`](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
- [`libraryGetLibraryDetails`](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details - [`libraryGetLibraryDetails`](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
- [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items - [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
- [`libraryGetMetaDataByRatingKey`](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey - [`libraryGetMediaMetaData`](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
- [`libraryGetMetadataChildren`](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children - [`libraryGetMetadataChildren`](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
- [`libraryGetOnDeck`](docs/sdks/library/README.md#getondeck) - Get On Deck - [`libraryGetOnDeck`](docs/sdks/library/README.md#getondeck) - Get On Deck
- [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added - [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added

View File

@@ -1209,3 +1209,13 @@ Based on:
- [typescript v0.32.5] . - [typescript v0.32.5] .
### Releases ### Releases
- [NPM v0.32.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.5 - . - [NPM v0.32.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.5 - .
## 2025-02-07 00:09:41
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.487.0 (2.506.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.33.0] .
### Releases
- [NPM v0.33.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.33.0 - .

View File

@@ -563,7 +563,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: key label: data
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -572,7 +572,22 @@ actions:
}); });
async function run() { async function run() {
const result = await plexAPI.library.getMetaDataByRatingKey(9518); const result = await plexAPI.library.getMediaMetaData({
ratingKey: 9518,
includeConcerts: true,
includeExtras: true,
includeOnDeck: true,
includePopularLeaves: true,
includePreferences: true,
includeReviews: true,
includeChapters: true,
includeStations: true,
includeExternalMedia: true,
asyncAugmentMetadata: true,
asyncCheckFiles: true,
asyncRefreshAnalysis: true,
asyncRefreshLocalMediaAgent: true,
});
// Handle the result // Handle the result
console.log(result); console.log(result);
@@ -822,6 +837,27 @@ actions:
console.log(result); console.log(result);
} }
run();
- target: $["paths"]["/library/sections/{sectionKey}/actor"]["get"]
update:
x-codeSamples:
- lang: typescript
label: library
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { GetActorsLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.library.getActorsLibrary(9518, GetActorsLibraryQueryParamType.TvShow);
// Handle the result
console.log(result);
}
run(); run();
- target: $["paths"]["/library/sections/{sectionKey}/country"]["get"] - target: $["paths"]["/library/sections/{sectionKey}/country"]["get"]
update: update:
@@ -830,13 +866,14 @@ actions:
label: library label: library
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { GetCountriesLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
async function run() { async function run() {
const result = await plexAPI.library.getCountriesLibrary(9518); const result = await plexAPI.library.getCountriesLibrary(9518, GetCountriesLibraryQueryParamType.TvShow);
// Handle the result // Handle the result
console.log(result); console.log(result);
@@ -850,13 +887,14 @@ actions:
label: library label: library
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { GetGenresLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
async function run() { async function run() {
const result = await plexAPI.library.getGenresLibrary(9518); const result = await plexAPI.library.getGenresLibrary(9518, GetGenresLibraryQueryParamType.TvShow);
// Handle the result // Handle the result
console.log(result); console.log(result);

View File

@@ -0,0 +1,18 @@
# GetActorsLibraryBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { GetActorsLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `errors` | [errors.GetActorsLibraryErrors](../../../sdk/models/errors/getactorslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -1,11 +1,11 @@
# GetMetaDataByRatingKeyErrors # GetActorsLibraryErrors
## Example Usage ## Example Usage
```typescript ```typescript
import { GetMetaDataByRatingKeyErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetActorsLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetMetaDataByRatingKeyErrors = { let value: GetActorsLibraryErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,

View File

@@ -1,11 +1,11 @@
# GetMetaDataByRatingKeyLibraryErrors # GetActorsLibraryLibraryErrors
## Example Usage ## Example Usage
```typescript ```typescript
import { GetMetaDataByRatingKeyLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetActorsLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetMetaDataByRatingKeyLibraryErrors = { let value: GetActorsLibraryLibraryErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,

View File

@@ -0,0 +1,18 @@
# GetActorsLibraryUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetActorsLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `errors` | [errors.GetActorsLibraryLibraryErrors](../../../sdk/models/errors/getactorslibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,18 @@
# GetMediaMetaDataBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { GetMediaMetaDataBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `errors` | [errors.GetMediaMetaDataErrors](../../../sdk/models/errors/getmediametadataerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,21 @@
# GetMediaMetaDataErrors
## Example Usage
```typescript
import { GetMediaMetaDataErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetMediaMetaDataErrors = {
code: 1000,
message: "X-Plex-Client-Identifier is missing",
status: 400,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |

View File

@@ -0,0 +1,21 @@
# GetMediaMetaDataLibraryErrors
## Example Usage
```typescript
import { GetMediaMetaDataLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetMediaMetaDataLibraryErrors = {
code: 1001,
message: "User could not be authenticated",
status: 401,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,18 @@
# GetMediaMetaDataUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetMediaMetaDataUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `errors` | [errors.GetMediaMetaDataLibraryErrors](../../../sdk/models/errors/getmediametadatalibraryerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -1,18 +0,0 @@
# GetMetaDataByRatingKeyBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { GetMetaDataByRatingKeyBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `errors` | [errors.GetMetaDataByRatingKeyErrors](../../../sdk/models/errors/getmetadatabyratingkeyerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -1,18 +0,0 @@
# GetMetaDataByRatingKeyUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetMetaDataByRatingKeyUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `errors` | [errors.GetMetaDataByRatingKeyLibraryErrors](../../../sdk/models/errors/getmetadatabyratingkeylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -6,7 +6,7 @@
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations"; import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: AddPlaylistContentsRequest = { let value: AddPlaylistContentsRequest = {
playlistID: 1856.36, playlistID: 6874.88,
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1", uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
playQueueID: 123, playQueueID: 123,
}; };

View File

@@ -7,7 +7,7 @@ import { AddPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operat
let value: AddPlaylistContentsResponse = { let value: AddPlaylistContentsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 507, statusCode: 226,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -7,7 +7,7 @@ import { ApplyUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: ApplyUpdatesResponse = { let value: ApplyUpdatesResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 205, statusCode: 101,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -7,7 +7,7 @@ import { Billing } from "@lukehagar/plexjs/sdk/models/operations";
let value: Billing = { let value: Billing = {
internalPaymentMethod: {}, internalPaymentMethod: {},
paymentMethodId: 863856, paymentMethodId: 517379,
}; };
``` ```

View File

@@ -7,7 +7,7 @@ import { CheckForUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations
let value: CheckForUpdatesResponse = { let value: CheckForUpdatesResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 424, statusCode: 205,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -6,7 +6,7 @@
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations"; import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: ClearPlaylistContentsRequest = { let value: ClearPlaylistContentsRequest = {
playlistID: 8726.51, playlistID: 7980.47,
}; };
``` ```

View File

@@ -7,7 +7,7 @@ import { ClearPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/oper
let value: ClearPlaylistContentsResponse = { let value: ClearPlaylistContentsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 207, statusCode: 103,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -7,7 +7,7 @@ type of playlist to create
```typescript ```typescript
import { CreatePlaylistQueryParamType } from "@lukehagar/plexjs/sdk/models/operations"; import { CreatePlaylistQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Video; let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Audio;
``` ```
## Values ## Values

View File

@@ -7,9 +7,9 @@ import { CreatePlaylistQueryParamType, CreatePlaylistRequest, Smart } from "@luk
let value: CreatePlaylistRequest = { let value: CreatePlaylistRequest = {
title: "<value>", title: "<value>",
type: CreatePlaylistQueryParamType.Audio, type: CreatePlaylistQueryParamType.Video,
smart: Smart.Zero, smart: Smart.Zero,
uri: "https://general-possession.info/", uri: "https://humble-confusion.com",
}; };
``` ```

View File

@@ -7,7 +7,7 @@ import { CreatePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
let value: CreatePlaylistResponse = { let value: CreatePlaylistResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 100, statusCode: 102,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -6,7 +6,7 @@
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations"; import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: DeletePlaylistRequest = { let value: DeletePlaylistRequest = {
playlistID: 6630.78, playlistID: 206.51,
}; };
``` ```

View File

@@ -7,7 +7,7 @@ import { DeletePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
let value: DeletePlaylistResponse = { let value: DeletePlaylistResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 200, statusCode: 409,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -7,7 +7,7 @@ import { EnablePaperTrailResponse } from "@lukehagar/plexjs/sdk/models/operation
let value: EnablePaperTrailResponse = { let value: EnablePaperTrailResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 508, statusCode: 302,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -7,7 +7,7 @@ Filter
```typescript ```typescript
import { Filter } from "@lukehagar/plexjs/sdk/models/operations"; import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
let value: Filter = Filter.All; let value: Filter = Filter.Available;
``` ```
## Values ## Values

View File

@@ -0,0 +1,24 @@
# GetActorsLibraryDirectory
## Example Usage
```typescript
import { GetActorsLibraryDirectory } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetActorsLibraryDirectory = {
fastKey: "/library/sections/2/all?actor=134671",
thumb:
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
key: "134671",
title: "Aaron Paul",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `fastKey` | *string* | :heavy_check_mark: | A fast lookup key for the actor relative url. | /library/sections/2/all?actor=134671 |
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the actor. | https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg |
| `key` | *string* | :heavy_check_mark: | A unique key representing the actor. | 134671 |
| `title` | *string* | :heavy_check_mark: | The name of the actor. | Aaron Paul |

View File

@@ -0,0 +1,49 @@
# GetActorsLibraryMediaContainer
## Example Usage
```typescript
import { GetActorsLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetActorsLibraryMediaContainer = {
size: 50,
allowSync: false,
art: "/:/resources/show-fanart.jpg",
identifier: "com.plexapp.plugins.library",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1734362201,
nocache: true,
thumb: "/:/resources/show.png",
title1: "TV Series",
title2: "By Starring Actor",
viewGroup: "secondary",
viewMode: "131131",
directory: [
{
fastKey: "/library/sections/2/all?actor=134671",
thumb:
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
key: "134671",
title: "Aaron Paul",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
| `viewMode` | *string* | :heavy_check_mark: | Identifier for the view mode. | 131131 |
| `directory` | [operations.GetActorsLibraryDirectory](../../../sdk/models/operations/getactorslibrarydirectory.md)[] | :heavy_minus_sign: | An array of actor entries for media items. | |

View File

@@ -0,0 +1,30 @@
# GetActorsLibraryQueryParamType
The type of media to retrieve or filter by.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Example Usage
```typescript
import { GetActorsLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetActorsLibraryQueryParamType =
GetActorsLibraryQueryParamType.TvShow;
```
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

View File

@@ -0,0 +1,19 @@
# GetActorsLibraryRequest
## Example Usage
```typescript
import { GetActorsLibraryQueryParamType, GetActorsLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetActorsLibraryRequest = {
sectionKey: 9518,
type: GetActorsLibraryQueryParamType.TvShow,
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `type` | [operations.GetActorsLibraryQueryParamType](../../../sdk/models/operations/getactorslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

View File

@@ -0,0 +1,49 @@
# GetActorsLibraryResponse
## Example Usage
```typescript
import { GetActorsLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetActorsLibraryResponse = {
contentType: "<value>",
statusCode: 413,
rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 50,
allowSync: false,
art: "/:/resources/show-fanart.jpg",
identifier: "com.plexapp.plugins.library",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1734362201,
nocache: true,
thumb: "/:/resources/show.png",
title1: "TV Series",
title2: "By Starring Actor",
viewGroup: "secondary",
viewMode: "131131",
directory: [
{
fastKey: "/library/sections/2/all?actor=134671",
thumb:
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
key: "134671",
title: "Aaron Paul",
},
],
},
},
};
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.GetActorsLibraryResponseBody](../../../sdk/models/operations/getactorslibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |

View File

@@ -0,0 +1,41 @@
# GetActorsLibraryResponseBody
Successful response containing media container data.
## Example Usage
```typescript
import { GetActorsLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetActorsLibraryResponseBody = {
mediaContainer: {
size: 50,
allowSync: false,
art: "/:/resources/show-fanart.jpg",
identifier: "com.plexapp.plugins.library",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1734362201,
nocache: true,
thumb: "/:/resources/show.png",
title1: "TV Series",
title2: "By Starring Actor",
viewGroup: "secondary",
viewMode: "131131",
directory: [
{
fastKey: "/library/sections/2/all?actor=134671",
thumb:
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
key: "134671",
title: "Aaron Paul",
},
],
},
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.GetActorsLibraryMediaContainer](../../../sdk/models/operations/getactorslibrarymediacontainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -7,7 +7,7 @@ import { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs/sdk/models/ope
let value: GetBandwidthStatisticsResponse = { let value: GetBandwidthStatisticsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 423, statusCode: 500,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -0,0 +1,30 @@
# GetCountriesLibraryQueryParamType
The type of media to retrieve or filter by.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Example Usage
```typescript
import { GetCountriesLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetCountriesLibraryQueryParamType =
GetCountriesLibraryQueryParamType.TvShow;
```
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

View File

@@ -3,15 +3,17 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { GetCountriesLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations"; import { GetCountriesLibraryQueryParamType, GetCountriesLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetCountriesLibraryRequest = { let value: GetCountriesLibraryRequest = {
sectionKey: 9518, sectionKey: 9518,
type: GetCountriesLibraryQueryParamType.TvShow,
}; };
``` ```
## Fields ## Fields
| Field | Type | Required | Description | Example | | 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 | | `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `type` | [operations.GetCountriesLibraryQueryParamType](../../../sdk/models/operations/getcountrieslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

View File

@@ -0,0 +1,30 @@
# GetGenresLibraryQueryParamType
The type of media to retrieve or filter by.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Example Usage
```typescript
import { GetGenresLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetGenresLibraryQueryParamType =
GetGenresLibraryQueryParamType.TvShow;
```
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

View File

@@ -3,15 +3,17 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { GetGenresLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations"; import { GetGenresLibraryQueryParamType, GetGenresLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetGenresLibraryRequest = { let value: GetGenresLibraryRequest = {
sectionKey: 9518, sectionKey: 9518,
type: GetGenresLibraryQueryParamType.TvShow,
}; };
``` ```
## Fields ## Fields
| Field | Type | Required | Description | Example | | 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 | | `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `type` | [operations.GetGenresLibraryQueryParamType](../../../sdk/models/operations/getgenreslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

View File

@@ -1,6 +1,6 @@
# GetLibraryItemsQueryParamType # GetLibraryItemsQueryParamType
The type of media to retrieve. The type of media to retrieve or filter by.
1 = movie 1 = movie
2 = show 2 = show
3 = season 3 = season

View File

@@ -15,10 +15,10 @@ let value: GetLibraryItemsRequest = {
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tag` | [operations.Tag](../../../sdk/models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | | | `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 | | `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 | | `type` | [operations.GetLibraryItemsQueryParamType](../../../sdk/models/operations/getlibraryitemsqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 | | `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `includeMeta` | [operations.GetLibraryItemsQueryParamIncludeMeta](../../../sdk/models/operations/getlibraryitemsqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 | | `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 | | `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 |

View File

@@ -0,0 +1,21 @@
# GetMediaMetaDataCountry
## Example Usage
```typescript
import { GetMediaMetaDataCountry } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaMetaDataCountry = {
id: 58591,
filter: "country=58591",
tag: "United States of America",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `id` | *number* | :heavy_check_mark: | The unique country identifier. | 58591 |
| `filter` | *string* | :heavy_check_mark: | The filter string for the country. | country=58591 |
| `tag` | *string* | :heavy_check_mark: | The country name. | United States of America |

View File

@@ -1,18 +1,18 @@
# GetMetaDataByRatingKeyRole # GetMediaMetaDataDirector
## Example Usage ## Example Usage
```typescript ```typescript
import { GetMetaDataByRatingKeyRole } from "@lukehagar/plexjs/sdk/models/operations"; import { GetMediaMetaDataDirector } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMetaDataByRatingKeyRole = { let value: GetMediaMetaDataDirector = {
id: 220, id: 109501,
filter: "actor=220", filter: "actor=109501",
tag: "Dennis Keiffer", tag: "Bob Odenkirk",
tagKey: "5d77683554f42c001f8c4708", tagKey: "5d77683254f42c001f8c3f69",
role: "Bar Guy (uncredited)", role: "Jimmy McGill",
thumb: thumb:
"https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg", "https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
}; };
``` ```
@@ -20,9 +20,9 @@ let value: GetMetaDataByRatingKeyRole = {
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 220 | | `id` | *number* | :heavy_check_mark: | The unique role identifier. | 109501 |
| `filter` | *string* | :heavy_minus_sign: | N/A | actor=220 | | `filter` | *string* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
| `tag` | *string* | :heavy_minus_sign: | N/A | Dennis Keiffer | | `tag` | *string* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
| `tagKey` | *string* | :heavy_minus_sign: | N/A | 5d77683554f42c001f8c4708 | | `tagKey` | *string* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
| `role` | *string* | :heavy_minus_sign: | N/A | Bar Guy (uncredited) | | `role` | *string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
| `thumb` | *string* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg | | `thumb` | *string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |

View File

@@ -0,0 +1,21 @@
# GetMediaMetaDataGenre
## Example Usage
```typescript
import { GetMediaMetaDataGenre } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaMetaDataGenre = {
id: 1057,
filter: "genre=1057",
tag: "Crime",
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `id` | *number* | :heavy_check_mark: | The unique genre identifier. | 1057 |
| `filter` | *string* | :heavy_check_mark: | The filter string for the genre. | genre=1057 |
| `tag` | *string* | :heavy_check_mark: | The genre name. | Crime |

View File

@@ -0,0 +1,21 @@
# GetMediaMetaDataImage
## Example Usage
```typescript
import { GetMediaMetaDataImage } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaMetaDataImage = {
alt: "Better Call Saul",
type: "coverPoster",
url: "/library/metadata/44288/thumb/1736487993",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| `alt` | *string* | :heavy_check_mark: | Alternate text for the image. | Better Call Saul |
| `type` | *string* | :heavy_check_mark: | The type of image (e.g., coverPoster, background, clearLogo). | coverPoster |
| `url` | *string* | :heavy_check_mark: | The URL of the image. | /library/metadata/44288/thumb/1736487993 |

View File

@@ -0,0 +1,17 @@
# GetMediaMetaDataLocation
## Example Usage
```typescript
import { GetMediaMetaDataLocation } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaMetaDataLocation = {
path: "/TV Shows/Better Call Saul",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `path` | *string* | :heavy_check_mark: | The file path for the location. | /TV Shows/Better Call Saul |

View File

@@ -0,0 +1,108 @@
# GetMediaMetaDataMedia
## Example Usage
```typescript
import { GetMediaMetaDataMedia } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaMetaDataMedia = {
id: 387322,
duration: 9610350,
bitrate: 25512,
width: 3840,
height: 1602,
aspectRatio: 2.35,
audioChannels: 6,
audioCodec: "eac3",
videoCodec: "hevc",
videoResolution: "4k",
container: "mkv",
videoFrameRate: "24p",
videoProfile: "main 10",
hasVoiceActivity: false,
part: [
{
accessible: true,
exists: true,
id: 418385,
key: "/library/parts/418385/1735864239/file.mkv",
indexes: "sd",
duration: 9610350,
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
size: 30649952104,
container: "mkv",
videoProfile: "main 10",
stream: [
{
id: 1002625,
streamType: 1,
default: true,
codec: "hevc",
index: 0,
bitrate: 24743,
language: "English",
languageTag: "en",
languageCode: "eng",
doviblCompatID: 1,
doviblPresent: true,
dovielPresent: false,
doviLevel: 6,
doviPresent: true,
doviProfile: 8,
dovirpuPresent: true,
doviVersion: "1.0",
bitDepth: 10,
chromaLocation: "topleft",
chromaSubsampling: "4:2:0",
codedHeight: 1608,
codedWidth: 3840,
colorPrimaries: "bt2020",
colorRange: "tv",
colorSpace: "bt2020nc",
colorTrc: "smpte2084",
frameRate: 23.976,
height: 1602,
level: 150,
original: true,
hasScalingMatrix: false,
profile: "main 10",
scanType: "progressive",
refFrames: 1,
width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
selected: true,
forced: true,
channels: 6,
audioChannelLayout: "5.1(side)",
samplingRate: 48000,
canAutoSync: false,
hearingImpaired: true,
dub: true,
title: "SDH",
},
],
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `id` | *number* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `duration` | *number* | :heavy_check_mark: | Duration of the media in milliseconds. | 9610350 |
| `bitrate` | *number* | :heavy_check_mark: | Bitrate in bits per second. | 25512 |
| `width` | *number* | :heavy_check_mark: | Video width in pixels. | 3840 |
| `height` | *number* | :heavy_check_mark: | Video height in pixels. | 1602 |
| `aspectRatio` | *number* | :heavy_check_mark: | Aspect ratio of the video. | 2.35 |
| `audioChannels` | *number* | :heavy_check_mark: | Number of audio channels. | 6 |
| `audioCodec` | *string* | :heavy_check_mark: | Audio codec used. | eac3 |
| `videoCodec` | *string* | :heavy_check_mark: | Video codec used. | hevc |
| `videoResolution` | *string* | :heavy_check_mark: | Video resolution (e.g., 4k). | 4k |
| `container` | *string* | :heavy_check_mark: | File container type. | mkv |
| `videoFrameRate` | *string* | :heavy_check_mark: | Frame rate of the video (e.g., 24p). | 24p |
| `videoProfile` | *string* | :heavy_check_mark: | Video profile (e.g., main 10). | main 10 |
| `hasVoiceActivity` | *boolean* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
| `part` | [operations.GetMediaMetaDataPart](../../../sdk/models/operations/getmediametadatapart.md)[] | :heavy_check_mark: | An array of parts for this media item. | |

View File

@@ -0,0 +1,261 @@
# GetMediaMetaDataMediaContainer
## Example Usage
```typescript
import { GetMediaMetaDataMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetMediaMetaDataMediaContainer = {
size: 50,
allowSync: false,
identifier: "com.plexapp.plugins.library",
librarySectionID: 2,
librarySectionTitle: "TV Series",
librarySectionUUID: "e69655a2-ef48-4aba-bb19-0cc34d1e7d36",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1734362201,
metadata: [
{
ratingKey: "44288",
parentRatingKey: "48047",
grandparentRatingKey: "45520",
parentGuid: "plex://season/618b89208dde18df707ad15c",
grandparentGuid: "plex://show/5e16253691c20300412003a8",
grandparentSlug: "alice-in-borderland-2020",
grandparentKey: "/library/metadata/45520",
parentKey: "/library/metadata/48047",
key: "/library/metadata/44288/children",
guid: "plex://show/5d9c08254eefaa001f5d6dcb",
slug: "better-call-saul",
studio: "Sony Pictures Television",
type: "show",
title: "Better Call Saul",
originalTitle: "Wicked: Part I",
librarySectionTitle: "TV Series ",
librarySectionID: 2,
librarySectionKey: "/library/sections/2",
contentRating: "TV-MA",
summary:
"Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to \"Breaking Bad\" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman.",
index: 1,
grandparentTitle: "Alice in Borderland",
parentTitle: "Season 2",
audienceRating: 8.7,
viewCount: 4,
skipCount: 1,
lastViewedAt: 1625764795,
year: 2015,
tagline: "Make the call",
chapterSource: "media",
primaryExtraKey: "/library/metadata/134704",
thumb: "/library/metadata/44288/thumb/1736487993",
art: "/library/metadata/44288/art/1736487993",
theme: "/library/metadata/44288/theme/1736487993",
duration: 2700000,
originallyAvailableAt: new RFCDate("2015-02-08"),
leafCount: 63,
viewedLeafCount: 4,
childCount: 6,
addedAt: 1625505101,
updatedAt: 1736487993,
audienceRatingImage: "themoviedb://image.rating",
parentIndex: 2,
parentThumb: "/library/metadata/48047/thumb/1671800243",
grandparentThumb: "/library/metadata/45520/thumb/1736488003",
grandparentArt: "/library/metadata/45520/art/1736488003",
media: [
{
id: 387322,
duration: 9610350,
bitrate: 25512,
width: 3840,
height: 1602,
aspectRatio: 2.35,
audioChannels: 6,
audioCodec: "eac3",
videoCodec: "hevc",
videoResolution: "4k",
container: "mkv",
videoFrameRate: "24p",
videoProfile: "main 10",
hasVoiceActivity: false,
part: [
{
accessible: true,
exists: true,
id: 418385,
key: "/library/parts/418385/1735864239/file.mkv",
indexes: "sd",
duration: 9610350,
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
size: 30649952104,
container: "mkv",
videoProfile: "main 10",
stream: [
{
id: 1002625,
streamType: 1,
default: true,
codec: "hevc",
index: 0,
bitrate: 24743,
language: "English",
languageTag: "en",
languageCode: "eng",
doviblCompatID: 1,
doviblPresent: true,
dovielPresent: false,
doviLevel: 6,
doviPresent: true,
doviProfile: 8,
dovirpuPresent: true,
doviVersion: "1.0",
bitDepth: 10,
chromaLocation: "topleft",
chromaSubsampling: "4:2:0",
codedHeight: 1608,
codedWidth: 3840,
colorPrimaries: "bt2020",
colorRange: "tv",
colorSpace: "bt2020nc",
colorTrc: "smpte2084",
frameRate: 23.976,
height: 1602,
level: 150,
original: true,
hasScalingMatrix: false,
profile: "main 10",
scanType: "progressive",
refFrames: 1,
width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
selected: true,
forced: true,
channels: 6,
audioChannelLayout: "5.1(side)",
samplingRate: 48000,
canAutoSync: false,
hearingImpaired: true,
dub: true,
title: "SDH",
},
],
},
],
},
],
image: [
{
alt: "Better Call Saul",
type: "coverPoster",
url: "/library/metadata/44288/thumb/1736487993",
},
],
ultraBlurColors: {
topLeft: "11333a",
topRight: "1d2721",
bottomRight: "5c451d",
bottomLeft: "372c10",
},
genre: [
{
id: 1057,
filter: "genre=1057",
tag: "Crime",
},
],
country: [
{
id: 58591,
filter: "country=58591",
tag: "United States of America",
},
],
guids: [
{
id: "imdb://tt3032476",
},
],
rating: [
{
image: "imdb://image.rating",
value: 9,
type: "audience",
},
],
role: [
{
id: 109501,
filter: "actor=109501",
tag: "Bob Odenkirk",
tagKey: "5d77683254f42c001f8c3f69",
role: "Jimmy McGill",
thumb:
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
},
],
director: [
{
id: 109501,
filter: "actor=109501",
tag: "Bob Odenkirk",
tagKey: "5d77683254f42c001f8c3f69",
role: "Jimmy McGill",
thumb:
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
},
],
writer: [
{
id: 109501,
filter: "actor=109501",
tag: "Bob Odenkirk",
tagKey: "5d77683254f42c001f8c3f69",
role: "Jimmy McGill",
thumb:
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
},
],
producer: [
{
id: 109501,
filter: "actor=109501",
tag: "Bob Odenkirk",
tagKey: "5d77683254f42c001f8c3f69",
role: "Jimmy McGill",
thumb:
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
},
],
similar: [
{
id: 26,
filter: "similar=26",
tag: "Breaking Bad",
},
],
location: [
{
path: "/TV Shows/Better Call Saul",
},
],
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `librarySectionID` | *number* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
| `librarySectionUUID` | *string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `metadata` | [operations.GetMediaMetaDataMetadata](../../../sdk/models/operations/getmediametadatametadata.md)[] | :heavy_check_mark: | An array of metadata items. | |

View File

@@ -1,172 +1,234 @@
# GetMetaDataByRatingKeyMetadata # GetMediaMetaDataMetadata
## Example Usage ## Example Usage
```typescript ```typescript
import { GetMetaDataByRatingKeyMetadata } from "@lukehagar/plexjs/sdk/models/operations"; import { GetMediaMetaDataMetadata } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types"; import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetMetaDataByRatingKeyMetadata = { let value: GetMediaMetaDataMetadata = {
ratingKey: "17", ratingKey: "44288",
key: "/library/metadata/17", parentRatingKey: "48047",
guid: "plex://movie/5d77683f6f4521001ea9dc53", grandparentRatingKey: "45520",
studio: "Universal Pictures", parentGuid: "plex://season/618b89208dde18df707ad15c",
type: "movie", grandparentGuid: "plex://show/5e16253691c20300412003a8",
title: "Serenity", grandparentSlug: "alice-in-borderland-2020",
librarySectionTitle: "Movies", grandparentKey: "/library/metadata/45520",
librarySectionID: 1, parentKey: "/library/metadata/48047",
librarySectionKey: "/library/sections/1", key: "/library/metadata/44288/children",
contentRating: "PG-13", guid: "plex://show/5d9c08254eefaa001f5d6dcb",
slug: "better-call-saul",
studio: "Sony Pictures Television",
type: "show",
title: "Better Call Saul",
originalTitle: "Wicked: Part I",
librarySectionTitle: "TV Series ",
librarySectionID: 2,
librarySectionKey: "/library/sections/2",
contentRating: "TV-MA",
summary: summary:
"Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.", "Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to \"Breaking Bad\" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman.",
rating: 8.2, index: 1,
audienceRating: 9.1, grandparentTitle: "Alice in Borderland",
year: 2005, parentTitle: "Season 2",
tagline: "They aim to misbehave.", audienceRating: 8.7,
thumb: "/library/metadata/17/thumb/1705637165", viewCount: 4,
art: "/library/metadata/17/art/1705637165", skipCount: 1,
duration: 141417, lastViewedAt: 1625764795,
originallyAvailableAt: new RFCDate("2005-09-29T00:00:00Z"), year: 2015,
addedAt: 1705637164, tagline: "Make the call",
updatedAt: 1705637165, chapterSource: "media",
audienceRatingImage: "rottentomatoes://image.rating.upright", primaryExtraKey: "/library/metadata/134704",
hasPremiumPrimaryExtra: "1", thumb: "/library/metadata/44288/thumb/1736487993",
ratingImage: "rottentomatoes://image.rating.ripe", art: "/library/metadata/44288/art/1736487993",
theme: "/library/metadata/44288/theme/1736487993",
duration: 2700000,
originallyAvailableAt: new RFCDate("2015-02-08"),
leafCount: 63,
viewedLeafCount: 4,
childCount: 6,
addedAt: 1625505101,
updatedAt: 1736487993,
audienceRatingImage: "themoviedb://image.rating",
parentIndex: 2,
parentThumb: "/library/metadata/48047/thumb/1671800243",
grandparentThumb: "/library/metadata/45520/thumb/1736488003",
grandparentArt: "/library/metadata/45520/art/1736488003",
media: [ media: [
{ {
id: 15, id: 387322,
duration: 141417, duration: 9610350,
bitrate: 2278, bitrate: 25512,
width: 1920, width: 3840,
height: 814, height: 1602,
aspectRatio: 2.35, aspectRatio: 2.35,
audioChannels: 2, audioChannels: 6,
audioCodec: "aac", audioCodec: "eac3",
videoCodec: "h264", videoCodec: "hevc",
videoResolution: "1080", videoResolution: "4k",
container: "mp4", container: "mkv",
videoFrameRate: "24p", videoFrameRate: "24p",
optimizedForStreaming: 0, videoProfile: "main 10",
audioProfile: "lc", hasVoiceActivity: false,
has64bitOffsets: false,
videoProfile: "high",
part: [ part: [
{ {
id: 15, accessible: true,
key: "/library/parts/15/1705637151/file.mp4", exists: true,
duration: 141417, id: 418385,
file: "/movies/Serenity (2005)/Serenity (2005).mp4", key: "/library/parts/418385/1735864239/file.mkv",
size: 40271948, indexes: "sd",
audioProfile: "lc", duration: 9610350,
container: "mp4", file: "/mnt/Movies_1/W/Wicked (2024).mkv",
has64bitOffsets: false, size: 30649952104,
optimizedForStreaming: false, container: "mkv",
videoProfile: "high", videoProfile: "main 10",
stream: [ stream: [
{ {
id: 29, id: 1002625,
streamType: 2, streamType: 1,
default: true, default: true,
codec: "aac", codec: "hevc",
index: 0, index: 0,
bitrate: 128, bitrate: 24743,
bitDepth: 8,
chromaLocation: "left",
chromaSubsampling: "14520",
codedHeight: 816,
codedWidth: 1920,
colorPrimaries: "bt709",
colorRange: "tv",
colorSpace: "bt709",
colorTrc: "bt709",
frameRate: 24,
hasScalingMatrix: false,
height: 814,
level: 40,
profile: "lc",
refFrames: 4,
scanType: "progressive",
streamIdentifier: "1",
width: 1920,
displayTitle: "English (AAC Stereo)",
extendedDisplayTitle: "English (AAC Stereo)",
selected: true,
channels: 2,
language: "English", language: "English",
languageTag: "en", languageTag: "en",
languageCode: "eng", languageCode: "eng",
samplingRate: 44100, doviblCompatID: 1,
doviblPresent: true,
dovielPresent: false,
doviLevel: 6,
doviPresent: true,
doviProfile: 8,
dovirpuPresent: true,
doviVersion: "1.0",
bitDepth: 10,
chromaLocation: "topleft",
chromaSubsampling: "4:2:0",
codedHeight: 1608,
codedWidth: 3840,
colorPrimaries: "bt2020",
colorRange: "tv",
colorSpace: "bt2020nc",
colorTrc: "smpte2084",
frameRate: 23.976,
height: 1602,
level: 150,
original: true,
hasScalingMatrix: false,
profile: "main 10",
scanType: "progressive",
refFrames: 1,
width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
selected: true,
forced: true,
channels: 6,
audioChannelLayout: "5.1(side)",
samplingRate: 48000,
canAutoSync: false,
hearingImpaired: true,
dub: true,
title: "SDH",
}, },
], ],
}, },
], ],
}, },
], ],
image: [
{
alt: "Better Call Saul",
type: "coverPoster",
url: "/library/metadata/44288/thumb/1736487993",
},
],
ultraBlurColors: {
topLeft: "11333a",
topRight: "1d2721",
bottomRight: "5c451d",
bottomLeft: "372c10",
},
genre: [ genre: [
{ {
id: 184, id: 1057,
filter: "genre=184", filter: "genre=1057",
tag: "Thriller", tag: "Crime",
}, },
], ],
country: [ country: [
{ {
id: 116, id: 58591,
filter: "country=116", filter: "country=58591",
tag: "United States of America", tag: "United States of America",
}, },
], ],
guids: [ guids: [
{ {
id: "tvdb://2337", id: "imdb://tt3032476",
}, },
], ],
ratings: [ rating: [
{ {
image: "themoviedb://image.rating", image: "imdb://image.rating",
value: 7.4, value: 9,
type: "audience", type: "audience",
}, },
], ],
director: [
{
id: 130,
filter: "director=130",
tag: "Joss Whedon",
tagKey: "5d776828880197001ec90e8f",
thumb:
"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg",
},
],
writer: [
{
id: 132,
filter: "writer=132",
tag: "Joss Whedon",
tagKey: "5d776828880197001ec90e8f",
thumb:
"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg",
},
],
role: [ role: [
{ {
id: 220, id: 109501,
filter: "actor=220", filter: "actor=109501",
tag: "Dennis Keiffer", tag: "Bob Odenkirk",
tagKey: "5d77683554f42c001f8c4708", tagKey: "5d77683254f42c001f8c3f69",
role: "Bar Guy (uncredited)", role: "Jimmy McGill",
thumb: thumb:
"https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg", "https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
},
],
director: [
{
id: 109501,
filter: "actor=109501",
tag: "Bob Odenkirk",
tagKey: "5d77683254f42c001f8c3f69",
role: "Jimmy McGill",
thumb:
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
},
],
writer: [
{
id: 109501,
filter: "actor=109501",
tag: "Bob Odenkirk",
tagKey: "5d77683254f42c001f8c3f69",
role: "Jimmy McGill",
thumb:
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
}, },
], ],
producer: [ producer: [
{ {
id: 221, id: 109501,
filter: "producer=221", filter: "actor=109501",
tag: "Barry Mendel", tag: "Bob Odenkirk",
tagKey: "5d776826961905001eb90e2b", tagKey: "5d77683254f42c001f8c3f69",
role: "Jimmy McGill",
thumb: thumb:
"https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg", "https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
},
],
similar: [
{
id: 26,
filter: "similar=26",
tag: "Breaking Bad",
},
],
location: [
{
path: "/TV Shows/Better Call Saul",
}, },
], ],
}; };
@@ -175,42 +237,63 @@ let value: GetMetaDataByRatingKeyMetadata = {
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 17 | | `ratingKey` | *string* | :heavy_check_mark: | The rating key of the metadata item. | 44288 |
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/17 | | `parentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent of this metadata item. | 48047 |
| `guid` | *string* | :heavy_minus_sign: | N/A | plex://movie/5d77683f6f4521001ea9dc53 | | `grandparentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the grandparent of this metadata item. | 45520 |
| `studio` | *string* | :heavy_minus_sign: | N/A | Universal Pictures | | `parentGuid` | *string* | :heavy_minus_sign: | A GUID identifying the parent entity (e.g., season) for the item. | plex://season/618b89208dde18df707ad15c |
| `type` | *string* | :heavy_minus_sign: | N/A | movie | | `grandparentGuid` | *string* | :heavy_minus_sign: | A GUID identifying the grandparent entity (e.g., show). | plex://show/5e16253691c20300412003a8 |
| `title` | *string* | :heavy_minus_sign: | N/A | Serenity | | `grandparentSlug` | *string* | :heavy_minus_sign: | A URL-friendly identifier (slug) for the grandparent entity. | alice-in-borderland-2020 |
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies | | `grandparentKey` | *string* | :heavy_minus_sign: | A key identifying the grandparent metadata in the library. | /library/metadata/45520 |
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 | | `parentKey` | *string* | :heavy_minus_sign: | A key identifying the parent metadata in the library. | /library/metadata/48047 |
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 | | `key` | *string* | :heavy_check_mark: | The API key to access metadata details. | /library/metadata/44288/children |
| `grandparentTitle` | *string* | :heavy_minus_sign: | The name of the album artist for the track when audio, and the name of the TV show for the episode when video. | | | `guid` | *string* | :heavy_check_mark: | The globally unique identifier for the item. | plex://show/5d9c08254eefaa001f5d6dcb |
| `parentTitle` | *string* | :heavy_minus_sign: | The name of the album for the track when audio, and the name of the season for the episode when TV show. | | | `slug` | *string* | :heavy_minus_sign: | A URL-friendly identifier for the item. | better-call-saul |
| `originalTitle` | *string* | :heavy_minus_sign: | The orginal untranslated name of the media item when non-english. | | | `studio` | *string* | :heavy_minus_sign: | The studio that produced the content. | Sony Pictures Television |
| `index` | *number* | :heavy_minus_sign: | The index starting from 0 of this media item in the MetaData array. | | | `type` | *string* | :heavy_check_mark: | The type of content (e.g., show, movie). | show |
| `parentIndex` | *number* | :heavy_minus_sign: | The parent index starting from 0 of this media item in the parent MetaData array. | | | `title` | *string* | :heavy_check_mark: | The title of the content. | Better Call Saul |
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 | | `originalTitle` | *string* | :heavy_minus_sign: | The original title of the content. | Wicked: Part I |
| `summary` | *string* | :heavy_minus_sign: | N/A | Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job. | | `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
| `rating` | *number* | :heavy_minus_sign: | N/A | 8.2 | | `librarySectionID` | *number* | :heavy_check_mark: | The ID of the library section. | 2 |
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 9.1 | | `librarySectionKey` | *string* | :heavy_check_mark: | The key of the library section. | /library/sections/2 |
| `year` | *number* | :heavy_minus_sign: | N/A | 2005 | | `contentRating` | *string* | :heavy_check_mark: | The content rating (e.g., TV-MA). | TV-MA |
| `tagline` | *string* | :heavy_minus_sign: | N/A | They aim to misbehave. | | `summary` | *string* | :heavy_check_mark: | A summary of the content. | Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to "Breaking Bad" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman. |
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/17/thumb/1705637165 | | `index` | *number* | :heavy_minus_sign: | The index or order of the item. | 1 |
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/17/art/1705637165 | | `grandparentTitle` | *string* | :heavy_minus_sign: | The title of the grandparent entity (typically the show's title). | Alice in Borderland |
| `duration` | *number* | :heavy_minus_sign: | N/A | 141417 | | `parentTitle` | *string* | :heavy_minus_sign: | The title of the parent entity (typically the season's title). | Season 2 |
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2005-09-29 00:00:00 +0000 UTC | | `audienceRating` | *number* | :heavy_check_mark: | The audience rating for the content. | 8.7 |
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1705637164 | | `viewCount` | *number* | :heavy_minus_sign: | The number of times the item has been viewed. | 4 |
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705637165 | | `skipCount` | *number* | :heavy_minus_sign: | The number of times the item has been skipped. | 1 |
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright | | `lastViewedAt` | *number* | :heavy_minus_sign: | Unix timestamp of when the item was last viewed. | 1625764795 |
| `hasPremiumPrimaryExtra` | *string* | :heavy_minus_sign: | N/A | 1 | | `year` | *number* | :heavy_check_mark: | The release year. | 2015 |
| `ratingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe | | `tagline` | *string* | :heavy_minus_sign: | The tagline of the content. | Make the call |
| `media` | [operations.GetMetaDataByRatingKeyMedia](../../../sdk/models/operations/getmetadatabyratingkeymedia.md)[] | :heavy_minus_sign: | N/A | | | `chapterSource` | *string* | :heavy_minus_sign: | N/A | media |
| `genre` | [operations.GetMetaDataByRatingKeyGenre](../../../sdk/models/operations/getmetadatabyratingkeygenre.md)[] | :heavy_minus_sign: | N/A | | | `primaryExtraKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/134704 |
| `country` | [operations.GetMetaDataByRatingKeyCountry](../../../sdk/models/operations/getmetadatabyratingkeycountry.md)[] | :heavy_minus_sign: | N/A | | | `thumb` | *string* | :heavy_check_mark: | URL of the thumbnail image. | /library/metadata/44288/thumb/1736487993 |
| `guids` | [operations.Guids](../../../sdk/models/operations/guids.md)[] | :heavy_minus_sign: | N/A | | | `art` | *string* | :heavy_check_mark: | URL of the art image. | /library/metadata/44288/art/1736487993 |
| `ratings` | [operations.Ratings](../../../sdk/models/operations/ratings.md)[] | :heavy_minus_sign: | N/A | | | `theme` | *string* | :heavy_minus_sign: | URL of the theme image. | /library/metadata/44288/theme/1736487993 |
| `director` | [operations.GetMetaDataByRatingKeyDirector](../../../sdk/models/operations/getmetadatabyratingkeydirector.md)[] | :heavy_minus_sign: | N/A | | | `duration` | *number* | :heavy_check_mark: | Duration of the content in milliseconds. | 2700000 |
| `writer` | [operations.GetMetaDataByRatingKeyWriter](../../../sdk/models/operations/getmetadatabyratingkeywriter.md)[] | :heavy_minus_sign: | N/A | | | `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_check_mark: | The original release date. | 2015-02-08 |
| `role` | [operations.GetMetaDataByRatingKeyRole](../../../sdk/models/operations/getmetadatabyratingkeyrole.md)[] | :heavy_minus_sign: | N/A | | | `leafCount` | *number* | :heavy_minus_sign: | The total number of episodes (or leaves). | 63 |
| `producer` | [operations.Producer](../../../sdk/models/operations/producer.md)[] | :heavy_minus_sign: | N/A | | | `viewedLeafCount` | *number* | :heavy_minus_sign: | The number of episodes that have been viewed. | 4 |
| `childCount` | *number* | :heavy_minus_sign: | The number of child items. | 6 |
| `addedAt` | *number* | :heavy_check_mark: | Unix timestamp when the item was added. | 1625505101 |
| `updatedAt` | *number* | :heavy_check_mark: | Unix timestamp when the item was last updated. | 1736487993 |
| `audienceRatingImage` | *string* | :heavy_check_mark: | The URL for the audience rating image. | themoviedb://image.rating |
| `parentIndex` | *number* | :heavy_minus_sign: | The index number of the parent entity, which could indicate its order or position. | 2 |
| `parentThumb` | *string* | :heavy_minus_sign: | The URL of the parent's thumbnail image. | /library/metadata/48047/thumb/1671800243 |
| `grandparentThumb` | *string* | :heavy_minus_sign: | The URL of the grandparent's thumbnail image. | /library/metadata/45520/thumb/1736488003 |
| `grandparentArt` | *string* | :heavy_minus_sign: | The URL of the grandparent's art image. | /library/metadata/45520/art/1736488003 |
| `media` | [operations.GetMediaMetaDataMedia](../../../sdk/models/operations/getmediametadatamedia.md)[] | :heavy_minus_sign: | N/A | |
| `image` | [operations.GetMediaMetaDataImage](../../../sdk/models/operations/getmediametadataimage.md)[] | :heavy_check_mark: | An array of image objects. | |
| `ultraBlurColors` | [operations.GetMediaMetaDataUltraBlurColors](../../../sdk/models/operations/getmediametadataultrablurcolors.md) | :heavy_check_mark: | N/A | |
| `genre` | [operations.GetMediaMetaDataGenre](../../../sdk/models/operations/getmediametadatagenre.md)[] | :heavy_minus_sign: | An array of genre tags. | |
| `country` | [operations.GetMediaMetaDataCountry](../../../sdk/models/operations/getmediametadatacountry.md)[] | :heavy_minus_sign: | An array of country tags. | |
| `guids` | [operations.Guids](../../../sdk/models/operations/guids.md)[] | :heavy_check_mark: | An array of GUID objects. | |
| `rating` | [operations.Rating](../../../sdk/models/operations/rating.md)[] | :heavy_check_mark: | An array of rating objects. | |
| `role` | [operations.GetMediaMetaDataRole](../../../sdk/models/operations/getmediametadatarole.md)[] | :heavy_minus_sign: | An array of Actor roles. | |
| `director` | [operations.GetMediaMetaDataDirector](../../../sdk/models/operations/getmediametadatadirector.md)[] | :heavy_minus_sign: | An array of Director roles. | |
| `writer` | [operations.GetMediaMetaDataWriter](../../../sdk/models/operations/getmediametadatawriter.md)[] | :heavy_minus_sign: | An array of Writer roles. | |
| `producer` | [operations.Producer](../../../sdk/models/operations/producer.md)[] | :heavy_minus_sign: | An array of Writer roles. | |
| `similar` | [operations.Similar](../../../sdk/models/operations/similar.md)[] | :heavy_minus_sign: | An array of similar content objects. | |
| `location` | [operations.GetMediaMetaDataLocation](../../../sdk/models/operations/getmediametadatalocation.md)[] | :heavy_minus_sign: | An array of location objects. | |

View File

@@ -0,0 +1,86 @@
# GetMediaMetaDataPart
## Example Usage
```typescript
import { GetMediaMetaDataPart } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaMetaDataPart = {
accessible: true,
exists: true,
id: 418385,
key: "/library/parts/418385/1735864239/file.mkv",
indexes: "sd",
duration: 9610350,
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
size: 30649952104,
container: "mkv",
videoProfile: "main 10",
stream: [
{
id: 1002625,
streamType: 1,
default: true,
codec: "hevc",
index: 0,
bitrate: 24743,
language: "English",
languageTag: "en",
languageCode: "eng",
doviblCompatID: 1,
doviblPresent: true,
dovielPresent: false,
doviLevel: 6,
doviPresent: true,
doviProfile: 8,
dovirpuPresent: true,
doviVersion: "1.0",
bitDepth: 10,
chromaLocation: "topleft",
chromaSubsampling: "4:2:0",
codedHeight: 1608,
codedWidth: 3840,
colorPrimaries: "bt2020",
colorRange: "tv",
colorSpace: "bt2020nc",
colorTrc: "smpte2084",
frameRate: 23.976,
height: 1602,
level: 150,
original: true,
hasScalingMatrix: false,
profile: "main 10",
scanType: "progressive",
refFrames: 1,
width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
selected: true,
forced: true,
channels: 6,
audioChannelLayout: "5.1(side)",
samplingRate: 48000,
canAutoSync: false,
hearingImpaired: true,
dub: true,
title: "SDH",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `accessible` | *boolean* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `exists` | *boolean* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `id` | *number* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `indexes` | *string* | :heavy_minus_sign: | N/A | sd |
| `duration` | *number* | :heavy_check_mark: | Duration of the part in milliseconds. | 9610350 |
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *number* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `container` | *string* | :heavy_check_mark: | Container format of the part. | mkv |
| `videoProfile` | *string* | :heavy_check_mark: | Video profile for the part. | main 10 |
| `stream` | [operations.GetMediaMetaDataStream](../../../sdk/models/operations/getmediametadatastream.md)[] | :heavy_check_mark: | An array of streams for this part. | |

View File

@@ -0,0 +1,43 @@
# GetMediaMetaDataRequest
## Example Usage
```typescript
import { GetMediaMetaDataRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaMetaDataRequest = {
ratingKey: 9518,
includeConcerts: true,
includeExtras: true,
includeOnDeck: true,
includePopularLeaves: true,
includePreferences: true,
includeReviews: true,
includeChapters: true,
includeStations: true,
includeExternalMedia: true,
asyncAugmentMetadata: true,
asyncCheckFiles: true,
asyncRefreshAnalysis: true,
asyncRefreshLocalMediaAgent: true,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
| `ratingKey` | *number* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
| `includeConcerts` | *boolean* | :heavy_minus_sign: | Include concerts data if set to true. | true |
| `includeExtras` | *boolean* | :heavy_minus_sign: | Include extra content (e.g. bonus features). | true |
| `includeOnDeck` | *boolean* | :heavy_minus_sign: | Include on-deck items. | true |
| `includePopularLeaves` | *boolean* | :heavy_minus_sign: | Include popular leaves (episodes/chapters). | true |
| `includePreferences` | *boolean* | :heavy_minus_sign: | Include preferences information. | true |
| `includeReviews` | *boolean* | :heavy_minus_sign: | Include reviews for the content. | true |
| `includeChapters` | *boolean* | :heavy_minus_sign: | Include chapter details. | true |
| `includeStations` | *boolean* | :heavy_minus_sign: | Include station data. | true |
| `includeExternalMedia` | *boolean* | :heavy_minus_sign: | Include external media data. | true |
| `asyncAugmentMetadata` | *boolean* | :heavy_minus_sign: | Trigger asynchronous metadata augmentation. | true |
| `asyncCheckFiles` | *boolean* | :heavy_minus_sign: | Trigger asynchronous file checking. | true |
| `asyncRefreshAnalysis` | *boolean* | :heavy_minus_sign: | Trigger asynchronous refresh of analysis. | true |
| `asyncRefreshLocalMediaAgent` | *boolean* | :heavy_minus_sign: | Trigger asynchronous refresh of the local media agent. | true |

View File

@@ -0,0 +1,265 @@
# GetMediaMetaDataResponse
## Example Usage
```typescript
import { GetMediaMetaDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetMediaMetaDataResponse = {
contentType: "<value>",
statusCode: 103,
rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 50,
allowSync: false,
identifier: "com.plexapp.plugins.library",
librarySectionID: 2,
librarySectionTitle: "TV Series",
librarySectionUUID: "e69655a2-ef48-4aba-bb19-0cc34d1e7d36",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1734362201,
metadata: [
{
ratingKey: "44288",
parentRatingKey: "48047",
grandparentRatingKey: "45520",
parentGuid: "plex://season/618b89208dde18df707ad15c",
grandparentGuid: "plex://show/5e16253691c20300412003a8",
grandparentSlug: "alice-in-borderland-2020",
grandparentKey: "/library/metadata/45520",
parentKey: "/library/metadata/48047",
key: "/library/metadata/44288/children",
guid: "plex://show/5d9c08254eefaa001f5d6dcb",
slug: "better-call-saul",
studio: "Sony Pictures Television",
type: "show",
title: "Better Call Saul",
originalTitle: "Wicked: Part I",
librarySectionTitle: "TV Series ",
librarySectionID: 2,
librarySectionKey: "/library/sections/2",
contentRating: "TV-MA",
summary:
"Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to \"Breaking Bad\" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman.",
index: 1,
grandparentTitle: "Alice in Borderland",
parentTitle: "Season 2",
audienceRating: 8.7,
viewCount: 4,
skipCount: 1,
lastViewedAt: 1625764795,
year: 2015,
tagline: "Make the call",
chapterSource: "media",
primaryExtraKey: "/library/metadata/134704",
thumb: "/library/metadata/44288/thumb/1736487993",
art: "/library/metadata/44288/art/1736487993",
theme: "/library/metadata/44288/theme/1736487993",
duration: 2700000,
originallyAvailableAt: new RFCDate("2015-02-08"),
leafCount: 63,
viewedLeafCount: 4,
childCount: 6,
addedAt: 1625505101,
updatedAt: 1736487993,
audienceRatingImage: "themoviedb://image.rating",
parentIndex: 2,
parentThumb: "/library/metadata/48047/thumb/1671800243",
grandparentThumb: "/library/metadata/45520/thumb/1736488003",
grandparentArt: "/library/metadata/45520/art/1736488003",
media: [
{
id: 387322,
duration: 9610350,
bitrate: 25512,
width: 3840,
height: 1602,
aspectRatio: 2.35,
audioChannels: 6,
audioCodec: "eac3",
videoCodec: "hevc",
videoResolution: "4k",
container: "mkv",
videoFrameRate: "24p",
videoProfile: "main 10",
hasVoiceActivity: false,
part: [
{
accessible: true,
exists: true,
id: 418385,
key: "/library/parts/418385/1735864239/file.mkv",
indexes: "sd",
duration: 9610350,
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
size: 30649952104,
container: "mkv",
videoProfile: "main 10",
stream: [
{
id: 1002625,
streamType: 1,
default: true,
codec: "hevc",
index: 0,
bitrate: 24743,
language: "English",
languageTag: "en",
languageCode: "eng",
doviblCompatID: 1,
doviblPresent: true,
dovielPresent: false,
doviLevel: 6,
doviPresent: true,
doviProfile: 8,
dovirpuPresent: true,
doviVersion: "1.0",
bitDepth: 10,
chromaLocation: "topleft",
chromaSubsampling: "4:2:0",
codedHeight: 1608,
codedWidth: 3840,
colorPrimaries: "bt2020",
colorRange: "tv",
colorSpace: "bt2020nc",
colorTrc: "smpte2084",
frameRate: 23.976,
height: 1602,
level: 150,
original: true,
hasScalingMatrix: false,
profile: "main 10",
scanType: "progressive",
refFrames: 1,
width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
selected: true,
forced: true,
channels: 6,
audioChannelLayout: "5.1(side)",
samplingRate: 48000,
canAutoSync: false,
hearingImpaired: true,
dub: true,
title: "SDH",
},
],
},
],
},
],
image: [
{
alt: "Better Call Saul",
type: "coverPoster",
url: "/library/metadata/44288/thumb/1736487993",
},
],
ultraBlurColors: {
topLeft: "11333a",
topRight: "1d2721",
bottomRight: "5c451d",
bottomLeft: "372c10",
},
genre: [
{
id: 1057,
filter: "genre=1057",
tag: "Crime",
},
],
country: [
{
id: 58591,
filter: "country=58591",
tag: "United States of America",
},
],
guids: [
{
id: "imdb://tt3032476",
},
],
rating: [
{
image: "imdb://image.rating",
value: 9,
type: "audience",
},
],
role: [
{
id: 109501,
filter: "actor=109501",
tag: "Bob Odenkirk",
tagKey: "5d77683254f42c001f8c3f69",
role: "Jimmy McGill",
thumb:
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
},
],
director: [
{
id: 109501,
filter: "actor=109501",
tag: "Bob Odenkirk",
tagKey: "5d77683254f42c001f8c3f69",
role: "Jimmy McGill",
thumb:
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
},
],
writer: [
{
id: 109501,
filter: "actor=109501",
tag: "Bob Odenkirk",
tagKey: "5d77683254f42c001f8c3f69",
role: "Jimmy McGill",
thumb:
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
},
],
producer: [
{
id: 109501,
filter: "actor=109501",
tag: "Bob Odenkirk",
tagKey: "5d77683254f42c001f8c3f69",
role: "Jimmy McGill",
thumb:
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
},
],
similar: [
{
id: 26,
filter: "similar=26",
tag: "Breaking Bad",
},
],
location: [
{
path: "/TV Shows/Better Call Saul",
},
],
},
],
},
},
};
```
## 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.GetMediaMetaDataResponseBody](../../../sdk/models/operations/getmediametadataresponsebody.md) | :heavy_minus_sign: | The metadata of the library item. |

View File

@@ -0,0 +1,257 @@
# GetMediaMetaDataResponseBody
The metadata of the library item.
## Example Usage
```typescript
import { GetMediaMetaDataResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetMediaMetaDataResponseBody = {
mediaContainer: {
size: 50,
allowSync: false,
identifier: "com.plexapp.plugins.library",
librarySectionID: 2,
librarySectionTitle: "TV Series",
librarySectionUUID: "e69655a2-ef48-4aba-bb19-0cc34d1e7d36",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1734362201,
metadata: [
{
ratingKey: "44288",
parentRatingKey: "48047",
grandparentRatingKey: "45520",
parentGuid: "plex://season/618b89208dde18df707ad15c",
grandparentGuid: "plex://show/5e16253691c20300412003a8",
grandparentSlug: "alice-in-borderland-2020",
grandparentKey: "/library/metadata/45520",
parentKey: "/library/metadata/48047",
key: "/library/metadata/44288/children",
guid: "plex://show/5d9c08254eefaa001f5d6dcb",
slug: "better-call-saul",
studio: "Sony Pictures Television",
type: "show",
title: "Better Call Saul",
originalTitle: "Wicked: Part I",
librarySectionTitle: "TV Series ",
librarySectionID: 2,
librarySectionKey: "/library/sections/2",
contentRating: "TV-MA",
summary:
"Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to \"Breaking Bad\" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman.",
index: 1,
grandparentTitle: "Alice in Borderland",
parentTitle: "Season 2",
audienceRating: 8.7,
viewCount: 4,
skipCount: 1,
lastViewedAt: 1625764795,
year: 2015,
tagline: "Make the call",
chapterSource: "media",
primaryExtraKey: "/library/metadata/134704",
thumb: "/library/metadata/44288/thumb/1736487993",
art: "/library/metadata/44288/art/1736487993",
theme: "/library/metadata/44288/theme/1736487993",
duration: 2700000,
originallyAvailableAt: new RFCDate("2015-02-08"),
leafCount: 63,
viewedLeafCount: 4,
childCount: 6,
addedAt: 1625505101,
updatedAt: 1736487993,
audienceRatingImage: "themoviedb://image.rating",
parentIndex: 2,
parentThumb: "/library/metadata/48047/thumb/1671800243",
grandparentThumb: "/library/metadata/45520/thumb/1736488003",
grandparentArt: "/library/metadata/45520/art/1736488003",
media: [
{
id: 387322,
duration: 9610350,
bitrate: 25512,
width: 3840,
height: 1602,
aspectRatio: 2.35,
audioChannels: 6,
audioCodec: "eac3",
videoCodec: "hevc",
videoResolution: "4k",
container: "mkv",
videoFrameRate: "24p",
videoProfile: "main 10",
hasVoiceActivity: false,
part: [
{
accessible: true,
exists: true,
id: 418385,
key: "/library/parts/418385/1735864239/file.mkv",
indexes: "sd",
duration: 9610350,
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
size: 30649952104,
container: "mkv",
videoProfile: "main 10",
stream: [
{
id: 1002625,
streamType: 1,
default: true,
codec: "hevc",
index: 0,
bitrate: 24743,
language: "English",
languageTag: "en",
languageCode: "eng",
doviblCompatID: 1,
doviblPresent: true,
dovielPresent: false,
doviLevel: 6,
doviPresent: true,
doviProfile: 8,
dovirpuPresent: true,
doviVersion: "1.0",
bitDepth: 10,
chromaLocation: "topleft",
chromaSubsampling: "4:2:0",
codedHeight: 1608,
codedWidth: 3840,
colorPrimaries: "bt2020",
colorRange: "tv",
colorSpace: "bt2020nc",
colorTrc: "smpte2084",
frameRate: 23.976,
height: 1602,
level: 150,
original: true,
hasScalingMatrix: false,
profile: "main 10",
scanType: "progressive",
refFrames: 1,
width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
selected: true,
forced: true,
channels: 6,
audioChannelLayout: "5.1(side)",
samplingRate: 48000,
canAutoSync: false,
hearingImpaired: true,
dub: true,
title: "SDH",
},
],
},
],
},
],
image: [
{
alt: "Better Call Saul",
type: "coverPoster",
url: "/library/metadata/44288/thumb/1736487993",
},
],
ultraBlurColors: {
topLeft: "11333a",
topRight: "1d2721",
bottomRight: "5c451d",
bottomLeft: "372c10",
},
genre: [
{
id: 1057,
filter: "genre=1057",
tag: "Crime",
},
],
country: [
{
id: 58591,
filter: "country=58591",
tag: "United States of America",
},
],
guids: [
{
id: "imdb://tt3032476",
},
],
rating: [
{
image: "imdb://image.rating",
value: 9,
type: "audience",
},
],
role: [
{
id: 109501,
filter: "actor=109501",
tag: "Bob Odenkirk",
tagKey: "5d77683254f42c001f8c3f69",
role: "Jimmy McGill",
thumb:
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
},
],
director: [
{
id: 109501,
filter: "actor=109501",
tag: "Bob Odenkirk",
tagKey: "5d77683254f42c001f8c3f69",
role: "Jimmy McGill",
thumb:
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
},
],
writer: [
{
id: 109501,
filter: "actor=109501",
tag: "Bob Odenkirk",
tagKey: "5d77683254f42c001f8c3f69",
role: "Jimmy McGill",
thumb:
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
},
],
producer: [
{
id: 109501,
filter: "actor=109501",
tag: "Bob Odenkirk",
tagKey: "5d77683254f42c001f8c3f69",
role: "Jimmy McGill",
thumb:
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
},
],
similar: [
{
id: 26,
filter: "similar=26",
tag: "Breaking Bad",
},
],
location: [
{
path: "/TV Shows/Better Call Saul",
},
],
},
],
},
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.GetMediaMetaDataMediaContainer](../../../sdk/models/operations/getmediametadatamediacontainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,28 @@
# GetMediaMetaDataRole
## Example Usage
```typescript
import { GetMediaMetaDataRole } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaMetaDataRole = {
id: 109501,
filter: "actor=109501",
tag: "Bob Odenkirk",
tagKey: "5d77683254f42c001f8c3f69",
role: "Jimmy McGill",
thumb:
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *number* | :heavy_check_mark: | The unique role identifier. | 109501 |
| `filter` | *string* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
| `tag` | *string* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
| `tagKey` | *string* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
| `role` | *string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
| `thumb` | *string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |

View File

@@ -0,0 +1,107 @@
# GetMediaMetaDataStream
## Example Usage
```typescript
import { GetMediaMetaDataStream } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaMetaDataStream = {
id: 1002625,
streamType: 1,
default: true,
codec: "hevc",
index: 0,
bitrate: 24743,
language: "English",
languageTag: "en",
languageCode: "eng",
doviblCompatID: 1,
doviblPresent: true,
dovielPresent: false,
doviLevel: 6,
doviPresent: true,
doviProfile: 8,
dovirpuPresent: true,
doviVersion: "1.0",
bitDepth: 10,
chromaLocation: "topleft",
chromaSubsampling: "4:2:0",
codedHeight: 1608,
codedWidth: 3840,
colorPrimaries: "bt2020",
colorRange: "tv",
colorSpace: "bt2020nc",
colorTrc: "smpte2084",
frameRate: 23.976,
height: 1602,
level: 150,
original: true,
hasScalingMatrix: false,
profile: "main 10",
scanType: "progressive",
refFrames: 1,
width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
selected: true,
forced: true,
channels: 6,
audioChannelLayout: "5.1(side)",
samplingRate: 48000,
canAutoSync: false,
hearingImpaired: true,
dub: true,
title: "SDH",
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `id` | *number* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `streamType` | *number* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
| `default` | *boolean* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `index` | *number* | :heavy_check_mark: | Index of the stream. | 0 |
| `bitrate` | *number* | :heavy_check_mark: | Bitrate of the stream. | 24743 |
| `language` | *string* | :heavy_check_mark: | Language of the stream. | English |
| `languageTag` | *string* | :heavy_check_mark: | Language tag (e.g., en). | en |
| `languageCode` | *string* | :heavy_check_mark: | ISO language code. | eng |
| `doviblCompatID` | *number* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
| `doviblPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
| `dovielPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
| `doviLevel` | *number* | :heavy_minus_sign: | Dolby Vision level. | 6 |
| `doviPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
| `doviProfile` | *number* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
| `dovirpuPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
| `doviVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
| `bitDepth` | *number* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
| `chromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft |
| `chromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
| `codedHeight` | *number* | :heavy_minus_sign: | Coded video height. | 1608 |
| `codedWidth` | *number* | :heavy_minus_sign: | Coded video width. | 3840 |
| `colorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
| `colorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
| `colorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc |
| `colorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
| `frameRate` | *number* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
| `height` | *number* | :heavy_minus_sign: | Height of the video stream. | 1602 |
| `level` | *number* | :heavy_minus_sign: | Video level. | 150 |
| `original` | *boolean* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
| `hasScalingMatrix` | *boolean* | :heavy_minus_sign: | N/A | false |
| `profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 |
| `scanType` | *string* | :heavy_minus_sign: | N/A | progressive |
| `refFrames` | *number* | :heavy_minus_sign: | Number of reference frames. | 1 |
| `width` | *number* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `selected` | *boolean* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
| `forced` | *boolean* | :heavy_minus_sign: | N/A | true |
| `channels` | *number* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
| `audioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
| `canAutoSync` | *boolean* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
| `hearingImpaired` | *boolean* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
| `dub` | *boolean* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
| `title` | *string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |

View File

@@ -0,0 +1,23 @@
# GetMediaMetaDataUltraBlurColors
## Example Usage
```typescript
import { GetMediaMetaDataUltraBlurColors } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaMetaDataUltraBlurColors = {
topLeft: "11333a",
topRight: "1d2721",
bottomRight: "5c451d",
bottomLeft: "372c10",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
| `topLeft` | *string* | :heavy_check_mark: | The top-left color value. | 11333a |
| `topRight` | *string* | :heavy_check_mark: | The top-right color value. | 1d2721 |
| `bottomRight` | *string* | :heavy_check_mark: | The bottom-right color value. | 5c451d |
| `bottomLeft` | *string* | :heavy_check_mark: | The bottom-left color value. | 372c10 |

View File

@@ -0,0 +1,28 @@
# GetMediaMetaDataWriter
## Example Usage
```typescript
import { GetMediaMetaDataWriter } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaMetaDataWriter = {
id: 109501,
filter: "actor=109501",
tag: "Bob Odenkirk",
tagKey: "5d77683254f42c001f8c3f69",
role: "Jimmy McGill",
thumb:
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *number* | :heavy_check_mark: | The unique role identifier. | 109501 |
| `filter` | *string* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
| `tag` | *string* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
| `tagKey` | *string* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
| `role` | *string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
| `thumb` | *string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |

View File

@@ -1,21 +0,0 @@
# GetMetaDataByRatingKeyCountry
## Example Usage
```typescript
import { GetMetaDataByRatingKeyCountry } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMetaDataByRatingKeyCountry = {
id: 116,
filter: "country=116",
tag: "United States of America",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `id` | *number* | :heavy_minus_sign: | N/A | 116 |
| `filter` | *string* | :heavy_minus_sign: | N/A | country=116 |
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America |

View File

@@ -1,25 +0,0 @@
# GetMetaDataByRatingKeyDirector
## Example Usage
```typescript
import { GetMetaDataByRatingKeyDirector } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMetaDataByRatingKeyDirector = {
id: 130,
filter: "director=130",
tag: "Joss Whedon",
tagKey: "5d776828880197001ec90e8f",
thumb: "https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 130 |
| `filter` | *string* | :heavy_minus_sign: | N/A | director=130 |
| `tag` | *string* | :heavy_minus_sign: | N/A | Joss Whedon |
| `tagKey` | *string* | :heavy_minus_sign: | N/A | 5d776828880197001ec90e8f |
| `thumb` | *string* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg |

View File

@@ -1,21 +0,0 @@
# GetMetaDataByRatingKeyGenre
## Example Usage
```typescript
import { GetMetaDataByRatingKeyGenre } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMetaDataByRatingKeyGenre = {
id: 184,
filter: "genre=184",
tag: "Thriller",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *number* | :heavy_minus_sign: | N/A | 184 |
| `filter` | *string* | :heavy_minus_sign: | N/A | genre=184 |
| `tag` | *string* | :heavy_minus_sign: | N/A | Thriller |

View File

@@ -1,98 +0,0 @@
# GetMetaDataByRatingKeyMedia
## Example Usage
```typescript
import { GetMetaDataByRatingKeyMedia } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMetaDataByRatingKeyMedia = {
id: 15,
duration: 141417,
bitrate: 2278,
width: 1920,
height: 814,
aspectRatio: 2.35,
audioChannels: 2,
audioCodec: "aac",
videoCodec: "h264",
videoResolution: "1080",
container: "mp4",
videoFrameRate: "24p",
optimizedForStreaming: 0,
audioProfile: "lc",
has64bitOffsets: false,
videoProfile: "high",
part: [
{
id: 15,
key: "/library/parts/15/1705637151/file.mp4",
duration: 141417,
file: "/movies/Serenity (2005)/Serenity (2005).mp4",
size: 40271948,
audioProfile: "lc",
container: "mp4",
has64bitOffsets: false,
optimizedForStreaming: false,
videoProfile: "high",
stream: [
{
id: 29,
streamType: 2,
default: true,
codec: "aac",
index: 0,
bitrate: 128,
bitDepth: 8,
chromaLocation: "left",
chromaSubsampling: "14520",
codedHeight: 816,
codedWidth: 1920,
colorPrimaries: "bt709",
colorRange: "tv",
colorSpace: "bt709",
colorTrc: "bt709",
frameRate: 24,
hasScalingMatrix: false,
height: 814,
level: 40,
profile: "lc",
refFrames: 4,
scanType: "progressive",
streamIdentifier: "1",
width: 1920,
displayTitle: "English (AAC Stereo)",
extendedDisplayTitle: "English (AAC Stereo)",
selected: true,
channels: 2,
language: "English",
languageTag: "en",
languageCode: "eng",
samplingRate: 44100,
},
],
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 15 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 141417 |
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 2278 |
| `width` | *number* | :heavy_minus_sign: | N/A | 1920 |
| `height` | *number* | :heavy_minus_sign: | N/A | 814 |
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 2.35 |
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 2 |
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | aac |
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | h264 |
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 1080 |
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
| `optimizedForStreaming` | *number* | :heavy_minus_sign: | N/A | 0 |
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
| `part` | [operations.GetMetaDataByRatingKeyPart](../../../sdk/models/operations/getmetadatabyratingkeypart.md)[] | :heavy_minus_sign: | N/A | |

View File

@@ -1,199 +0,0 @@
# GetMetaDataByRatingKeyMediaContainer
## Example Usage
```typescript
import { GetMetaDataByRatingKeyMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetMetaDataByRatingKeyMediaContainer = {
size: 1,
allowSync: true,
identifier: "com.plexapp.plugins.library",
librarySectionID: 1,
librarySectionTitle: "Movies",
librarySectionUUID: "cfc899d7-3000-46f6-8489-b9592714ada5",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1698860922,
metadata: [
{
ratingKey: "17",
key: "/library/metadata/17",
guid: "plex://movie/5d77683f6f4521001ea9dc53",
studio: "Universal Pictures",
type: "movie",
title: "Serenity",
librarySectionTitle: "Movies",
librarySectionID: 1,
librarySectionKey: "/library/sections/1",
contentRating: "PG-13",
summary:
"Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.",
rating: 8.2,
audienceRating: 9.1,
year: 2005,
tagline: "They aim to misbehave.",
thumb: "/library/metadata/17/thumb/1705637165",
art: "/library/metadata/17/art/1705637165",
duration: 141417,
originallyAvailableAt: new RFCDate("2005-09-29T00:00:00Z"),
addedAt: 1705637164,
updatedAt: 1705637165,
audienceRatingImage: "rottentomatoes://image.rating.upright",
hasPremiumPrimaryExtra: "1",
ratingImage: "rottentomatoes://image.rating.ripe",
media: [
{
id: 15,
duration: 141417,
bitrate: 2278,
width: 1920,
height: 814,
aspectRatio: 2.35,
audioChannels: 2,
audioCodec: "aac",
videoCodec: "h264",
videoResolution: "1080",
container: "mp4",
videoFrameRate: "24p",
optimizedForStreaming: 0,
audioProfile: "lc",
has64bitOffsets: false,
videoProfile: "high",
part: [
{
id: 15,
key: "/library/parts/15/1705637151/file.mp4",
duration: 141417,
file: "/movies/Serenity (2005)/Serenity (2005).mp4",
size: 40271948,
audioProfile: "lc",
container: "mp4",
has64bitOffsets: false,
optimizedForStreaming: false,
videoProfile: "high",
stream: [
{
id: 29,
streamType: 2,
default: true,
codec: "aac",
index: 0,
bitrate: 128,
bitDepth: 8,
chromaLocation: "left",
chromaSubsampling: "14520",
codedHeight: 816,
codedWidth: 1920,
colorPrimaries: "bt709",
colorRange: "tv",
colorSpace: "bt709",
colorTrc: "bt709",
frameRate: 24,
hasScalingMatrix: false,
height: 814,
level: 40,
profile: "lc",
refFrames: 4,
scanType: "progressive",
streamIdentifier: "1",
width: 1920,
displayTitle: "English (AAC Stereo)",
extendedDisplayTitle: "English (AAC Stereo)",
selected: true,
channels: 2,
language: "English",
languageTag: "en",
languageCode: "eng",
samplingRate: 44100,
},
],
},
],
},
],
genre: [
{
id: 184,
filter: "genre=184",
tag: "Thriller",
},
],
country: [
{
id: 116,
filter: "country=116",
tag: "United States of America",
},
],
guids: [
{
id: "tvdb://2337",
},
],
ratings: [
{
image: "themoviedb://image.rating",
value: 7.4,
type: "audience",
},
],
director: [
{
id: 130,
filter: "director=130",
tag: "Joss Whedon",
tagKey: "5d776828880197001ec90e8f",
thumb:
"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg",
},
],
writer: [
{
id: 132,
filter: "writer=132",
tag: "Joss Whedon",
tagKey: "5d776828880197001ec90e8f",
thumb:
"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg",
},
],
role: [
{
id: 220,
filter: "actor=220",
tag: "Dennis Keiffer",
tagKey: "5d77683554f42c001f8c4708",
role: "Bar Guy (uncredited)",
thumb:
"https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg",
},
],
producer: [
{
id: 221,
filter: "producer=221",
tag: "Barry Mendel",
tagKey: "5d776826961905001eb90e2b",
thumb:
"https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg",
},
],
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `size` | *number* | :heavy_minus_sign: | N/A | 1 |
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionUUID` | *string* | :heavy_minus_sign: | N/A | cfc899d7-3000-46f6-8489-b9592714ada5 |
| `mediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *number* | :heavy_minus_sign: | N/A | 1698860922 |
| `metadata` | [operations.GetMetaDataByRatingKeyMetadata](../../../sdk/models/operations/getmetadatabyratingkeymetadata.md)[] | :heavy_minus_sign: | N/A | |

View File

@@ -1,72 +0,0 @@
# GetMetaDataByRatingKeyPart
## Example Usage
```typescript
import { GetMetaDataByRatingKeyPart } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMetaDataByRatingKeyPart = {
id: 15,
key: "/library/parts/15/1705637151/file.mp4",
duration: 141417,
file: "/movies/Serenity (2005)/Serenity (2005).mp4",
size: 40271948,
audioProfile: "lc",
container: "mp4",
has64bitOffsets: false,
optimizedForStreaming: false,
videoProfile: "high",
stream: [
{
id: 29,
streamType: 2,
default: true,
codec: "aac",
index: 0,
bitrate: 128,
bitDepth: 8,
chromaLocation: "left",
chromaSubsampling: "14520",
codedHeight: 816,
codedWidth: 1920,
colorPrimaries: "bt709",
colorRange: "tv",
colorSpace: "bt709",
colorTrc: "bt709",
frameRate: 24,
hasScalingMatrix: false,
height: 814,
level: 40,
profile: "lc",
refFrames: 4,
scanType: "progressive",
streamIdentifier: "1",
width: 1920,
displayTitle: "English (AAC Stereo)",
extendedDisplayTitle: "English (AAC Stereo)",
selected: true,
channels: 2,
language: "English",
languageTag: "en",
languageCode: "eng",
samplingRate: 44100,
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 15 |
| `key` | *string* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 141417 |
| `file` | *string* | :heavy_minus_sign: | N/A | /movies/Serenity (2005)/Serenity (2005).mp4 |
| `size` | *number* | :heavy_minus_sign: | N/A | 40271948 |
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | *boolean* | :heavy_minus_sign: | N/A | false |
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
| `stream` | [operations.GetMetaDataByRatingKeyStream](../../../sdk/models/operations/getmetadatabyratingkeystream.md)[] | :heavy_minus_sign: | N/A | |

View File

@@ -1,17 +0,0 @@
# GetMetaDataByRatingKeyRequest
## Example Usage
```typescript
import { GetMetaDataByRatingKeyRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMetaDataByRatingKeyRequest = {
ratingKey: 9518,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `ratingKey` | *number* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |

View File

@@ -1,203 +0,0 @@
# GetMetaDataByRatingKeyResponse
## Example Usage
```typescript
import { GetMetaDataByRatingKeyResponse } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetMetaDataByRatingKeyResponse = {
contentType: "<value>",
statusCode: 100,
rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 1,
allowSync: true,
identifier: "com.plexapp.plugins.library",
librarySectionID: 1,
librarySectionTitle: "Movies",
librarySectionUUID: "cfc899d7-3000-46f6-8489-b9592714ada5",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1698860922,
metadata: [
{
ratingKey: "17",
key: "/library/metadata/17",
guid: "plex://movie/5d77683f6f4521001ea9dc53",
studio: "Universal Pictures",
type: "movie",
title: "Serenity",
librarySectionTitle: "Movies",
librarySectionID: 1,
librarySectionKey: "/library/sections/1",
contentRating: "PG-13",
summary:
"Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.",
rating: 8.2,
audienceRating: 9.1,
year: 2005,
tagline: "They aim to misbehave.",
thumb: "/library/metadata/17/thumb/1705637165",
art: "/library/metadata/17/art/1705637165",
duration: 141417,
originallyAvailableAt: new RFCDate("2005-09-29T00:00:00Z"),
addedAt: 1705637164,
updatedAt: 1705637165,
audienceRatingImage: "rottentomatoes://image.rating.upright",
hasPremiumPrimaryExtra: "1",
ratingImage: "rottentomatoes://image.rating.ripe",
media: [
{
id: 15,
duration: 141417,
bitrate: 2278,
width: 1920,
height: 814,
aspectRatio: 2.35,
audioChannels: 2,
audioCodec: "aac",
videoCodec: "h264",
videoResolution: "1080",
container: "mp4",
videoFrameRate: "24p",
optimizedForStreaming: 0,
audioProfile: "lc",
has64bitOffsets: false,
videoProfile: "high",
part: [
{
id: 15,
key: "/library/parts/15/1705637151/file.mp4",
duration: 141417,
file: "/movies/Serenity (2005)/Serenity (2005).mp4",
size: 40271948,
audioProfile: "lc",
container: "mp4",
has64bitOffsets: false,
optimizedForStreaming: false,
videoProfile: "high",
stream: [
{
id: 29,
streamType: 2,
default: true,
codec: "aac",
index: 0,
bitrate: 128,
bitDepth: 8,
chromaLocation: "left",
chromaSubsampling: "14520",
codedHeight: 816,
codedWidth: 1920,
colorPrimaries: "bt709",
colorRange: "tv",
colorSpace: "bt709",
colorTrc: "bt709",
frameRate: 24,
hasScalingMatrix: false,
height: 814,
level: 40,
profile: "lc",
refFrames: 4,
scanType: "progressive",
streamIdentifier: "1",
width: 1920,
displayTitle: "English (AAC Stereo)",
extendedDisplayTitle: "English (AAC Stereo)",
selected: true,
channels: 2,
language: "English",
languageTag: "en",
languageCode: "eng",
samplingRate: 44100,
},
],
},
],
},
],
genre: [
{
id: 184,
filter: "genre=184",
tag: "Thriller",
},
],
country: [
{
id: 116,
filter: "country=116",
tag: "United States of America",
},
],
guids: [
{
id: "tvdb://2337",
},
],
ratings: [
{
image: "themoviedb://image.rating",
value: 7.4,
type: "audience",
},
],
director: [
{
id: 130,
filter: "director=130",
tag: "Joss Whedon",
tagKey: "5d776828880197001ec90e8f",
thumb:
"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg",
},
],
writer: [
{
id: 132,
filter: "writer=132",
tag: "Joss Whedon",
tagKey: "5d776828880197001ec90e8f",
thumb:
"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg",
},
],
role: [
{
id: 220,
filter: "actor=220",
tag: "Dennis Keiffer",
tagKey: "5d77683554f42c001f8c4708",
role: "Bar Guy (uncredited)",
thumb:
"https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg",
},
],
producer: [
{
id: 221,
filter: "producer=221",
tag: "Barry Mendel",
tagKey: "5d776826961905001eb90e2b",
thumb:
"https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg",
},
],
},
],
},
},
};
```
## 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.GetMetaDataByRatingKeyResponseBody](../../../sdk/models/operations/getmetadatabyratingkeyresponsebody.md) | :heavy_minus_sign: | The metadata of the library item. |

View File

@@ -1,195 +0,0 @@
# GetMetaDataByRatingKeyResponseBody
The metadata of the library item.
## Example Usage
```typescript
import { GetMetaDataByRatingKeyResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetMetaDataByRatingKeyResponseBody = {
mediaContainer: {
size: 1,
allowSync: true,
identifier: "com.plexapp.plugins.library",
librarySectionID: 1,
librarySectionTitle: "Movies",
librarySectionUUID: "cfc899d7-3000-46f6-8489-b9592714ada5",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1698860922,
metadata: [
{
ratingKey: "17",
key: "/library/metadata/17",
guid: "plex://movie/5d77683f6f4521001ea9dc53",
studio: "Universal Pictures",
type: "movie",
title: "Serenity",
librarySectionTitle: "Movies",
librarySectionID: 1,
librarySectionKey: "/library/sections/1",
contentRating: "PG-13",
summary:
"Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.",
rating: 8.2,
audienceRating: 9.1,
year: 2005,
tagline: "They aim to misbehave.",
thumb: "/library/metadata/17/thumb/1705637165",
art: "/library/metadata/17/art/1705637165",
duration: 141417,
originallyAvailableAt: new RFCDate("2005-09-29T00:00:00Z"),
addedAt: 1705637164,
updatedAt: 1705637165,
audienceRatingImage: "rottentomatoes://image.rating.upright",
hasPremiumPrimaryExtra: "1",
ratingImage: "rottentomatoes://image.rating.ripe",
media: [
{
id: 15,
duration: 141417,
bitrate: 2278,
width: 1920,
height: 814,
aspectRatio: 2.35,
audioChannels: 2,
audioCodec: "aac",
videoCodec: "h264",
videoResolution: "1080",
container: "mp4",
videoFrameRate: "24p",
optimizedForStreaming: 0,
audioProfile: "lc",
has64bitOffsets: false,
videoProfile: "high",
part: [
{
id: 15,
key: "/library/parts/15/1705637151/file.mp4",
duration: 141417,
file: "/movies/Serenity (2005)/Serenity (2005).mp4",
size: 40271948,
audioProfile: "lc",
container: "mp4",
has64bitOffsets: false,
optimizedForStreaming: false,
videoProfile: "high",
stream: [
{
id: 29,
streamType: 2,
default: true,
codec: "aac",
index: 0,
bitrate: 128,
bitDepth: 8,
chromaLocation: "left",
chromaSubsampling: "14520",
codedHeight: 816,
codedWidth: 1920,
colorPrimaries: "bt709",
colorRange: "tv",
colorSpace: "bt709",
colorTrc: "bt709",
frameRate: 24,
hasScalingMatrix: false,
height: 814,
level: 40,
profile: "lc",
refFrames: 4,
scanType: "progressive",
streamIdentifier: "1",
width: 1920,
displayTitle: "English (AAC Stereo)",
extendedDisplayTitle: "English (AAC Stereo)",
selected: true,
channels: 2,
language: "English",
languageTag: "en",
languageCode: "eng",
samplingRate: 44100,
},
],
},
],
},
],
genre: [
{
id: 184,
filter: "genre=184",
tag: "Thriller",
},
],
country: [
{
id: 116,
filter: "country=116",
tag: "United States of America",
},
],
guids: [
{
id: "tvdb://2337",
},
],
ratings: [
{
image: "themoviedb://image.rating",
value: 7.4,
type: "audience",
},
],
director: [
{
id: 130,
filter: "director=130",
tag: "Joss Whedon",
tagKey: "5d776828880197001ec90e8f",
thumb:
"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg",
},
],
writer: [
{
id: 132,
filter: "writer=132",
tag: "Joss Whedon",
tagKey: "5d776828880197001ec90e8f",
thumb:
"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg",
},
],
role: [
{
id: 220,
filter: "actor=220",
tag: "Dennis Keiffer",
tagKey: "5d77683554f42c001f8c4708",
role: "Bar Guy (uncredited)",
thumb:
"https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg",
},
],
producer: [
{
id: 221,
filter: "producer=221",
tag: "Barry Mendel",
tagKey: "5d776826961905001eb90e2b",
thumb:
"https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg",
},
],
},
],
},
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.GetMetaDataByRatingKeyMediaContainer](../../../sdk/models/operations/getmetadatabyratingkeymediacontainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -1,79 +0,0 @@
# GetMetaDataByRatingKeyStream
## Example Usage
```typescript
import { GetMetaDataByRatingKeyStream } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMetaDataByRatingKeyStream = {
id: 29,
streamType: 2,
default: true,
codec: "aac",
index: 0,
bitrate: 128,
bitDepth: 8,
chromaLocation: "left",
chromaSubsampling: "14520",
codedHeight: 816,
codedWidth: 1920,
colorPrimaries: "bt709",
colorRange: "tv",
colorSpace: "bt709",
colorTrc: "bt709",
frameRate: 24,
hasScalingMatrix: false,
height: 814,
level: 40,
profile: "lc",
refFrames: 4,
scanType: "progressive",
streamIdentifier: "1",
width: 1920,
displayTitle: "English (AAC Stereo)",
extendedDisplayTitle: "English (AAC Stereo)",
selected: true,
channels: 2,
language: "English",
languageTag: "en",
languageCode: "eng",
samplingRate: 44100,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 29 |
| `streamType` | *number* | :heavy_minus_sign: | N/A | 2 |
| `default` | *boolean* | :heavy_minus_sign: | N/A | true |
| `codec` | *string* | :heavy_minus_sign: | N/A | aac |
| `index` | *number* | :heavy_minus_sign: | N/A | 0 |
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 128 |
| `bitDepth` | *number* | :heavy_minus_sign: | N/A | 8 |
| `chromaLocation` | *string* | :heavy_minus_sign: | N/A | left |
| `chromaSubsampling` | *string* | :heavy_minus_sign: | N/A | 14520 |
| `codedHeight` | *number* | :heavy_minus_sign: | N/A | 816 |
| `codedWidth` | *number* | :heavy_minus_sign: | N/A | 1920 |
| `colorPrimaries` | *string* | :heavy_minus_sign: | N/A | bt709 |
| `colorRange` | *string* | :heavy_minus_sign: | N/A | tv |
| `colorSpace` | *string* | :heavy_minus_sign: | N/A | bt709 |
| `colorTrc` | *string* | :heavy_minus_sign: | N/A | bt709 |
| `frameRate` | *number* | :heavy_minus_sign: | N/A | 24 |
| `hasScalingMatrix` | *boolean* | :heavy_minus_sign: | N/A | false |
| `height` | *number* | :heavy_minus_sign: | N/A | 814 |
| `level` | *number* | :heavy_minus_sign: | N/A | 40 |
| `profile` | *string* | :heavy_minus_sign: | N/A | lc |
| `refFrames` | *number* | :heavy_minus_sign: | N/A | 4 |
| `scanType` | *string* | :heavy_minus_sign: | N/A | progressive |
| `streamIdentifier` | *string* | :heavy_minus_sign: | N/A | 1 |
| `width` | *number* | :heavy_minus_sign: | N/A | 1920 |
| `displayTitle` | *string* | :heavy_minus_sign: | N/A | English (AAC Stereo) |
| `extendedDisplayTitle` | *string* | :heavy_minus_sign: | N/A | English (AAC Stereo) |
| `selected` | *boolean* | :heavy_minus_sign: | N/A | true |
| `channels` | *number* | :heavy_minus_sign: | N/A | 2 |
| `language` | *string* | :heavy_minus_sign: | N/A | English |
| `languageTag` | *string* | :heavy_minus_sign: | N/A | en |
| `languageCode` | *string* | :heavy_minus_sign: | N/A | eng |
| `samplingRate` | *number* | :heavy_minus_sign: | N/A | 44100 |

View File

@@ -1,25 +0,0 @@
# GetMetaDataByRatingKeyWriter
## Example Usage
```typescript
import { GetMetaDataByRatingKeyWriter } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMetaDataByRatingKeyWriter = {
id: 132,
filter: "writer=132",
tag: "Joss Whedon",
tagKey: "5d776828880197001ec90e8f",
thumb: "https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 132 |
| `filter` | *string* | :heavy_minus_sign: | N/A | writer=132 |
| `tag` | *string* | :heavy_minus_sign: | N/A | Joss Whedon |
| `tagKey` | *string* | :heavy_minus_sign: | N/A | 5d776828880197001ec90e8f |
| `thumb` | *string* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg |

View File

@@ -6,7 +6,7 @@
import { GetMetadataChildrenRequest } from "@lukehagar/plexjs/sdk/models/operations"; import { GetMetadataChildrenRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMetadataChildrenRequest = { let value: GetMetadataChildrenRequest = {
ratingKey: 185.21, ratingKey: 2239.24,
}; };
``` ```

View File

@@ -7,7 +7,7 @@ import { GetMetadataChildrenResponse } from "@lukehagar/plexjs/sdk/models/operat
let value: GetMetadataChildrenResponse = { let value: GetMetadataChildrenResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 406, statusCode: 226,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -7,7 +7,7 @@ import { GetOnDeckResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetOnDeckResponse = { let value: GetOnDeckResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 400, statusCode: 102,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -1,6 +1,6 @@
# GetPlaylistContentsQueryParamType # GetPlaylistContentsQueryParamType
The type of media to retrieve. The type of media to retrieve or filter by.
1 = movie 1 = movie
2 = show 2 = show
3 = season 3 = season

View File

@@ -6,7 +6,7 @@
import { GetPlaylistContentsQueryParamType, GetPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations"; import { GetPlaylistContentsQueryParamType, GetPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetPlaylistContentsRequest = { let value: GetPlaylistContentsRequest = {
playlistID: 5883.17, playlistID: 6289.82,
type: GetPlaylistContentsQueryParamType.TvShow, type: GetPlaylistContentsQueryParamType.TvShow,
}; };
``` ```
@@ -14,6 +14,6 @@ let value: GetPlaylistContentsRequest = {
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `playlistID` | *number* | :heavy_check_mark: | the ID of the playlist | | | `playlistID` | *number* | :heavy_check_mark: | the ID of the playlist | |
| `type` | [operations.GetPlaylistContentsQueryParamType](../../../sdk/models/operations/getplaylistcontentsqueryparamtype.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 | | `type` | [operations.GetPlaylistContentsQueryParamType](../../../sdk/models/operations/getplaylistcontentsqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

View File

@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetPlaylistContentsResponse = { let value: GetPlaylistContentsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 506, statusCode: 503,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -6,7 +6,7 @@
import { GetPlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations"; import { GetPlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetPlaylistRequest = { let value: GetPlaylistRequest = {
playlistID: 8966.72, playlistID: 2168.97,
}; };
``` ```

View File

@@ -7,7 +7,7 @@ import { GetPlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetPlaylistResponse = { let value: GetPlaylistResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 502, statusCode: 407,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -7,7 +7,7 @@ import { GetPlaylistsResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetPlaylistsResponse = { let value: GetPlaylistsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 304, statusCode: 511,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -29,11 +29,11 @@ let value: GetRecentlyAddedLibraryRequest = {
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentDirectoryID` | *number* | :heavy_minus_sign: | N/A | 2 | | `contentDirectoryID` | *number* | :heavy_minus_sign: | N/A | 2 |
| `pinnedContentDirectoryID` | *number*[] | :heavy_minus_sign: | N/A | [<br/>3,<br/>5,<br/>7,<br/>13,<br/>12,<br/>1,<br/>6,<br/>14,<br/>2,<br/>10,<br/>16,<br/>17<br/>] | | `pinnedContentDirectoryID` | *number*[] | :heavy_minus_sign: | N/A | [<br/>3,<br/>5,<br/>7,<br/>13,<br/>12,<br/>1,<br/>6,<br/>14,<br/>2,<br/>10,<br/>16,<br/>17<br/>] |
| `sectionID` | *number* | :heavy_minus_sign: | The library section ID for filtering content. | 2 | | `sectionID` | *number* | :heavy_minus_sign: | The library section ID for filtering content. | 2 |
| `type` | [operations.QueryParamType](../../../sdk/models/operations/queryparamtype.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 | | `type` | [operations.QueryParamType](../../../sdk/models/operations/queryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `includeMeta` | [operations.QueryParamIncludeMeta](../../../sdk/models/operations/queryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 | | `includeMeta` | [operations.QueryParamIncludeMeta](../../../sdk/models/operations/queryparamincludemeta.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 | | `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 | | `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 |

View File

@@ -15,11 +15,11 @@ let value: GetRecentlyAddedRequest = {
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentDirectoryID` | *number* | :heavy_check_mark: | The content directory ID. | | | `contentDirectoryID` | *number* | :heavy_check_mark: | The content directory ID. | |
| `pinnedContentDirectoryID` | *string* | :heavy_minus_sign: | Comma-separated list of pinned content directory IDs. | | | `pinnedContentDirectoryID` | *string* | :heavy_minus_sign: | Comma-separated list of pinned content directory IDs. | |
| `sectionID` | *number* | :heavy_minus_sign: | The library section ID for filtering content. | 2 | | `sectionID` | *number* | :heavy_minus_sign: | The library section ID for filtering content. | 2 |
| `type` | [operations.Type](../../../sdk/models/operations/type.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 | | `type` | [operations.Type](../../../sdk/models/operations/type.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `includeMeta` | [operations.IncludeMeta](../../../sdk/models/operations/includemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 | | `includeMeta` | [operations.IncludeMeta](../../../sdk/models/operations/includemeta.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 | | `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 | | `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 |

View File

@@ -7,7 +7,7 @@ import { GetResourcesStatisticsResponse } from "@lukehagar/plexjs/sdk/models/ope
let value: GetResourcesStatisticsResponse = { let value: GetResourcesStatisticsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 226, statusCode: 423,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -15,10 +15,10 @@ import {
import { RFCDate } from "@lukehagar/plexjs/sdk/types"; import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetSearchAllLibrariesMediaContainer = { let value: GetSearchAllLibrariesMediaContainer = {
size: 8663.83, size: 8558.04,
searchResult: [ searchResult: [
{ {
score: 9755.22, score: 117.14,
metadata: { metadata: {
ratingKey: "58683", ratingKey: "58683",
key: "/library/metadata/58683", key: "/library/metadata/58683",

View File

@@ -9,7 +9,7 @@ let value: GetSearchAllLibrariesRequest = {
query: "<value>", query: "<value>",
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
searchTypes: [ searchTypes: [
SearchTypes.OtherVideos, SearchTypes.Tv,
], ],
}; };
``` ```

View File

@@ -16,16 +16,16 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetSearchAllLibrariesResponse = { let value: GetSearchAllLibrariesResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 207, statusCode: 102,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),
object: { object: {
mediaContainer: { mediaContainer: {
size: 1716.29, size: 543.38,
searchResult: [ searchResult: [
{ {
score: 5210.37, score: 1999.96,
metadata: { metadata: {
ratingKey: "58683", ratingKey: "58683",
key: "/library/metadata/58683", key: "/library/metadata/58683",

View File

@@ -18,10 +18,10 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetSearchAllLibrariesResponseBody = { let value: GetSearchAllLibrariesResponseBody = {
mediaContainer: { mediaContainer: {
size: 8558.04, size: 3599.78,
searchResult: [ searchResult: [
{ {
score: 117.14, score: 7299.91,
metadata: { metadata: {
ratingKey: "58683", ratingKey: "58683",
key: "/library/metadata/58683", key: "/library/metadata/58683",

View File

@@ -1,6 +1,6 @@
# GetSearchLibraryQueryParamType # GetSearchLibraryQueryParamType
The type of media to retrieve. The type of media to retrieve or filter by.
1 = movie 1 = movie
2 = show 2 = show
3 = season 3 = season

View File

@@ -14,6 +14,6 @@ let value: GetSearchLibraryRequest = {
## Fields ## Fields
| Field | Type | Required | Description | Example | | 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 | | `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `type` | [operations.GetSearchLibraryQueryParamType](../../../sdk/models/operations/getsearchlibraryqueryparamtype.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 | | `type` | [operations.GetSearchLibraryQueryParamType](../../../sdk/models/operations/getsearchlibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

View File

@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetSessionHistoryResponse = { let value: GetSessionHistoryResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 305, statusCode: 503,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -7,7 +7,7 @@ import { GetSessionsResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetSessionsResponse = { let value: GetSessionsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 500, statusCode: 305,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -7,7 +7,7 @@ import { GetStatisticsResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetStatisticsResponse = { let value: GetStatisticsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 101, statusCode: 226,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -13,7 +13,7 @@ import {
let value: GetTokenDetailsResponse = { let value: GetTokenDetailsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 302, statusCode: 307,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),
@@ -31,7 +31,7 @@ let value: GetTokenDetailsResponse = {
homeSize: 1, homeSize: 1,
id: 13692262, id: 13692262,
joinedAt: 1556281940, joinedAt: 1556281940,
locale: "hi", locale: "fr",
mailingListStatus: MailingListStatus.Active, mailingListStatus: MailingListStatus.Active,
maxHomeSize: 15, maxHomeSize: 15,
profile: { profile: {

View File

@@ -27,7 +27,7 @@ let value: GetTokenDetailsUserPlexAccount = {
homeSize: 1, homeSize: 1,
id: 13692262, id: 13692262,
joinedAt: 1556281940, joinedAt: 1556281940,
locale: "ja", locale: "pt",
mailingListStatus: MailingListStatus.Active, mailingListStatus: MailingListStatus.Active,
maxHomeSize: 15, maxHomeSize: 15,
profile: { profile: {

View File

@@ -1,6 +1,6 @@
# GetTopWatchedContentQueryParamType # GetTopWatchedContentQueryParamType
The type of media to retrieve. The type of media to retrieve or filter by.
1 = movie 1 = movie
2 = show 2 = show
3 = season 3 = season

View File

@@ -14,6 +14,6 @@ let value: GetTopWatchedContentRequest = {
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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 | | `type` | [operations.GetTopWatchedContentQueryParamType](../../../sdk/models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

View File

@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetTopWatchedContentResponse = { let value: GetTopWatchedContentResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 226, statusCode: 400,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -7,7 +7,7 @@ import { GetTranscodeSessionsResponse } from "@lukehagar/plexjs/sdk/models/opera
let value: GetTranscodeSessionsResponse = { let value: GetTranscodeSessionsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 503, statusCode: 201,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -7,7 +7,7 @@ import { GetTransientTokenResponse } from "@lukehagar/plexjs/sdk/models/operatio
let value: GetTransientTokenResponse = { let value: GetTransientTokenResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 205, statusCode: 100,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -7,7 +7,7 @@ import { GetUpdateStatusResponse } from "@lukehagar/plexjs/sdk/models/operations
let value: GetUpdateStatusResponse = { let value: GetUpdateStatusResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 103, statusCode: 424,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -7,7 +7,7 @@ import { GetUsersResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetUsersResponse = { let value: GetUsersResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 101, statusCode: 510,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

Some files were not shown because too many files have changed in this diff Show More