LukeParke/plexjs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexjs.git synced 2025-12-06 04:20:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.513.4

Browse Source
This commit is contained in:
speakeasybot
2025-03-09 00:10:48 +00:00
parent 5d57cd7c34
commit 8d9f4bbaf1
163 changed files with 4256 additions and 5690 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
.speakeasy/gen.lock
View File

File diff suppressed because one or more lines are too long

2
.speakeasy/gen.yaml
View File

@@ -15,7 +15,7 @@ generation:
oAuth2ClientCredentialsEnabled: true oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false oAuth2PasswordEnabled: false
typescript: typescript:
version: 0.35.0 version: 0.35.1
additionalDependencies: additionalDependencies:
dependencies: {} dependencies: {}
devDependencies: {} devDependencies: {}

14
.speakeasy/workflow.lock
View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.513.2 speakeasyVersion: 1.513.4
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:bf7001af017ce5072c503bfbaf60793f94549163b517489dc53e4f7b685659c0 sourceRevisionDigest: sha256:2066ba94b55e21d651c79003e3cf402fb77c52a0969fc52310b3383fbed038f4
sourceBlobDigest: sha256:ed2b29043c84f32d2efa92a126083fd9a81644a7ce9c6ac86d9aeb3493cbd6f8 sourceBlobDigest: sha256:1737023e29cd9cf36c07ccd8c8c48c47e14f47ce22b4d6ba9ee241afbbd8f351
tags: tags:
- latest - latest
- speakeasy-sdk-regen-1741306213 - speakeasy-sdk-regen-1741478971
- 0.0.3 - 0.0.3
targets: targets:
plexjs: plexjs:
source: plexapi source: plexapi
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:bf7001af017ce5072c503bfbaf60793f94549163b517489dc53e4f7b685659c0 sourceRevisionDigest: sha256:2066ba94b55e21d651c79003e3cf402fb77c52a0969fc52310b3383fbed038f4
sourceBlobDigest: sha256:ed2b29043c84f32d2efa92a126083fd9a81644a7ce9c6ac86d9aeb3493cbd6f8 sourceBlobDigest: sha256:1737023e29cd9cf36c07ccd8c8c48c47e14f47ce22b4d6ba9ee241afbbd8f351
codeSamplesNamespace: code-samples-typescript-plexjs codeSamplesNamespace: code-samples-typescript-plexjs
codeSamplesRevisionDigest: sha256:e9663ecbdaaaaaf3f7ff17e00365dc176eda813f06e83bae125af65c9ab34453 codeSamplesRevisionDigest: sha256:562c355ca997be7103dd50d641d9264002668b79ccbed1d1c259a98c653ce99a
workflow: workflow:
workflowVersion: 1.0.0 workflowVersion: 1.0.0
speakeasyVersion: latest speakeasyVersion: latest

2
README.md
View File

@@ -169,7 +169,6 @@ run();
* [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata * [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
### [log](docs/sdks/log/README.md) ### [log](docs/sdks/log/README.md)
@@ -546,7 +545,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items - [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
- [`libraryGetMediaMetaData`](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata - [`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
- [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added - [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
- [`libraryGetRefreshLibraryMetadata`](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library - [`libraryGetRefreshLibraryMetadata`](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
- [`libraryGetSearchAllLibraries`](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries - [`libraryGetSearchAllLibraries`](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries

12
RELEASES.md
View File

@@ -1238,4 +1238,14 @@ Based on:
### Generated ### Generated
- [typescript v0.35.0] . - [typescript v0.35.0] .
### Releases ### Releases
- [NPM v0.35.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.0 - . - [NPM v0.35.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.0 - .
## 2025-03-09 00:09:12
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.513.4 (2.545.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.35.1] .
### Releases
- [NPM v0.35.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.1 - .

20
codeSamples.yaml
View File

@@ -667,26 +667,6 @@ actions:
console.log(result); console.log(result);
} }
run();
- target: $["paths"]["/library/onDeck"]["get"]
update:
x-codeSamples:
- lang: typescript
label: getOnDeck
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.library.getOnDeck();
// Handle the result
console.log(result);
}
run(); run();
- target: $["paths"]["/library/recentlyAdded"]["get"] - target: $["paths"]["/library/recentlyAdded"]["get"]
update: update:

18
docs/sdk/models/errors/getondeckbadrequest.md
View File

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

21
docs/sdk/models/errors/getondeckerrors.md
View File

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

21
docs/sdk/models/errors/getondecklibraryerrors.md
View File

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

18
docs/sdk/models/errors/getondeckunauthorized.md
View File

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

2
docs/sdk/models/operations/addplaylistcontentsrequest.md
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: 3741.7, playlistID: 2776.28,
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1", uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
playQueueID: 123, playQueueID: 123,
}; };

2
docs/sdk/models/operations/addplaylistcontentsresponse.md
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: 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" },
}), }),

2
docs/sdk/models/operations/applyupdatesresponse.md
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: 428, statusCode: 208,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

2
docs/sdk/models/operations/billing.md
View File

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

2
docs/sdk/models/operations/checkforupdatesresponse.md
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: 508, statusCode: 428,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

2
docs/sdk/models/operations/clearplaylistcontentsrequest.md
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: 256.62, playlistID: 4246.85,
}; };
``` ```

8
docs/sdk/models/operations/collection.md
View File

@@ -6,12 +6,12 @@
import { Collection } from "@lukehagar/plexjs/sdk/models/operations"; import { Collection } from "@lukehagar/plexjs/sdk/models/operations";
let value: Collection = { let value: Collection = {
tag: "Working NL Subs", tag: "My Awesome Collection",
}; };
``` ```
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| `tag` | *string* | :heavy_minus_sign: | N/A | Working NL Subs | | `tag` | *string* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |

12
docs/sdk/models/operations/country.md
View File

@@ -1,17 +1,23 @@
# Country # Country
The filter query string for country media items.
## Example Usage ## Example Usage
```typescript ```typescript
import { Country } from "@lukehagar/plexjs/sdk/models/operations"; import { Country } from "@lukehagar/plexjs/sdk/models/operations";
let value: Country = { let value: Country = {
id: 259,
tag: "United States of America", tag: "United States of America",
filter: "country=19",
}; };
``` ```
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America | | `id` | *number* | :heavy_check_mark: | N/A | 259 |
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
| `filter` | *string* | :heavy_minus_sign: | N/A | country=19 |

2
docs/sdk/models/operations/createplaylistqueryparamtype.md
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.Photo;
``` ```
## Values ## Values

4
docs/sdk/models/operations/createplaylistrequest.md
View File

@@ -7,9 +7,9 @@ import { CreatePlaylistQueryParamType, CreatePlaylistRequest, Smart } from "@luk
let value: CreatePlaylistRequest = { let value: CreatePlaylistRequest = {
title: "<value>", title: "<value>",
type: CreatePlaylistQueryParamType.Photo, type: CreatePlaylistQueryParamType.Audio,
smart: Smart.One, smart: Smart.One,
uri: "https://radiant-dividend.com/", uri: "https://ajar-reward.biz/",
}; };
``` ```

2
docs/sdk/models/operations/createplaylistresponse.md
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: 409, statusCode: 205,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

2
docs/sdk/models/operations/deletelibraryresponse.md
View File

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

2
docs/sdk/models/operations/deleteplaylistrequest.md
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: 1856.36, playlistID: 6874.88,
}; };
``` ```

2
docs/sdk/models/operations/deleteplaylistresponse.md
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: 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" },
}), }),

8
docs/sdk/models/operations/director.md
View File

@@ -6,12 +6,12 @@
import { Director } from "@lukehagar/plexjs/sdk/models/operations"; import { Director } from "@lukehagar/plexjs/sdk/models/operations";
let value: Director = { let value: Director = {
tag: "James Cameron", tag: "Danny Boyle",
}; };
``` ```
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
| `tag` | *string* | :heavy_minus_sign: | N/A | James Cameron | | `tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |

2
docs/sdk/models/operations/enablepapertrailresponse.md
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: 102, statusCode: 304,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

2
docs/sdk/models/operations/filter.md
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.Released;
``` ```
## Values ## Values

14
docs/sdk/models/operations/genre.md
View File

@@ -1,17 +1,23 @@
# Genre # Genre
The filter query string for similar items.
## Example Usage ## Example Usage
```typescript ```typescript
import { Genre } from "@lukehagar/plexjs/sdk/models/operations"; import { Genre } from "@lukehagar/plexjs/sdk/models/operations";
let value: Genre = { let value: Genre = {
tag: "Adventure", id: 259,
filter: "genre=19",
tag: "Crime",
}; };
``` ```
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `tag` | *string* | :heavy_minus_sign: | N/A | Adventure | | `id` | *number* | :heavy_check_mark: | N/A | 259 |
| `filter` | *string* | :heavy_check_mark: | N/A | genre=19 |
| `tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |

2
docs/sdk/models/operations/getactorslibraryresponse.md
View File

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

2
docs/sdk/models/operations/getalllibrariesresponse.md
View File

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

8
docs/sdk/models/operations/getallmedialibrarygenre.md
View File

@@ -6,12 +6,12 @@
import { GetAllMediaLibraryGenre } from "@lukehagar/plexjs/sdk/models/operations"; import { GetAllMediaLibraryGenre } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllMediaLibraryGenre = { let value: GetAllMediaLibraryGenre = {
tag: "United States of America", tag: "Crime",
}; };
``` ```
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America | | `tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |

17
docs/sdk/models/operations/getallmedialibraryguids.md Normal file
View File

@@ -0,0 +1,17 @@
# GetAllMediaLibraryGuids
## Example Usage
```typescript
import { GetAllMediaLibraryGuids } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllMediaLibraryGuids = {
id: "tvdb://2337",
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `id` | *string* | :heavy_minus_sign: | The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337<br/> | tvdb://2337 |

6
docs/sdk/models/operations/getallmedialibrarymedia.md
View File

@@ -63,6 +63,7 @@ let value: GetAllMediaLibraryMedia = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
@@ -74,6 +75,7 @@ let value: GetAllMediaLibraryMedia = {
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
@@ -112,8 +114,8 @@ let value: GetAllMediaLibraryMedia = {
| `container` | *string* | :heavy_minus_sign: | File container type. | mkv | | `container` | *string* | :heavy_minus_sign: | File container type. | mkv |
| `videoFrameRate` | *string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p | | `videoFrameRate` | *string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `videoProfile` | *string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 | | `videoProfile` | *string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `hasVoiceActivity` | *boolean* | :heavy_check_mark: | Indicates whether voice activity is detected. | false | | `hasVoiceActivity` | *boolean* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
| `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts | | `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `optimizedForStreaming` | *operations.GetAllMediaLibraryOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | | | `optimizedForStreaming` | *operations.GetAllMediaLibraryOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false | | `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
| `part` | [operations.GetAllMediaLibraryPart](../../../sdk/models/operations/getallmedialibrarypart.md)[] | :heavy_check_mark: | An array of parts for this media item. | | | `part` | [operations.GetAllMediaLibraryPart](../../../sdk/models/operations/getallmedialibrarypart.md)[] | :heavy_minus_sign: | An array of parts for this media item. | |

8
docs/sdk/models/operations/getallmedialibrarymediacontainer.md
View File

@@ -210,6 +210,7 @@ let value: GetAllMediaLibraryMediaContainer = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
@@ -221,6 +222,7 @@ let value: GetAllMediaLibraryMediaContainer = {
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
@@ -242,7 +244,7 @@ let value: GetAllMediaLibraryMediaContainer = {
], ],
genre: [ genre: [
{ {
tag: "United States of America", tag: "Crime",
}, },
], ],
country: [ country: [
@@ -257,12 +259,12 @@ let value: GetAllMediaLibraryMediaContainer = {
], ],
writer: [ writer: [
{ {
tag: "Danny Boyle", tag: "Jamie P. Hanson",
}, },
], ],
role: [ role: [
{ {
tag: "Danny Boyle", tag: "Teller",
}, },
], ],
guids: [ guids: [

12
docs/sdk/models/operations/getallmedialibrarymetadata.md
View File

@@ -144,6 +144,7 @@ let value: GetAllMediaLibraryMetadata = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
@@ -155,6 +156,7 @@ let value: GetAllMediaLibraryMetadata = {
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
@@ -176,7 +178,7 @@ let value: GetAllMediaLibraryMetadata = {
], ],
genre: [ genre: [
{ {
tag: "United States of America", tag: "Crime",
}, },
], ],
country: [ country: [
@@ -191,12 +193,12 @@ let value: GetAllMediaLibraryMetadata = {
], ],
writer: [ writer: [
{ {
tag: "Danny Boyle", tag: "Jamie P. Hanson",
}, },
], ],
role: [ role: [
{ {
tag: "Danny Boyle", tag: "Teller",
}, },
], ],
guids: [ guids: [
@@ -228,7 +230,7 @@ let value: GetAllMediaLibraryMetadata = {
| `summary` | *string* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> | | `summary` | *string* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
| `rating` | *number* | :heavy_check_mark: | The critic rating for the media item. | 7.6 | | `rating` | *number* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
| `audienceRating` | *number* | :heavy_check_mark: | The audience rating for the media item. | 9.2 | | `audienceRating` | *number* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `year` | *number* | :heavy_check_mark: | The release year of the media item. | 2022 | | `year` | *number* | :heavy_minus_sign: | The release year of the media item. | 2022 |
| `tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. | | `tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
| `thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 | | `thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
| `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 | | `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
@@ -278,5 +280,5 @@ let value: GetAllMediaLibraryMetadata = {
| `director` | [operations.GetAllMediaLibraryDirector](../../../sdk/models/operations/getallmedialibrarydirector.md)[] | :heavy_minus_sign: | N/A | | | `director` | [operations.GetAllMediaLibraryDirector](../../../sdk/models/operations/getallmedialibrarydirector.md)[] | :heavy_minus_sign: | N/A | |
| `writer` | [operations.GetAllMediaLibraryWriter](../../../sdk/models/operations/getallmedialibrarywriter.md)[] | :heavy_minus_sign: | N/A | | | `writer` | [operations.GetAllMediaLibraryWriter](../../../sdk/models/operations/getallmedialibrarywriter.md)[] | :heavy_minus_sign: | N/A | |
| `role` | [operations.GetAllMediaLibraryRole](../../../sdk/models/operations/getallmedialibraryrole.md)[] | :heavy_minus_sign: | N/A | | | `role` | [operations.GetAllMediaLibraryRole](../../../sdk/models/operations/getallmedialibraryrole.md)[] | :heavy_minus_sign: | N/A | |
| `guids` | [operations.Guids](../../../sdk/models/operations/guids.md)[] | :heavy_minus_sign: | N/A | | | `guids` | [operations.GetAllMediaLibraryGuids](../../../sdk/models/operations/getallmedialibraryguids.md)[] | :heavy_minus_sign: | N/A | |
| `collection` | [operations.GetAllMediaLibraryCollection](../../../sdk/models/operations/getallmedialibrarycollection.md)[] | :heavy_minus_sign: | N/A | | | `collection` | [operations.GetAllMediaLibraryCollection](../../../sdk/models/operations/getallmedialibrarycollection.md)[] | :heavy_minus_sign: | N/A | |

4
docs/sdk/models/operations/getallmedialibraryoptimizedforstreaming.md
View File

@@ -5,10 +5,10 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
## Supported Types ## Supported Types
### `operations.One` ### `operations.OptimizedForStreaming1`
```typescript ```typescript
const value: operations.One = One.One; const value: operations.OptimizedForStreaming1 = OptimizedForStreaming1.One;
``` ```
### `boolean` ### `boolean`

2
docs/sdk/models/operations/getallmedialibraryoptimizedforstreaming1.md
View File

@@ -6,7 +6,7 @@
import { GetAllMediaLibraryOptimizedForStreaming1 } from "@lukehagar/plexjs/sdk/models/operations"; import { GetAllMediaLibraryOptimizedForStreaming1 } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllMediaLibraryOptimizedForStreaming1 = let value: GetAllMediaLibraryOptimizedForStreaming1 =
GetAllMediaLibraryOptimizedForStreaming1.Zero; GetAllMediaLibraryOptimizedForStreaming1.One;
``` ```
## Values ## Values

2
docs/sdk/models/operations/getallmedialibrarypart.md
View File

@@ -44,6 +44,7 @@ let value: GetAllMediaLibraryPart = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
@@ -55,6 +56,7 @@ let value: GetAllMediaLibraryPart = {
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",

10
docs/sdk/models/operations/getallmedialibraryresponse.md
View File

@@ -12,7 +12,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetAllMediaLibraryResponse = { let value: GetAllMediaLibraryResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 103, statusCode: 300,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),
@@ -217,6 +217,7 @@ let value: GetAllMediaLibraryResponse = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
@@ -228,6 +229,7 @@ let value: GetAllMediaLibraryResponse = {
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
@@ -249,7 +251,7 @@ let value: GetAllMediaLibraryResponse = {
], ],
genre: [ genre: [
{ {
tag: "United States of America", tag: "Crime",
}, },
], ],
country: [ country: [
@@ -264,12 +266,12 @@ let value: GetAllMediaLibraryResponse = {
], ],
writer: [ writer: [
{ {
tag: "Danny Boyle", tag: "Jamie P. Hanson",
}, },
], ],
role: [ role: [
{ {
tag: "Danny Boyle", tag: "Teller",
}, },
], ],
guids: [ guids: [

8
docs/sdk/models/operations/getallmedialibraryresponsebody.md
View File

@@ -213,6 +213,7 @@ let value: GetAllMediaLibraryResponseBody = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
@@ -224,6 +225,7 @@ let value: GetAllMediaLibraryResponseBody = {
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
@@ -245,7 +247,7 @@ let value: GetAllMediaLibraryResponseBody = {
], ],
genre: [ genre: [
{ {
tag: "United States of America", tag: "Crime",
}, },
], ],
country: [ country: [
@@ -260,12 +262,12 @@ let value: GetAllMediaLibraryResponseBody = {
], ],
writer: [ writer: [
{ {
tag: "Danny Boyle", tag: "Jamie P. Hanson",
}, },
], ],
role: [ role: [
{ {
tag: "Danny Boyle", tag: "Teller",
}, },
], ],
guids: [ guids: [

8
docs/sdk/models/operations/getallmedialibraryrole.md
View File

@@ -6,12 +6,12 @@
import { GetAllMediaLibraryRole } from "@lukehagar/plexjs/sdk/models/operations"; import { GetAllMediaLibraryRole } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllMediaLibraryRole = { let value: GetAllMediaLibraryRole = {
tag: "Danny Boyle", tag: "Teller",
}; };
``` ```
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
| `tag` | *string* | :heavy_check_mark: | The name of the actor for this role | Danny Boyle | | `tag` | *string* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |

10
docs/sdk/models/operations/getallmedialibrarystream.md
View File

@@ -29,6 +29,7 @@ let value: GetAllMediaLibraryStream = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
@@ -40,6 +41,7 @@ let value: GetAllMediaLibraryStream = {
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
@@ -66,9 +68,9 @@ let value: GetAllMediaLibraryStream = {
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc | | `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `index` | *number* | :heavy_check_mark: | Index of the stream. | 0 | | `index` | *number* | :heavy_check_mark: | Index of the stream. | 0 |
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 | | `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `language` | *string* | :heavy_check_mark: | Language of the stream. | English | | `language` | *string* | :heavy_minus_sign: | Language of the stream. | English |
| `languageTag` | *string* | :heavy_check_mark: | Language tag (e.g., en). | en | | `languageTag` | *string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
| `languageCode` | *string* | :heavy_check_mark: | ISO language code. | eng | | `languageCode` | *string* | :heavy_minus_sign: | ISO language code. | eng |
| `headerCompression` | *boolean* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true | | `headerCompression` | *boolean* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
| `doviblCompatID` | *number* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 | | `doviblCompatID` | *number* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
| `doviblPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true | | `doviblPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
@@ -83,6 +85,7 @@ let value: GetAllMediaLibraryStream = {
| `chromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 | | `chromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
| `codedHeight` | *number* | :heavy_minus_sign: | Coded video height. | 1608 | | `codedHeight` | *number* | :heavy_minus_sign: | Coded video height. | 1608 |
| `codedWidth` | *number* | :heavy_minus_sign: | Coded video width. | 3840 | | `codedWidth` | *number* | :heavy_minus_sign: | Coded video width. | 3840 |
| `closedCaptions` | *boolean* | :heavy_minus_sign: | N/A | true |
| `colorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 | | `colorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
| `colorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv | | `colorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
| `colorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc | | `colorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc |
@@ -94,6 +97,7 @@ let value: GetAllMediaLibraryStream = {
| `hasScalingMatrix` | *boolean* | :heavy_minus_sign: | N/A | false | | `hasScalingMatrix` | *boolean* | :heavy_minus_sign: | N/A | false |
| `profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 | | `profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 |
| `scanType` | *string* | :heavy_minus_sign: | N/A | progressive | | `scanType` | *string* | :heavy_minus_sign: | N/A | progressive |
| `embeddedInVideo` | *string* | :heavy_minus_sign: | N/A | progressive |
| `refFrames` | *number* | :heavy_minus_sign: | Number of reference frames. | 1 | | `refFrames` | *number* | :heavy_minus_sign: | Number of reference frames. | 1 |
| `width` | *number* | :heavy_minus_sign: | Width of the video stream. | 3840 | | `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) | | `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |

4
docs/sdk/models/operations/getallmedialibrarywriter.md
View File

@@ -6,7 +6,7 @@
import { GetAllMediaLibraryWriter } from "@lukehagar/plexjs/sdk/models/operations"; import { GetAllMediaLibraryWriter } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllMediaLibraryWriter = { let value: GetAllMediaLibraryWriter = {
tag: "Danny Boyle", tag: "Jamie P. Hanson",
}; };
``` ```
@@ -14,4 +14,4 @@ let value: GetAllMediaLibraryWriter = {
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *string* | :heavy_check_mark: | The role of Writer | Danny Boyle | | `tag` | *string* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |

2
docs/sdk/models/operations/getbandwidthstatisticsresponse.md
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: 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" },
}), }),

2
docs/sdk/models/operations/getcountrieslibraryresponse.md
View File

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

2
docs/sdk/models/operations/getfilehashresponse.md
View File

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

2
docs/sdk/models/operations/getgenreslibraryresponse.md
View File

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

2
docs/sdk/models/operations/getlibrarydetailsresponse.md
View File

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

2
docs/sdk/models/operations/getlibraryhubsrequest.md
View File

@@ -6,7 +6,7 @@
import { GetLibraryHubsRequest } from "@lukehagar/plexjs/sdk/models/operations"; import { GetLibraryHubsRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryHubsRequest = { let value: GetLibraryHubsRequest = {
sectionId: 6063.93, sectionId: 2900.77,
}; };
``` ```

2
docs/sdk/models/operations/getlibraryhubsresponse.md
View File

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

19
docs/sdk/models/operations/getlibraryitemsenablecreditsmarkergeneration.md
View File

@@ -1,19 +0,0 @@
# GetLibraryItemsEnableCreditsMarkerGeneration
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
## Example Usage
```typescript
import { GetLibraryItemsEnableCreditsMarkerGeneration } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsEnableCreditsMarkerGeneration =
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault;
```
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Disabled` | 0 |

19
docs/sdk/models/operations/getlibraryitemsepisodesort.md
View File

@@ -1,19 +0,0 @@
# GetLibraryItemsEpisodeSort
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
## Example Usage
```typescript
import { GetLibraryItemsEpisodeSort } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsEpisodeSort = GetLibraryItemsEpisodeSort.OldestFirst;
```
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `OldestFirst` | 0 |
| `NewestFirst` | 1 |

19
docs/sdk/models/operations/getlibraryitemsflattenseasons.md
View File

@@ -1,19 +0,0 @@
# GetLibraryItemsFlattenSeasons
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
## Example Usage
```typescript
import { GetLibraryItemsFlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsFlattenSeasons = GetLibraryItemsFlattenSeasons.Show;
```
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Hide` | 0 |
| `Show` | 1 |

16
docs/sdk/models/operations/getlibraryitemsmediacontainer.md
View File

@@ -7,13 +7,13 @@ The Meta object is only included in the response if the `includeMeta` parameter
```typescript ```typescript
import { import {
GetLibraryItemsEnableCreditsMarkerGeneration, EnableCreditsMarkerGeneration,
GetLibraryItemsEpisodeSort, EpisodeSort,
GetLibraryItemsFlattenSeasons, FlattenSeasons,
GetLibraryItemsLibraryResponse200Type, GetLibraryItemsLibraryResponse200Type,
GetLibraryItemsLibraryType, GetLibraryItemsLibraryType,
GetLibraryItemsMediaContainer, GetLibraryItemsMediaContainer,
GetLibraryItemsShowOrdering, ShowOrdering,
} from "@lukehagar/plexjs/sdk/models/operations"; } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types"; import { RFCDate } from "@lukehagar/plexjs/sdk/types";
@@ -106,11 +106,11 @@ let value: GetLibraryItemsMediaContainer = {
year: 2022, year: 2022,
seasonCount: 2022, seasonCount: 2022,
tagline: "Return to Pandora.", tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.Show, flattenSeasons: FlattenSeasons.Show,
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst, episodeSort: EpisodeSort.OldestFirst,
enableCreditsMarkerGeneration: enableCreditsMarkerGeneration:
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault, EnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute, showOrdering: ShowOrdering.TvdbAbsolute,
thumb: "/library/metadata/58683/thumb/1703239236", thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236", art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236", banner: "/library/metadata/58683/banner/1703239236",

17
docs/sdk/models/operations/getlibraryitemsmediaguid.md
View File

@@ -1,17 +0,0 @@
# GetLibraryItemsMediaGuid
## Example Usage
```typescript
import { GetLibraryItemsMediaGuid } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsMediaGuid = {
id: "imdb://tt13015952",
};
```
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `id` | *string* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |

29
docs/sdk/models/operations/getlibraryitemsmetadata.md
View File

@@ -4,13 +4,13 @@
```typescript ```typescript
import { import {
GetLibraryItemsEnableCreditsMarkerGeneration, EnableCreditsMarkerGeneration,
GetLibraryItemsEpisodeSort, EpisodeSort,
GetLibraryItemsFlattenSeasons, FlattenSeasons,
GetLibraryItemsLibraryResponse200Type, GetLibraryItemsLibraryResponse200Type,
GetLibraryItemsLibraryType, GetLibraryItemsLibraryType,
GetLibraryItemsMetadata, GetLibraryItemsMetadata,
GetLibraryItemsShowOrdering, ShowOrdering,
} from "@lukehagar/plexjs/sdk/models/operations"; } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types"; import { RFCDate } from "@lukehagar/plexjs/sdk/types";
@@ -34,11 +34,10 @@ let value: GetLibraryItemsMetadata = {
year: 2022, year: 2022,
seasonCount: 2022, seasonCount: 2022,
tagline: "Return to Pandora.", tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.Show, flattenSeasons: FlattenSeasons.Show,
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst, episodeSort: EpisodeSort.OldestFirst,
enableCreditsMarkerGeneration: enableCreditsMarkerGeneration: EnableCreditsMarkerGeneration.LibraryDefault,
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault, showOrdering: ShowOrdering.TvdbAbsolute,
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
thumb: "/library/metadata/58683/thumb/1703239236", thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236", art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236", banner: "/library/metadata/58683/banner/1703239236",
@@ -250,10 +249,10 @@ let value: GetLibraryItemsMetadata = {
| `year` | *number* | :heavy_minus_sign: | N/A | 2022 | | `year` | *number* | :heavy_minus_sign: | N/A | 2022 |
| `seasonCount` | *number* | :heavy_minus_sign: | N/A | 2022 | | `seasonCount` | *number* | :heavy_minus_sign: | N/A | 2022 |
| `tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. | | `tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `flattenSeasons` | [operations.GetLibraryItemsFlattenSeasons](../../../sdk/models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 | | `flattenSeasons` | [operations.FlattenSeasons](../../../sdk/models/operations/flattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
| `episodeSort` | [operations.GetLibraryItemsEpisodeSort](../../../sdk/models/operations/getlibraryitemsepisodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 | | `episodeSort` | [operations.EpisodeSort](../../../sdk/models/operations/episodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
| `enableCreditsMarkerGeneration` | [operations.GetLibraryItemsEnableCreditsMarkerGeneration](../../../sdk/models/operations/getlibraryitemsenablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 | | `enableCreditsMarkerGeneration` | [operations.EnableCreditsMarkerGeneration](../../../sdk/models/operations/enablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
| `showOrdering` | [operations.GetLibraryItemsShowOrdering](../../../sdk/models/operations/getlibraryitemsshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute | | `showOrdering` | [operations.ShowOrdering](../../../sdk/models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 | | `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 | | `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 | | `banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
@@ -282,9 +281,9 @@ let value: GetLibraryItemsMetadata = {
| `collection` | [operations.GetLibraryItemsCollection](../../../sdk/models/operations/getlibraryitemscollection.md)[] | :heavy_minus_sign: | N/A | | | `collection` | [operations.GetLibraryItemsCollection](../../../sdk/models/operations/getlibraryitemscollection.md)[] | :heavy_minus_sign: | N/A | |
| `role` | [operations.GetLibraryItemsRole](../../../sdk/models/operations/getlibraryitemsrole.md)[] | :heavy_minus_sign: | N/A | | | `role` | [operations.GetLibraryItemsRole](../../../sdk/models/operations/getlibraryitemsrole.md)[] | :heavy_minus_sign: | N/A | |
| `location` | [operations.GetLibraryItemsLocation](../../../sdk/models/operations/getlibraryitemslocation.md)[] | :heavy_minus_sign: | N/A | | | `location` | [operations.GetLibraryItemsLocation](../../../sdk/models/operations/getlibraryitemslocation.md)[] | :heavy_minus_sign: | N/A | |
| `mediaGuid` | [operations.GetLibraryItemsMediaGuid](../../../sdk/models/operations/getlibraryitemsmediaguid.md)[] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | | | `mediaGuid` | [operations.MediaGuid](../../../sdk/models/operations/mediaguid.md)[] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `ultraBlurColors` | [operations.GetLibraryItemsUltraBlurColors](../../../sdk/models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | | | `ultraBlurColors` | [operations.GetLibraryItemsUltraBlurColors](../../../sdk/models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `metaDataRating` | [operations.GetLibraryItemsMetaDataRating](../../../sdk/models/operations/getlibraryitemsmetadatarating.md)[] | :heavy_minus_sign: | N/A | | | `metaDataRating` | [operations.MetaDataRating](../../../sdk/models/operations/metadatarating.md)[] | :heavy_minus_sign: | N/A | |
| `image` | [operations.GetLibraryItemsImage](../../../sdk/models/operations/getlibraryitemsimage.md)[] | :heavy_minus_sign: | N/A | | | `image` | [operations.GetLibraryItemsImage](../../../sdk/models/operations/getlibraryitemsimage.md)[] | :heavy_minus_sign: | N/A | |
| `titleSort` | *string* | :heavy_minus_sign: | N/A | Whale | | `titleSort` | *string* | :heavy_minus_sign: | N/A | Whale |
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 | | `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |

21
docs/sdk/models/operations/getlibraryitemsmetadatarating.md
View File

@@ -1,21 +0,0 @@
# GetLibraryItemsMetaDataRating
## Example Usage
```typescript
import { GetLibraryItemsMetaDataRating } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsMetaDataRating = {
image: "themoviedb://image.rating",
value: 3,
type: "audience",
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| `image` | *string* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
| `value` | *number* | :heavy_check_mark: | The value of the rating. | 3 |
| `type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |

2
docs/sdk/models/operations/getlibraryitemsrequest.md
View File

@@ -6,7 +6,7 @@
import { GetLibraryItemsQueryParamType, GetLibraryItemsRequest, Tag } from "@lukehagar/plexjs/sdk/models/operations"; import { GetLibraryItemsQueryParamType, GetLibraryItemsRequest, Tag } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsRequest = { let value: GetLibraryItemsRequest = {
tag: Tag.Folder, tag: Tag.FirstCharacter,
type: GetLibraryItemsQueryParamType.TvShow, type: GetLibraryItemsQueryParamType.TvShow,
sectionKey: 9518, sectionKey: 9518,
}; };

18
docs/sdk/models/operations/getlibraryitemsresponse.md
View File

@@ -4,19 +4,19 @@
```typescript ```typescript
import { import {
GetLibraryItemsEnableCreditsMarkerGeneration, EnableCreditsMarkerGeneration,
GetLibraryItemsEpisodeSort, EpisodeSort,
GetLibraryItemsFlattenSeasons, FlattenSeasons,
GetLibraryItemsLibraryResponse200Type, GetLibraryItemsLibraryResponse200Type,
GetLibraryItemsLibraryType, GetLibraryItemsLibraryType,
GetLibraryItemsResponse, GetLibraryItemsResponse,
GetLibraryItemsShowOrdering, ShowOrdering,
} from "@lukehagar/plexjs/sdk/models/operations"; } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types"; import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetLibraryItemsResponse = { let value: GetLibraryItemsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 451, statusCode: 102,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),
@@ -110,11 +110,11 @@ let value: GetLibraryItemsResponse = {
year: 2022, year: 2022,
seasonCount: 2022, seasonCount: 2022,
tagline: "Return to Pandora.", tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.Show, flattenSeasons: FlattenSeasons.Show,
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst, episodeSort: EpisodeSort.OldestFirst,
enableCreditsMarkerGeneration: enableCreditsMarkerGeneration:
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault, EnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute, showOrdering: ShowOrdering.TvdbAbsolute,
thumb: "/library/metadata/58683/thumb/1703239236", thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236", art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236", banner: "/library/metadata/58683/banner/1703239236",

16
docs/sdk/models/operations/getlibraryitemsresponsebody.md
View File

@@ -6,13 +6,13 @@ The contents of the library by section and tag
```typescript ```typescript
import { import {
GetLibraryItemsEnableCreditsMarkerGeneration, EnableCreditsMarkerGeneration,
GetLibraryItemsEpisodeSort, EpisodeSort,
GetLibraryItemsFlattenSeasons, FlattenSeasons,
GetLibraryItemsLibraryResponse200Type, GetLibraryItemsLibraryResponse200Type,
GetLibraryItemsLibraryType, GetLibraryItemsLibraryType,
GetLibraryItemsResponseBody, GetLibraryItemsResponseBody,
GetLibraryItemsShowOrdering, ShowOrdering,
} from "@lukehagar/plexjs/sdk/models/operations"; } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types"; import { RFCDate } from "@lukehagar/plexjs/sdk/types";
@@ -106,11 +106,11 @@ let value: GetLibraryItemsResponseBody = {
year: 2022, year: 2022,
seasonCount: 2022, seasonCount: 2022,
tagline: "Return to Pandora.", tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.Show, flattenSeasons: FlattenSeasons.Show,
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst, episodeSort: EpisodeSort.OldestFirst,
enableCreditsMarkerGeneration: enableCreditsMarkerGeneration:
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault, EnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute, showOrdering: ShowOrdering.TvdbAbsolute,
thumb: "/library/metadata/58683/thumb/1703239236", thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236", art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236", banner: "/library/metadata/58683/banner/1703239236",

28
docs/sdk/models/operations/getlibraryitemsshowordering.md
View File

@@ -1,28 +0,0 @@
# GetLibraryItemsShowOrdering
Setting that indicates the episode ordering for the show.
None = Library default,
tmdbAiring = The Movie Database (Aired),
aired = TheTVDB (Aired),
dvd = TheTVDB (DVD),
absolute = TheTVDB (Absolute)).
## Example Usage
```typescript
import { GetLibraryItemsShowOrdering } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsShowOrdering =
GetLibraryItemsShowOrdering.TvdbAbsolute;
```
## Values
| Name | Value |
| -------------- | -------------- |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `TvdbAired` | aired |
| `TvdbDvd` | dvd |
| `TvdbAbsolute` | absolute |

6
docs/sdk/models/operations/getmediametadatalibraryoptimizedforstreaming.md
View File

@@ -5,11 +5,11 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
## Supported Types ## Supported Types
### `operations.GetMediaMetaDataOptimizedForStreaming1` ### `operations.GetMediaMetaDataOptimizedForStreamingLibrary1`
```typescript ```typescript
const value: operations.GetMediaMetaDataOptimizedForStreaming1 = const value: operations.GetMediaMetaDataOptimizedForStreamingLibrary1 =
GetMediaMetaDataOptimizedForStreaming1.One; GetMediaMetaDataOptimizedForStreamingLibrary1.One;
``` ```
### `boolean` ### `boolean`

6
docs/sdk/models/operations/getmediametadatamedia.md
View File

@@ -63,6 +63,7 @@ let value: GetMediaMetaDataMedia = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
@@ -74,6 +75,7 @@ let value: GetMediaMetaDataMedia = {
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
@@ -112,8 +114,8 @@ let value: GetMediaMetaDataMedia = {
| `container` | *string* | :heavy_minus_sign: | File container type. | mkv | | `container` | *string* | :heavy_minus_sign: | File container type. | mkv |
| `videoFrameRate` | *string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p | | `videoFrameRate` | *string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `videoProfile` | *string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 | | `videoProfile` | *string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `hasVoiceActivity` | *boolean* | :heavy_check_mark: | Indicates whether voice activity is detected. | false | | `hasVoiceActivity` | *boolean* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
| `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts | | `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `optimizedForStreaming` | *operations.GetMediaMetaDataOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | | | `optimizedForStreaming` | *operations.GetMediaMetaDataOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false | | `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
| `part` | [operations.GetMediaMetaDataPart](../../../sdk/models/operations/getmediametadatapart.md)[] | :heavy_check_mark: | An array of parts for this media item. | | | `part` | [operations.GetMediaMetaDataPart](../../../sdk/models/operations/getmediametadatapart.md)[] | :heavy_minus_sign: | An array of parts for this media item. | |

2
docs/sdk/models/operations/getmediametadatamediacontainer.md
View File

@@ -125,6 +125,7 @@ let value: GetMediaMetaDataMediaContainer = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
@@ -136,6 +137,7 @@ let value: GetMediaMetaDataMediaContainer = {
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",

6
docs/sdk/models/operations/getmediametadatametadata.md
View File

@@ -115,6 +115,7 @@ let value: GetMediaMetaDataMetadata = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
@@ -126,6 +127,7 @@ let value: GetMediaMetaDataMetadata = {
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
@@ -305,6 +307,6 @@ let value: GetMediaMetaDataMetadata = {
| `role` | [operations.GetMediaMetaDataRole](../../../sdk/models/operations/getmediametadatarole.md)[] | :heavy_minus_sign: | An array of Actor roles. | | | `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. | | | `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. | | | `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. | | | `producer` | [operations.GetMediaMetaDataProducer](../../../sdk/models/operations/getmediametadataproducer.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. | | | `similar` | [operations.GetMediaMetaDataSimilar](../../../sdk/models/operations/getmediametadatasimilar.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. | | | `location` | [operations.GetMediaMetaDataLocation](../../../sdk/models/operations/getmediametadatalocation.md)[] | :heavy_minus_sign: | An array of location objects. | |

5
docs/sdk/models/operations/getmediametadataoptimizedforstreaming.md
View File

@@ -5,10 +5,11 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
## Supported Types ## Supported Types
### `operations.OptimizedForStreaming1` ### `operations.GetMediaMetaDataOptimizedForStreaming1`
```typescript ```typescript
const value: operations.OptimizedForStreaming1 = OptimizedForStreaming1.Zero; const value: operations.GetMediaMetaDataOptimizedForStreaming1 =
GetMediaMetaDataOptimizedForStreaming1.One;
``` ```
### `boolean` ### `boolean`

2
docs/sdk/models/operations/getmediametadataoptimizedforstreaming1.md
View File

@@ -6,7 +6,7 @@
import { GetMediaMetaDataOptimizedForStreaming1 } from "@lukehagar/plexjs/sdk/models/operations"; import { GetMediaMetaDataOptimizedForStreaming1 } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaMetaDataOptimizedForStreaming1 = let value: GetMediaMetaDataOptimizedForStreaming1 =
GetMediaMetaDataOptimizedForStreaming1.One; GetMediaMetaDataOptimizedForStreaming1.Zero;
``` ```
## Values ## Values

17
docs/sdk/models/operations/getmediametadataoptimizedforstreaminglibrary1.md Normal file
View File

@@ -0,0 +1,17 @@
# GetMediaMetaDataOptimizedForStreamingLibrary1
## Example Usage
```typescript
import { GetMediaMetaDataOptimizedForStreamingLibrary1 } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaMetaDataOptimizedForStreamingLibrary1 =
GetMediaMetaDataOptimizedForStreamingLibrary1.One;
```
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

2
docs/sdk/models/operations/getmediametadatapart.md
View File

@@ -44,6 +44,7 @@ let value: GetMediaMetaDataPart = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
@@ -55,6 +56,7 @@ let value: GetMediaMetaDataPart = {
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",

28
docs/sdk/models/operations/getmediametadataproducer.md Normal file
View File

@@ -0,0 +1,28 @@
# GetMediaMetaDataProducer
## Example Usage
```typescript
import { GetMediaMetaDataProducer } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaMetaDataProducer = {
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 |

4
docs/sdk/models/operations/getmediametadataresponse.md
View File

@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetMediaMetaDataResponse = { let value: GetMediaMetaDataResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 226, statusCode: 306,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),
@@ -132,6 +132,7 @@ let value: GetMediaMetaDataResponse = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
@@ -143,6 +144,7 @@ let value: GetMediaMetaDataResponse = {
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",

2
docs/sdk/models/operations/getmediametadataresponsebody.md
View File

@@ -128,6 +128,7 @@ let value: GetMediaMetaDataResponseBody = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
@@ -139,6 +140,7 @@ let value: GetMediaMetaDataResponseBody = {
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",

21
docs/sdk/models/operations/getmediametadatasimilar.md Normal file
View File

@@ -0,0 +1,21 @@
# GetMediaMetaDataSimilar
## Example Usage
```typescript
import { GetMediaMetaDataSimilar } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaMetaDataSimilar = {
id: 26,
filter: "similar=26",
tag: "Breaking Bad",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `id` | *number* | :heavy_check_mark: | The unique similar item identifier. | 26 |
| `filter` | *string* | :heavy_check_mark: | The filter string for similar items. | similar=26 |
| `tag` | *string* | :heavy_check_mark: | The tag or title of the similar content. | Breaking Bad |

10
docs/sdk/models/operations/getmediametadatastream.md
View File

@@ -29,6 +29,7 @@ let value: GetMediaMetaDataStream = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
@@ -40,6 +41,7 @@ let value: GetMediaMetaDataStream = {
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
@@ -66,9 +68,9 @@ let value: GetMediaMetaDataStream = {
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc | | `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `index` | *number* | :heavy_check_mark: | Index of the stream. | 0 | | `index` | *number* | :heavy_check_mark: | Index of the stream. | 0 |
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 | | `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `language` | *string* | :heavy_check_mark: | Language of the stream. | English | | `language` | *string* | :heavy_minus_sign: | Language of the stream. | English |
| `languageTag` | *string* | :heavy_check_mark: | Language tag (e.g., en). | en | | `languageTag` | *string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
| `languageCode` | *string* | :heavy_check_mark: | ISO language code. | eng | | `languageCode` | *string* | :heavy_minus_sign: | ISO language code. | eng |
| `headerCompression` | *boolean* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true | | `headerCompression` | *boolean* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
| `doviblCompatID` | *number* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 | | `doviblCompatID` | *number* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
| `doviblPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true | | `doviblPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
@@ -83,6 +85,7 @@ let value: GetMediaMetaDataStream = {
| `chromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 | | `chromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
| `codedHeight` | *number* | :heavy_minus_sign: | Coded video height. | 1608 | | `codedHeight` | *number* | :heavy_minus_sign: | Coded video height. | 1608 |
| `codedWidth` | *number* | :heavy_minus_sign: | Coded video width. | 3840 | | `codedWidth` | *number* | :heavy_minus_sign: | Coded video width. | 3840 |
| `closedCaptions` | *boolean* | :heavy_minus_sign: | N/A | true |
| `colorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 | | `colorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
| `colorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv | | `colorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
| `colorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc | | `colorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc |
@@ -94,6 +97,7 @@ let value: GetMediaMetaDataStream = {
| `hasScalingMatrix` | *boolean* | :heavy_minus_sign: | N/A | false | | `hasScalingMatrix` | *boolean* | :heavy_minus_sign: | N/A | false |
| `profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 | | `profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 |
| `scanType` | *string* | :heavy_minus_sign: | N/A | progressive | | `scanType` | *string* | :heavy_minus_sign: | N/A | progressive |
| `embeddedInVideo` | *string* | :heavy_minus_sign: | N/A | progressive |
| `refFrames` | *number* | :heavy_minus_sign: | Number of reference frames. | 1 | | `refFrames` | *number* | :heavy_minus_sign: | Number of reference frames. | 1 |
| `width` | *number* | :heavy_minus_sign: | Width of the video stream. | 3840 | | `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) | | `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |

2
docs/sdk/models/operations/getmetadatachildrenrequest.md
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: 6139.66, ratingKey: 3119.45,
}; };
``` ```

2
docs/sdk/models/operations/getmetadatachildrenresponse.md
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: 305, statusCode: 202,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

17
docs/sdk/models/operations/getondeckguids.md
View File

@@ -1,17 +0,0 @@
# GetOnDeckGuids
## Example Usage
```typescript
import { GetOnDeckGuids } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetOnDeckGuids = {
id: "imdb://tt13303712",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *string* | :heavy_minus_sign: | N/A | imdb://tt13303712 |

82
docs/sdk/models/operations/getondeckmedia.md
View File

@@ -1,82 +0,0 @@
# GetOnDeckMedia
## Example Usage
```typescript
import { GetOnDeckMedia } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetOnDeckMedia = {
id: 80994,
duration: 420080,
bitrate: 1046,
width: 1920,
height: 1080,
aspectRatio: 1.78,
audioChannels: 2,
audioCodec: "aac",
videoCodec: "hevc",
videoResolution: "1080",
container: "mkv",
videoFrameRate: "PAL",
audioProfile: "lc",
videoProfile: "main",
part: [
{
id: 80994,
key: "/library/parts/80994/1655007810/file.mkv",
duration: 420080,
file: "/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv",
size: 55148931,
audioProfile: "lc",
container: "mkv",
videoProfile: "main",
stream: [
{
id: 211234,
streamType: 1,
codec: "hevc",
index: 0,
bitrate: 918,
language: "English",
languageTag: "en",
languageCode: "eng",
bitDepth: 8,
chromaLocation: "left",
chromaSubsampling: "4:2:0",
codedHeight: 1080,
codedWidth: 1920,
colorRange: "tv",
frameRate: 25,
height: 1080,
level: 120,
profile: "main",
refFrames: 1,
width: 1920,
displayTitle: "1080p (HEVC Main)",
extendedDisplayTitle: "1080p (HEVC Main)",
},
],
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 80994 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 420080 |
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 1046 |
| `width` | *number* | :heavy_minus_sign: | N/A | 1920 |
| `height` | *number* | :heavy_minus_sign: | N/A | 1080 |
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 1.78 |
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 2 |
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | aac |
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | hevc |
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 1080 |
| `container` | *string* | :heavy_minus_sign: | N/A | mkv |
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | PAL |
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main |
| `part` | [operations.GetOnDeckPart](../../../sdk/models/operations/getondeckpart.md)[] | :heavy_minus_sign: | N/A | |

125
docs/sdk/models/operations/getondeckmediacontainer.md
View File

@@ -1,125 +0,0 @@
# GetOnDeckMediaContainer
## Example Usage
```typescript
import { GetOnDeckMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetOnDeckMediaContainer = {
size: 16,
identifier: "com.plexapp.plugins.library",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1680021154,
metadata: [
{
librarySectionID: 2,
librarySectionTitle: "TV Shows",
librarySectionUUID: "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd",
ratingKey: 49564,
key: "/library/metadata/49564",
parentRatingKey: 49557,
grandparentRatingKey: 49556,
guid: "plex://episode/5ea7d7402e7ab10042e74d4f",
parentGuid: "plex://season/602e754d67f4c8002ce54b3d",
grandparentGuid: "plex://show/5d9c090e705e7a001e6e94d8",
type: "episode",
title: "Circus",
grandparentKey: "/library/metadata/49556",
parentKey: "/library/metadata/49557",
librarySectionKey: "/library/sections/2",
grandparentTitle: "Bluey (2018)",
parentTitle: "Season 2",
contentRating: "TV-Y",
summary:
"Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy.",
index: 33,
parentIndex: 2,
lastViewedAt: 1681908352,
year: 2018,
thumb: "/library/metadata/49564/thumb/1654258204",
art: "/library/metadata/49556/art/1680939546",
parentThumb: "/library/metadata/49557/thumb/1654258204",
grandparentThumb: "/library/metadata/49556/thumb/1680939546",
grandparentArt: "/library/metadata/49556/art/1680939546",
grandparentTheme: "/library/metadata/49556/theme/1680939546",
duration: 420080,
originallyAvailableAt: new Date("2020-10-31T00:00:00Z"),
addedAt: 1654258196,
updatedAt: 1654258204,
media: [
{
id: 80994,
duration: 420080,
bitrate: 1046,
width: 1920,
height: 1080,
aspectRatio: 1.78,
audioChannels: 2,
audioCodec: "aac",
videoCodec: "hevc",
videoResolution: "1080",
container: "mkv",
videoFrameRate: "PAL",
audioProfile: "lc",
videoProfile: "main",
part: [
{
id: 80994,
key: "/library/parts/80994/1655007810/file.mkv",
duration: 420080,
file: "/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv",
size: 55148931,
audioProfile: "lc",
container: "mkv",
videoProfile: "main",
stream: [
{
id: 211234,
streamType: 1,
codec: "hevc",
index: 0,
bitrate: 918,
language: "English",
languageTag: "en",
languageCode: "eng",
bitDepth: 8,
chromaLocation: "left",
chromaSubsampling: "4:2:0",
codedHeight: 1080,
codedWidth: 1920,
colorRange: "tv",
frameRate: 25,
height: 1080,
level: 120,
profile: "main",
refFrames: 1,
width: 1920,
displayTitle: "1080p (HEVC Main)",
extendedDisplayTitle: "1080p (HEVC Main)",
},
],
},
],
},
],
guids: [
{
id: "imdb://tt13303712",
},
],
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `size` | *number* | :heavy_minus_sign: | N/A | 16 |
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | |
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `mediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *number* | :heavy_minus_sign: | N/A | 1680021154 |
| `mixedParents` | *boolean* | :heavy_minus_sign: | N/A | |
| `metadata` | [operations.GetOnDeckMetadata](../../../sdk/models/operations/getondeckmetadata.md)[] | :heavy_minus_sign: | N/A | |

146
docs/sdk/models/operations/getondeckmetadata.md
View File

@@ -1,146 +0,0 @@
# GetOnDeckMetadata
## Example Usage
```typescript
import { GetOnDeckMetadata } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetOnDeckMetadata = {
librarySectionID: 2,
librarySectionTitle: "TV Shows",
librarySectionUUID: "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd",
ratingKey: 49564,
key: "/library/metadata/49564",
parentRatingKey: 49557,
grandparentRatingKey: 49556,
guid: "plex://episode/5ea7d7402e7ab10042e74d4f",
parentGuid: "plex://season/602e754d67f4c8002ce54b3d",
grandparentGuid: "plex://show/5d9c090e705e7a001e6e94d8",
type: "episode",
title: "Circus",
grandparentKey: "/library/metadata/49556",
parentKey: "/library/metadata/49557",
librarySectionKey: "/library/sections/2",
grandparentTitle: "Bluey (2018)",
parentTitle: "Season 2",
contentRating: "TV-Y",
summary:
"Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy.",
index: 33,
parentIndex: 2,
lastViewedAt: 1681908352,
year: 2018,
thumb: "/library/metadata/49564/thumb/1654258204",
art: "/library/metadata/49556/art/1680939546",
parentThumb: "/library/metadata/49557/thumb/1654258204",
grandparentThumb: "/library/metadata/49556/thumb/1680939546",
grandparentArt: "/library/metadata/49556/art/1680939546",
grandparentTheme: "/library/metadata/49556/theme/1680939546",
duration: 420080,
originallyAvailableAt: new Date("2020-10-31T00:00:00Z"),
addedAt: 1654258196,
updatedAt: 1654258204,
media: [
{
id: 80994,
duration: 420080,
bitrate: 1046,
width: 1920,
height: 1080,
aspectRatio: 1.78,
audioChannels: 2,
audioCodec: "aac",
videoCodec: "hevc",
videoResolution: "1080",
container: "mkv",
videoFrameRate: "PAL",
audioProfile: "lc",
videoProfile: "main",
part: [
{
id: 80994,
key: "/library/parts/80994/1655007810/file.mkv",
duration: 420080,
file: "/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv",
size: 55148931,
audioProfile: "lc",
container: "mkv",
videoProfile: "main",
stream: [
{
id: 211234,
streamType: 1,
codec: "hevc",
index: 0,
bitrate: 918,
language: "English",
languageTag: "en",
languageCode: "eng",
bitDepth: 8,
chromaLocation: "left",
chromaSubsampling: "4:2:0",
codedHeight: 1080,
codedWidth: 1920,
colorRange: "tv",
frameRate: 25,
height: 1080,
level: 120,
profile: "main",
refFrames: 1,
width: 1920,
displayTitle: "1080p (HEVC Main)",
extendedDisplayTitle: "1080p (HEVC Main)",
},
],
},
],
},
],
guids: [
{
id: "imdb://tt13303712",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | |
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 2 |
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | TV Shows |
| `librarySectionUUID` | *string* | :heavy_minus_sign: | N/A | 4bb2521c-8ba9-459b-aaee-8ab8bc35eabd |
| `ratingKey` | *number* | :heavy_minus_sign: | N/A | 49564 |
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/49564 |
| `parentRatingKey` | *number* | :heavy_minus_sign: | N/A | 49557 |
| `grandparentRatingKey` | *number* | :heavy_minus_sign: | N/A | 49556 |
| `guid` | *string* | :heavy_minus_sign: | N/A | plex://episode/5ea7d7402e7ab10042e74d4f |
| `parentGuid` | *string* | :heavy_minus_sign: | N/A | plex://season/602e754d67f4c8002ce54b3d |
| `grandparentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c090e705e7a001e6e94d8 |
| `type` | *string* | :heavy_minus_sign: | N/A | episode |
| `title` | *string* | :heavy_minus_sign: | N/A | Circus |
| `grandparentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/49556 |
| `parentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/49557 |
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/2 |
| `grandparentTitle` | *string* | :heavy_minus_sign: | N/A | Bluey (2018) |
| `parentTitle` | *string* | :heavy_minus_sign: | N/A | Season 2 |
| `contentRating` | *string* | :heavy_minus_sign: | N/A | TV-Y |
| `summary` | *string* | :heavy_minus_sign: | N/A | Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy. |
| `index` | *number* | :heavy_minus_sign: | N/A | 33 |
| `parentIndex` | *number* | :heavy_minus_sign: | N/A | 2 |
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1681908352 |
| `year` | *number* | :heavy_minus_sign: | N/A | 2018 |
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/49564/thumb/1654258204 |
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/49556/art/1680939546 |
| `parentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/49557/thumb/1654258204 |
| `grandparentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/49556/thumb/1680939546 |
| `grandparentArt` | *string* | :heavy_minus_sign: | N/A | /library/metadata/49556/art/1680939546 |
| `grandparentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/49556/theme/1680939546 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 420080 |
| `originallyAvailableAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | 2020-10-31 00:00:00 +0000 UTC |
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1654258196 |
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1654258204 |
| `media` | [operations.GetOnDeckMedia](../../../sdk/models/operations/getondeckmedia.md)[] | :heavy_minus_sign: | N/A | |
| `guids` | [operations.GetOnDeckGuids](../../../sdk/models/operations/getondeckguids.md)[] | :heavy_minus_sign: | N/A | |

58
docs/sdk/models/operations/getondeckpart.md
View File

@@ -1,58 +0,0 @@
# GetOnDeckPart
## Example Usage
```typescript
import { GetOnDeckPart } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetOnDeckPart = {
id: 80994,
key: "/library/parts/80994/1655007810/file.mkv",
duration: 420080,
file: "/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv",
size: 55148931,
audioProfile: "lc",
container: "mkv",
videoProfile: "main",
stream: [
{
id: 211234,
streamType: 1,
codec: "hevc",
index: 0,
bitrate: 918,
language: "English",
languageTag: "en",
languageCode: "eng",
bitDepth: 8,
chromaLocation: "left",
chromaSubsampling: "4:2:0",
codedHeight: 1080,
codedWidth: 1920,
colorRange: "tv",
frameRate: 25,
height: 1080,
level: 120,
profile: "main",
refFrames: 1,
width: 1920,
displayTitle: "1080p (HEVC Main)",
extendedDisplayTitle: "1080p (HEVC Main)",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 80994 |
| `key` | *string* | :heavy_minus_sign: | N/A | /library/parts/80994/1655007810/file.mkv |
| `duration` | *number* | :heavy_minus_sign: | N/A | 420080 |
| `file` | *string* | :heavy_minus_sign: | N/A | /tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv |
| `size` | *number* | :heavy_minus_sign: | N/A | 55148931 |
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
| `container` | *string* | :heavy_minus_sign: | N/A | mkv |
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main |
| `stream` | [operations.GetOnDeckStream](../../../sdk/models/operations/getondeckstream.md)[] | :heavy_minus_sign: | N/A | |

132
docs/sdk/models/operations/getondeckresponse.md
View File

@@ -1,132 +0,0 @@
# GetOnDeckResponse
## Example Usage
```typescript
import { GetOnDeckResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetOnDeckResponse = {
contentType: "<value>",
statusCode: 202,
rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 16,
identifier: "com.plexapp.plugins.library",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1680021154,
metadata: [
{
librarySectionID: 2,
librarySectionTitle: "TV Shows",
librarySectionUUID: "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd",
ratingKey: 49564,
key: "/library/metadata/49564",
parentRatingKey: 49557,
grandparentRatingKey: 49556,
guid: "plex://episode/5ea7d7402e7ab10042e74d4f",
parentGuid: "plex://season/602e754d67f4c8002ce54b3d",
grandparentGuid: "plex://show/5d9c090e705e7a001e6e94d8",
type: "episode",
title: "Circus",
grandparentKey: "/library/metadata/49556",
parentKey: "/library/metadata/49557",
librarySectionKey: "/library/sections/2",
grandparentTitle: "Bluey (2018)",
parentTitle: "Season 2",
contentRating: "TV-Y",
summary:
"Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy.",
index: 33,
parentIndex: 2,
lastViewedAt: 1681908352,
year: 2018,
thumb: "/library/metadata/49564/thumb/1654258204",
art: "/library/metadata/49556/art/1680939546",
parentThumb: "/library/metadata/49557/thumb/1654258204",
grandparentThumb: "/library/metadata/49556/thumb/1680939546",
grandparentArt: "/library/metadata/49556/art/1680939546",
grandparentTheme: "/library/metadata/49556/theme/1680939546",
duration: 420080,
originallyAvailableAt: new Date("2020-10-31T00:00:00Z"),
addedAt: 1654258196,
updatedAt: 1654258204,
media: [
{
id: 80994,
duration: 420080,
bitrate: 1046,
width: 1920,
height: 1080,
aspectRatio: 1.78,
audioChannels: 2,
audioCodec: "aac",
videoCodec: "hevc",
videoResolution: "1080",
container: "mkv",
videoFrameRate: "PAL",
audioProfile: "lc",
videoProfile: "main",
part: [
{
id: 80994,
key: "/library/parts/80994/1655007810/file.mkv",
duration: 420080,
file:
"/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv",
size: 55148931,
audioProfile: "lc",
container: "mkv",
videoProfile: "main",
stream: [
{
id: 211234,
streamType: 1,
codec: "hevc",
index: 0,
bitrate: 918,
language: "English",
languageTag: "en",
languageCode: "eng",
bitDepth: 8,
chromaLocation: "left",
chromaSubsampling: "4:2:0",
codedHeight: 1080,
codedWidth: 1920,
colorRange: "tv",
frameRate: 25,
height: 1080,
level: 120,
profile: "main",
refFrames: 1,
width: 1920,
displayTitle: "1080p (HEVC Main)",
extendedDisplayTitle: "1080p (HEVC Main)",
},
],
},
],
},
],
guids: [
{
id: "imdb://tt13303712",
},
],
},
],
},
},
};
```
## 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.GetOnDeckResponseBody](../../../sdk/models/operations/getondeckresponsebody.md) | :heavy_minus_sign: | The on Deck content |

124
docs/sdk/models/operations/getondeckresponsebody.md
View File

@@ -1,124 +0,0 @@
# GetOnDeckResponseBody
The on Deck content
## Example Usage
```typescript
import { GetOnDeckResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetOnDeckResponseBody = {
mediaContainer: {
size: 16,
identifier: "com.plexapp.plugins.library",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1680021154,
metadata: [
{
librarySectionID: 2,
librarySectionTitle: "TV Shows",
librarySectionUUID: "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd",
ratingKey: 49564,
key: "/library/metadata/49564",
parentRatingKey: 49557,
grandparentRatingKey: 49556,
guid: "plex://episode/5ea7d7402e7ab10042e74d4f",
parentGuid: "plex://season/602e754d67f4c8002ce54b3d",
grandparentGuid: "plex://show/5d9c090e705e7a001e6e94d8",
type: "episode",
title: "Circus",
grandparentKey: "/library/metadata/49556",
parentKey: "/library/metadata/49557",
librarySectionKey: "/library/sections/2",
grandparentTitle: "Bluey (2018)",
parentTitle: "Season 2",
contentRating: "TV-Y",
summary:
"Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy.",
index: 33,
parentIndex: 2,
lastViewedAt: 1681908352,
year: 2018,
thumb: "/library/metadata/49564/thumb/1654258204",
art: "/library/metadata/49556/art/1680939546",
parentThumb: "/library/metadata/49557/thumb/1654258204",
grandparentThumb: "/library/metadata/49556/thumb/1680939546",
grandparentArt: "/library/metadata/49556/art/1680939546",
grandparentTheme: "/library/metadata/49556/theme/1680939546",
duration: 420080,
originallyAvailableAt: new Date("2020-10-31T00:00:00Z"),
addedAt: 1654258196,
updatedAt: 1654258204,
media: [
{
id: 80994,
duration: 420080,
bitrate: 1046,
width: 1920,
height: 1080,
aspectRatio: 1.78,
audioChannels: 2,
audioCodec: "aac",
videoCodec: "hevc",
videoResolution: "1080",
container: "mkv",
videoFrameRate: "PAL",
audioProfile: "lc",
videoProfile: "main",
part: [
{
id: 80994,
key: "/library/parts/80994/1655007810/file.mkv",
duration: 420080,
file:
"/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv",
size: 55148931,
audioProfile: "lc",
container: "mkv",
videoProfile: "main",
stream: [
{
id: 211234,
streamType: 1,
codec: "hevc",
index: 0,
bitrate: 918,
language: "English",
languageTag: "en",
languageCode: "eng",
bitDepth: 8,
chromaLocation: "left",
chromaSubsampling: "4:2:0",
codedHeight: 1080,
codedWidth: 1920,
colorRange: "tv",
frameRate: 25,
height: 1080,
level: 120,
profile: "main",
refFrames: 1,
width: 1920,
displayTitle: "1080p (HEVC Main)",
extendedDisplayTitle: "1080p (HEVC Main)",
},
],
},
],
},
],
guids: [
{
id: "imdb://tt13303712",
},
],
},
],
},
};
```
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.GetOnDeckMediaContainer](../../../sdk/models/operations/getondeckmediacontainer.md) | :heavy_minus_sign: | N/A |

60
docs/sdk/models/operations/getondeckstream.md
View File

@@ -1,60 +0,0 @@
# GetOnDeckStream
## Example Usage
```typescript
import { GetOnDeckStream } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetOnDeckStream = {
id: 211234,
streamType: 1,
codec: "hevc",
index: 0,
bitrate: 918,
language: "English",
languageTag: "en",
languageCode: "eng",
bitDepth: 8,
chromaLocation: "left",
chromaSubsampling: "4:2:0",
codedHeight: 1080,
codedWidth: 1920,
colorRange: "tv",
frameRate: 25,
height: 1080,
level: 120,
profile: "main",
refFrames: 1,
width: 1920,
displayTitle: "1080p (HEVC Main)",
extendedDisplayTitle: "1080p (HEVC Main)",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 211234 |
| `streamType` | *number* | :heavy_minus_sign: | N/A | 1 |
| `default` | *boolean* | :heavy_minus_sign: | N/A | |
| `codec` | *string* | :heavy_minus_sign: | N/A | hevc |
| `index` | *number* | :heavy_minus_sign: | N/A | 0 |
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 918 |
| `language` | *string* | :heavy_minus_sign: | N/A | English |
| `languageTag` | *string* | :heavy_minus_sign: | N/A | en |
| `languageCode` | *string* | :heavy_minus_sign: | N/A | eng |
| `bitDepth` | *number* | :heavy_minus_sign: | N/A | 8 |
| `chromaLocation` | *string* | :heavy_minus_sign: | N/A | left |
| `chromaSubsampling` | *string* | :heavy_minus_sign: | N/A | 4:2:0 |
| `codedHeight` | *number* | :heavy_minus_sign: | N/A | 1080 |
| `codedWidth` | *number* | :heavy_minus_sign: | N/A | 1920 |
| `colorRange` | *string* | :heavy_minus_sign: | N/A | tv |
| `frameRate` | *number* | :heavy_minus_sign: | N/A | 25 |
| `height` | *number* | :heavy_minus_sign: | N/A | 1080 |
| `level` | *number* | :heavy_minus_sign: | N/A | 120 |
| `profile` | *string* | :heavy_minus_sign: | N/A | main |
| `refFrames` | *number* | :heavy_minus_sign: | N/A | 1 |
| `width` | *number* | :heavy_minus_sign: | N/A | 1920 |
| `displayTitle` | *string* | :heavy_minus_sign: | N/A | 1080p (HEVC Main) |
| `extendedDisplayTitle` | *string* | :heavy_minus_sign: | N/A | 1080p (HEVC Main) |

2
docs/sdk/models/operations/getplaylistcontentsrequest.md
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: 2539.41, playlistID: 5182.01,
type: GetPlaylistContentsQueryParamType.TvShow, type: GetPlaylistContentsQueryParamType.TvShow,
}; };
``` ```

2
docs/sdk/models/operations/getplaylistcontentsresponse.md
View File

@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetPlaylistContentsResponse = { let value: GetPlaylistContentsResponse = {
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" },
}), }),

2
docs/sdk/models/operations/getplaylistrequest.md
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: 8726.51, playlistID: 7980.47,
}; };
``` ```

2
docs/sdk/models/operations/getplaylistresponse.md
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: 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" },
}), }),

2
docs/sdk/models/operations/getplaylistsresponse.md
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: 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" },
}), }),

2
docs/sdk/models/operations/getrecentlyaddedlibraryresponse.md
View File

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

430
docs/sdk/models/operations/getrecentlyaddedmediacontainer.md
View File

@@ -4,20 +4,18 @@
```typescript ```typescript
import { import {
EnableCreditsMarkerGeneration,
EpisodeSort,
FlattenSeasons,
GetRecentlyAddedHubsResponseType, GetRecentlyAddedHubsResponseType,
GetRecentlyAddedHubsType, GetRecentlyAddedHubsType,
GetRecentlyAddedMediaContainer, GetRecentlyAddedMediaContainer,
ShowOrdering,
} from "@lukehagar/plexjs/sdk/models/operations"; } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types"; import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetRecentlyAddedMediaContainer = { let value: GetRecentlyAddedMediaContainer = {
size: 50, size: 50,
identifier: "com.plexapp.plugins.library", totalSize: 50,
offset: 0,
allowSync: false, allowSync: false,
identifier: "com.plexapp.plugins.library",
meta: { meta: {
type: [ type: [
{ {
@@ -70,172 +68,76 @@ let value: GetRecentlyAddedMediaContainer = {
}, },
metadata: [ metadata: [
{ {
ratingKey: "58683",
key: "/library/metadata/58683",
guid: "plex://movie/5d7768ba96b655001fdc0408",
studio: "20th Century Studios",
skipChildren: false,
librarySectionID: 1,
librarySectionTitle: "Movies",
librarySectionKey: "/library/sections/1",
type: GetRecentlyAddedHubsType.Movie,
title: "Avatar: The Way of Water",
slug: "4-for-texas",
contentRating: "PG-13",
summary:
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.",
rating: 7.6,
audienceRating: 9.2,
year: 2022,
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: FlattenSeasons.Show,
episodeSort: EpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
EnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: ShowOrdering.TvdbAbsolute,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236",
duration: 11558112,
originallyAvailableAt: new RFCDate("2022-12-14T00:00:00Z"),
addedAt: 1556281940, addedAt: 1556281940,
updatedAt: 1556281940, art: "/library/metadata/58683/art/1703239236",
audienceRatingImage: "rottentomatoes://image.rating.upright", audienceRatingImage: "rottentomatoes://image.rating.upright",
audienceRating: 9.2,
chapterSource: "media", chapterSource: "media",
primaryExtraKey: "/library/metadata/58684", childCount: 1,
ratingImage: "rottentomatoes://image.rating.ripe", contentRating: "PG-13",
grandparentRatingKey: "66", createdAtAccuracy: "epoch,local",
createdAtTZOffset: "0",
duration: 11558112,
grandparentArt: "/library/metadata/66/art/1705716261",
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4", grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
grandparentKey: "/library/metadata/66", grandparentKey: "/library/metadata/66",
grandparentTitle: "Caprica", grandparentRatingKey: "66",
grandparentThumb: "/library/metadata/66/thumb/1705716261",
parentSlug: "alice-in-borderland-2020",
grandparentSlug: "alice-in-borderland-2020", grandparentSlug: "alice-in-borderland-2020",
grandparentArt: "/library/metadata/66/art/1705716261",
grandparentTheme: "/library/metadata/66/theme/1705716261", grandparentTheme: "/library/metadata/66/theme/1705716261",
media: [ grandparentThumb: "/library/metadata/66/thumb/1705716261",
grandparentTitle: "Caprica",
guid: "plex://movie/5d7768ba96b655001fdc0408",
index: 1,
key: "/library/metadata/58683",
lastRatedAt: 1721813113,
lastViewedAt: 1682752242,
leafCount: 14,
librarySectionID: 1,
librarySectionKey: "/library/sections/1",
librarySectionTitle: "Movies",
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
originallyAvailableAt: new RFCDate("2022-12-14"),
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
parentIndex: 1,
parentKey: "/library/metadata/66",
parentRatingKey: "66",
parentSlug: "alice-in-borderland-2020",
parentStudio: "UCP",
parentTheme: "/library/metadata/66/theme/1705716261",
parentThumb: "/library/metadata/66/thumb/1705716261",
parentTitle: "Caprica",
parentYear: 2010,
primaryExtraKey: "/library/metadata/58684",
ratingImage: "rottentomatoes://image.rating.ripe",
ratingKey: "58683",
rating: 7.6,
seasonCount: 2022,
skipCount: 1,
slug: "4-for-texas",
studio: "20th Century Studios",
subtype: "clip",
summary:
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
+ "",
tagline: "Return to Pandora.",
theme: "/library/metadata/1/theme/1705636920",
thumb: "/library/metadata/58683/thumb/1703239236",
titleSort: "Whale",
title: "Avatar: The Way of Water",
type: GetRecentlyAddedHubsType.Movie,
updatedAt: 1556281940,
userRating: 10,
viewCount: 1,
viewOffset: 5222500,
viewedLeafCount: 0,
year: 2022,
image: [
{ {
id: 119534, alt: "Episode 1",
duration: 11558112, type: GetRecentlyAddedHubsResponseType.Background,
bitrate: 25025, url: "/library/metadata/45521/thumb/1644710589",
width: 3840,
height: 2072,
aspectRatio: 1.85,
audioProfile: "dts",
audioChannels: 6,
audioCodec: "eac3",
videoCodec: "hevc",
videoResolution: "4k",
container: "mkv",
videoFrameRate: "24p",
videoProfile: "main 10",
hasVoiceActivity: false,
has64bitOffsets: false,
part: [
{
id: 119542,
key: "/library/parts/119542/1680457526/file.mkv",
duration: 11558112,
file:
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
size: 36158371307,
container: "mkv",
audioProfile: "dts",
has64bitOffsets: false,
optimizedForStreaming: false,
videoProfile: "main 10",
indexes: "sd",
stream: [
{
id: 272796,
streamType: 1,
default: true,
selected: true,
codec: "h264",
index: 0,
bitrate: 6273,
colorPrimaries: "bt709",
colorRange: "tv",
colorSpace: "bt709",
colorTrc: "bt709",
bitDepth: 8,
chromaLocation: "left",
streamIdentifier: "2",
chromaSubsampling: "4:2:0",
codedHeight: 1088,
codedWidth: 1920,
frameRate: 29.97,
hasScalingMatrix: false,
hearingImpaired: false,
closedCaptions: false,
embeddedInVideo: "1",
height: 1080,
level: 40,
profile: "main",
refFrames: 4,
scanType: "progressive",
width: 1920,
displayTitle: "1080p (H.264)",
extendedDisplayTitle: "1080p (H.264)",
channels: 2,
language: "English",
languageTag: "en",
languageCode: "eng",
audioChannelLayout: "stereo",
samplingRate: 48000,
title: "English",
canAutoSync: false,
},
],
},
],
},
],
genre: [
{
tag: "Adventure",
},
],
country: [
{
tag: "United States of America",
},
],
director: [
{
tag: "James Cameron",
},
],
writer: [
{
tag: "James Cameron",
},
],
collection: [
{
tag: "Working NL Subs",
},
],
role: [
{
id: 294129,
filter: "actor=294129",
thumb:
"https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg",
tag: "Mike Smith",
tagKey: "668e7e7b22bcad9064350c91",
role: "Self",
},
],
location: [
{
path: "/TV Shows/House",
},
],
mediaGuid: [
{
id: "imdb://tt13015952",
}, },
], ],
ultraBlurColors: { ultraBlurColors: {
@@ -244,42 +146,174 @@ let value: GetRecentlyAddedMediaContainer = {
bottomRight: "73958", bottomRight: "73958",
bottomLeft: "1f5066", bottomLeft: "1f5066",
}, },
metaDataRating: [ media: [
{ {
image: "themoviedb://image.rating", id: 387322,
value: 3, duration: 9610350,
bitrate: 25512,
width: 3840,
height: 1602,
aspectRatio: 2.35,
audioChannels: 6,
displayOffset: 50,
audioCodec: "eac3",
videoCodec: "hevc",
videoResolution: "4k",
container: "mkv",
videoFrameRate: "24p",
videoProfile: "main 10",
hasVoiceActivity: false,
audioProfile: "dts",
has64bitOffsets: false,
part: [
{
accessible: true,
exists: true,
id: 418385,
key: "/library/parts/418385/1735864239/file.mkv",
indexes: "sd",
duration: 9610350,
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
size: 30649952104,
packetLength: 188,
container: "mkv",
videoProfile: "main 10",
audioProfile: "dts",
has64bitOffsets: false,
stream: [
{
id: 1002625,
streamType: 1,
default: true,
codec: "hevc",
index: 0,
bitrate: 24743,
language: "English",
languageTag: "en",
languageCode: "eng",
headerCompression: true,
doviblCompatID: 1,
doviblPresent: true,
dovielPresent: false,
doviLevel: 6,
doviPresent: true,
doviProfile: 8,
dovirpuPresent: true,
doviVersion: "1.0",
bitDepth: 10,
chromaLocation: "topleft",
chromaSubsampling: "4:2:0",
codedHeight: 1608,
codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020",
colorRange: "tv",
colorSpace: "bt2020nc",
colorTrc: "smpte2084",
frameRate: 23.976,
height: 1602,
level: 150,
original: true,
hasScalingMatrix: false,
profile: "main 10",
scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1,
width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
selected: true,
forced: true,
channels: 6,
audioChannelLayout: "5.1(side)",
samplingRate: 48000,
canAutoSync: false,
hearingImpaired: true,
dub: true,
title: "SDH",
},
],
},
],
},
],
genre: [
{
id: 259,
filter: "genre=19",
tag: "Crime",
},
],
country: [
{
id: 259,
tag: "United States of America",
filter: "country=19",
},
],
director: [
{
tag: "Danny Boyle",
},
],
writer: [
{
id: 126522,
filter: "writer=126522",
tag: "Jamie P. Hanson",
tagKey: "5d77683d85719b001f3a535e",
},
],
role: [
{
id: 126522,
filter: "actor=126522",
tag: "Teller",
tagKey: "5d77683d85719b001f3a535e",
role: "Self - Judge",
thumb:
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
},
],
producer: [
{
id: 126522,
filter: "producer=126522",
tag: "Amelia Knapp",
tagKey: "5d77683d85719b001f3a535e",
thumb:
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
},
],
rating1: [
{
image: "imdb://image.rating",
value: 5.1,
type: "audience", type: "audience",
}, },
], ],
image: [ similar: [
{ {
alt: "Episode 1", id: 259,
type: GetRecentlyAddedHubsResponseType.Background, filter: "similar=259",
url: "/library/metadata/45521/thumb/1644710589", tag: "Criss Angel Mindfreak",
},
],
location: [
{
path: "/TV Shows/Clarkson's Farm",
},
],
guids: [
{
id: "tvdb://2337",
},
],
collection: [
{
tag: "My Awesome Collection",
}, },
], ],
titleSort: "Whale",
viewCount: 1,
lastViewedAt: 1682752242,
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
viewOffset: 5222500,
skipCount: 1,
index: 1,
theme: "/library/metadata/1/theme/1705636920",
leafCount: 14,
viewedLeafCount: 0,
childCount: 1,
hasPremiumExtras: "1",
hasPremiumPrimaryExtra: "1",
parentRatingKey: "66",
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
parentStudio: "UCP",
parentKey: "/library/metadata/66",
parentTitle: "Caprica",
parentIndex: 1,
parentYear: 2010,
parentThumb: "/library/metadata/66/thumb/1705716261",
parentTheme: "/library/metadata/66/theme/1705716261",
}, },
], ],
}; };
@@ -289,10 +323,10 @@ let value: GetRecentlyAddedMediaContainer = {
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `size` | *number* | :heavy_check_mark: | N/A | 50 | | `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `offset` | *number* | :heavy_minus_sign: | N/A | | | `totalSize` | *number* | :heavy_check_mark: | Total number of media items in the library. | 50 |
| `totalSize` | *number* | :heavy_minus_sign: | N/A | | | `offset` | *number* | :heavy_check_mark: | Offset value for pagination. | 0 |
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library | | `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | false | | `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `meta` | [operations.Meta](../../../sdk/models/operations/meta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | | | `meta` | [operations.Meta](../../../sdk/models/operations/meta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
| `metadata` | [operations.GetRecentlyAddedMetadata](../../../sdk/models/operations/getrecentlyaddedmetadata.md)[] | :heavy_minus_sign: | N/A | | | `metadata` | [operations.GetRecentlyAddedMetadata](../../../sdk/models/operations/getrecentlyaddedmetadata.md)[] | :heavy_minus_sign: | An array of metadata items. | |

571
docs/sdk/models/operations/getrecentlyaddedmetadata.md
View File

@@ -1,185 +1,89 @@
# GetRecentlyAddedMetadata # GetRecentlyAddedMetadata
Unknown
## Example Usage ## Example Usage
```typescript ```typescript
import { import {
EnableCreditsMarkerGeneration,
EpisodeSort,
FlattenSeasons,
GetRecentlyAddedHubsResponseType, GetRecentlyAddedHubsResponseType,
GetRecentlyAddedHubsType, GetRecentlyAddedHubsType,
GetRecentlyAddedMetadata, GetRecentlyAddedMetadata,
ShowOrdering,
} from "@lukehagar/plexjs/sdk/models/operations"; } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types"; import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetRecentlyAddedMetadata = { let value: GetRecentlyAddedMetadata = {
ratingKey: "58683",
key: "/library/metadata/58683",
guid: "plex://movie/5d7768ba96b655001fdc0408",
studio: "20th Century Studios",
skipChildren: false,
librarySectionID: 1,
librarySectionTitle: "Movies",
librarySectionKey: "/library/sections/1",
type: GetRecentlyAddedHubsType.Movie,
title: "Avatar: The Way of Water",
slug: "4-for-texas",
contentRating: "PG-13",
summary:
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.",
rating: 7.6,
audienceRating: 9.2,
year: 2022,
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: FlattenSeasons.Show,
episodeSort: EpisodeSort.OldestFirst,
enableCreditsMarkerGeneration: EnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: ShowOrdering.TvdbAbsolute,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236",
duration: 11558112,
originallyAvailableAt: new RFCDate("2022-12-14T00:00:00Z"),
addedAt: 1556281940, addedAt: 1556281940,
updatedAt: 1556281940, art: "/library/metadata/58683/art/1703239236",
audienceRatingImage: "rottentomatoes://image.rating.upright", audienceRatingImage: "rottentomatoes://image.rating.upright",
audienceRating: 9.2,
chapterSource: "media", chapterSource: "media",
primaryExtraKey: "/library/metadata/58684", childCount: 1,
ratingImage: "rottentomatoes://image.rating.ripe", contentRating: "PG-13",
grandparentRatingKey: "66", createdAtAccuracy: "epoch,local",
createdAtTZOffset: "0",
duration: 11558112,
grandparentArt: "/library/metadata/66/art/1705716261",
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4", grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
grandparentKey: "/library/metadata/66", grandparentKey: "/library/metadata/66",
grandparentTitle: "Caprica", grandparentRatingKey: "66",
grandparentThumb: "/library/metadata/66/thumb/1705716261",
parentSlug: "alice-in-borderland-2020",
grandparentSlug: "alice-in-borderland-2020", grandparentSlug: "alice-in-borderland-2020",
grandparentArt: "/library/metadata/66/art/1705716261",
grandparentTheme: "/library/metadata/66/theme/1705716261", grandparentTheme: "/library/metadata/66/theme/1705716261",
media: [ grandparentThumb: "/library/metadata/66/thumb/1705716261",
grandparentTitle: "Caprica",
guid: "plex://movie/5d7768ba96b655001fdc0408",
index: 1,
key: "/library/metadata/58683",
lastRatedAt: 1721813113,
lastViewedAt: 1682752242,
leafCount: 14,
librarySectionID: 1,
librarySectionKey: "/library/sections/1",
librarySectionTitle: "Movies",
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
originallyAvailableAt: new RFCDate("2022-12-14"),
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
parentIndex: 1,
parentKey: "/library/metadata/66",
parentRatingKey: "66",
parentSlug: "alice-in-borderland-2020",
parentStudio: "UCP",
parentTheme: "/library/metadata/66/theme/1705716261",
parentThumb: "/library/metadata/66/thumb/1705716261",
parentTitle: "Caprica",
parentYear: 2010,
primaryExtraKey: "/library/metadata/58684",
ratingImage: "rottentomatoes://image.rating.ripe",
ratingKey: "58683",
rating: 7.6,
seasonCount: 2022,
skipCount: 1,
slug: "4-for-texas",
studio: "20th Century Studios",
subtype: "clip",
summary:
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
+ "",
tagline: "Return to Pandora.",
theme: "/library/metadata/1/theme/1705636920",
thumb: "/library/metadata/58683/thumb/1703239236",
titleSort: "Whale",
title: "Avatar: The Way of Water",
type: GetRecentlyAddedHubsType.Movie,
updatedAt: 1556281940,
userRating: 10,
viewCount: 1,
viewOffset: 5222500,
viewedLeafCount: 0,
year: 2022,
image: [
{ {
id: 119534, alt: "Episode 1",
duration: 11558112, type: GetRecentlyAddedHubsResponseType.Background,
bitrate: 25025, url: "/library/metadata/45521/thumb/1644710589",
width: 3840,
height: 2072,
aspectRatio: 1.85,
audioProfile: "dts",
audioChannels: 6,
audioCodec: "eac3",
videoCodec: "hevc",
videoResolution: "4k",
container: "mkv",
videoFrameRate: "24p",
videoProfile: "main 10",
hasVoiceActivity: false,
has64bitOffsets: false,
part: [
{
id: 119542,
key: "/library/parts/119542/1680457526/file.mkv",
duration: 11558112,
file:
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
size: 36158371307,
container: "mkv",
audioProfile: "dts",
has64bitOffsets: false,
optimizedForStreaming: false,
videoProfile: "main 10",
indexes: "sd",
stream: [
{
id: 272796,
streamType: 1,
default: true,
selected: true,
codec: "h264",
index: 0,
bitrate: 6273,
colorPrimaries: "bt709",
colorRange: "tv",
colorSpace: "bt709",
colorTrc: "bt709",
bitDepth: 8,
chromaLocation: "left",
streamIdentifier: "2",
chromaSubsampling: "4:2:0",
codedHeight: 1088,
codedWidth: 1920,
frameRate: 29.97,
hasScalingMatrix: false,
hearingImpaired: false,
closedCaptions: false,
embeddedInVideo: "1",
height: 1080,
level: 40,
profile: "main",
refFrames: 4,
scanType: "progressive",
width: 1920,
displayTitle: "1080p (H.264)",
extendedDisplayTitle: "1080p (H.264)",
channels: 2,
language: "English",
languageTag: "en",
languageCode: "eng",
audioChannelLayout: "stereo",
samplingRate: 48000,
title: "English",
canAutoSync: false,
},
],
},
],
},
],
genre: [
{
tag: "Adventure",
},
],
country: [
{
tag: "United States of America",
},
],
director: [
{
tag: "James Cameron",
},
],
writer: [
{
tag: "James Cameron",
},
],
collection: [
{
tag: "Working NL Subs",
},
],
role: [
{
id: 294129,
filter: "actor=294129",
thumb:
"https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg",
tag: "Mike Smith",
tagKey: "668e7e7b22bcad9064350c91",
role: "Self",
},
],
location: [
{
path: "/TV Shows/House",
},
],
mediaGuid: [
{
id: "imdb://tt13015952",
}, },
], ],
ultraBlurColors: { ultraBlurColors: {
@@ -188,122 +92,253 @@ let value: GetRecentlyAddedMetadata = {
bottomRight: "73958", bottomRight: "73958",
bottomLeft: "1f5066", bottomLeft: "1f5066",
}, },
metaDataRating: [ media: [
{ {
image: "themoviedb://image.rating", id: 387322,
value: 3, duration: 9610350,
bitrate: 25512,
width: 3840,
height: 1602,
aspectRatio: 2.35,
audioChannels: 6,
displayOffset: 50,
audioCodec: "eac3",
videoCodec: "hevc",
videoResolution: "4k",
container: "mkv",
videoFrameRate: "24p",
videoProfile: "main 10",
hasVoiceActivity: false,
audioProfile: "dts",
has64bitOffsets: false,
part: [
{
accessible: true,
exists: true,
id: 418385,
key: "/library/parts/418385/1735864239/file.mkv",
indexes: "sd",
duration: 9610350,
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
size: 30649952104,
packetLength: 188,
container: "mkv",
videoProfile: "main 10",
audioProfile: "dts",
has64bitOffsets: false,
stream: [
{
id: 1002625,
streamType: 1,
default: true,
codec: "hevc",
index: 0,
bitrate: 24743,
language: "English",
languageTag: "en",
languageCode: "eng",
headerCompression: true,
doviblCompatID: 1,
doviblPresent: true,
dovielPresent: false,
doviLevel: 6,
doviPresent: true,
doviProfile: 8,
dovirpuPresent: true,
doviVersion: "1.0",
bitDepth: 10,
chromaLocation: "topleft",
chromaSubsampling: "4:2:0",
codedHeight: 1608,
codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020",
colorRange: "tv",
colorSpace: "bt2020nc",
colorTrc: "smpte2084",
frameRate: 23.976,
height: 1602,
level: 150,
original: true,
hasScalingMatrix: false,
profile: "main 10",
scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1,
width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
selected: true,
forced: true,
channels: 6,
audioChannelLayout: "5.1(side)",
samplingRate: 48000,
canAutoSync: false,
hearingImpaired: true,
dub: true,
title: "SDH",
},
],
},
],
},
],
genre: [
{
id: 259,
filter: "genre=19",
tag: "Crime",
},
],
country: [
{
id: 259,
tag: "United States of America",
filter: "country=19",
},
],
director: [
{
tag: "Danny Boyle",
},
],
writer: [
{
id: 126522,
filter: "writer=126522",
tag: "Jamie P. Hanson",
tagKey: "5d77683d85719b001f3a535e",
},
],
role: [
{
id: 126522,
filter: "actor=126522",
tag: "Teller",
tagKey: "5d77683d85719b001f3a535e",
role: "Self - Judge",
thumb:
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
},
],
producer: [
{
id: 126522,
filter: "producer=126522",
tag: "Amelia Knapp",
tagKey: "5d77683d85719b001f3a535e",
thumb:
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
},
],
rating1: [
{
image: "imdb://image.rating",
value: 5.1,
type: "audience", type: "audience",
}, },
], ],
image: [ similar: [
{ {
alt: "Episode 1", id: 259,
type: GetRecentlyAddedHubsResponseType.Background, filter: "similar=259",
url: "/library/metadata/45521/thumb/1644710589", tag: "Criss Angel Mindfreak",
},
],
location: [
{
path: "/TV Shows/Clarkson's Farm",
},
],
guids: [
{
id: "tvdb://2337",
},
],
collection: [
{
tag: "My Awesome Collection",
}, },
], ],
titleSort: "Whale",
viewCount: 1,
lastViewedAt: 1682752242,
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
viewOffset: 5222500,
skipCount: 1,
index: 1,
theme: "/library/metadata/1/theme/1705636920",
leafCount: 14,
viewedLeafCount: 0,
childCount: 1,
hasPremiumExtras: "1",
hasPremiumPrimaryExtra: "1",
parentRatingKey: "66",
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
parentStudio: "UCP",
parentKey: "/library/metadata/66",
parentTitle: "Caprica",
parentIndex: 1,
parentYear: 2010,
parentThumb: "/library/metadata/66/thumb/1705716261",
parentTheme: "/library/metadata/66/theme/1705716261",
}; };
``` ```
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 | | `addedAt` | *number* | :heavy_check_mark: | N/A | 1556281940 |
| `key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 | | `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
| `guid` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 | | `audienceRatingImage` | *string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
| `studio` | *string* | :heavy_minus_sign: | N/A | 20th Century Studios | | `audienceRating` | *number* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `skipChildren` | *boolean* | :heavy_minus_sign: | N/A | false | | `chapterSource` | *string* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 | | `childCount` | *number* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies | | `contentRating` | *string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 | | `createdAtAccuracy` | *string* | :heavy_minus_sign: | The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). | epoch,local |
| `type` | [operations.GetRecentlyAddedHubsType](../../../sdk/models/operations/getrecentlyaddedhubstype.md) | :heavy_check_mark: | The type of media content<br/> | movie | | `createdAtTZOffset` | *string* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
| `title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water | | `duration` | *number* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
| `slug` | *string* | :heavy_minus_sign: | N/A | 4-for-texas | | `grandparentArt` | *string* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 | | `grandparentGuid` | *string* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `summary` | *string* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. | | `grandparentKey` | *string* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
| `rating` | *number* | :heavy_minus_sign: | N/A | 7.6 | | `grandparentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 9.2 | | `grandparentSlug` | *string* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
| `year` | *number* | :heavy_minus_sign: | N/A | 2022 | | `grandparentTheme` | *string* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
| `seasonCount` | *number* | :heavy_minus_sign: | N/A | 2022 | | `grandparentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
| `tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. | | `grandparentTitle` | *string* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
| `flattenSeasons` | [operations.FlattenSeasons](../../../sdk/models/operations/flattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 | | `guid` | *string* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
| `episodeSort` | [operations.EpisodeSort](../../../sdk/models/operations/episodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 | | `index` | *number* | :heavy_check_mark: | The index position of the media item. | 1 |
| `enableCreditsMarkerGeneration` | [operations.EnableCreditsMarkerGeneration](../../../sdk/models/operations/enablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 | | `key` | *string* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
| `showOrdering` | [operations.ShowOrdering](../../../sdk/models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute | | `lastRatedAt` | *number* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 | | `lastViewedAt` | *number* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 | | `leafCount` | *number* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 | | `librarySectionID` | *number* | :heavy_check_mark: | The identifier for the library section. | 1 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 | | `librarySectionKey` | *string* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC | | `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | Movies |
| `addedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 | | `originalTitle` | *string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 | | `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright | | `parentGuid` | *string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `chapterSource` | *string* | :heavy_minus_sign: | N/A | media | | `parentIndex` | *number* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
| `primaryExtraKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58684 | | `parentKey` | *string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
| `ratingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe | | `parentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
| `grandparentRatingKey` | *string* | :heavy_minus_sign: | N/A | 66 | | `parentSlug` | *string* | :heavy_minus_sign: | The slug for the parent media item. | alice-in-borderland-2020 |
| `grandparentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 | | `parentStudio` | *string* | :heavy_check_mark: | The studio of the parent media item. | UCP |
| `grandparentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66 | | `parentTheme` | *string* | :heavy_check_mark: | The theme URL for the parent media item. | /library/metadata/66/theme/1705716261 |
| `grandparentTitle` | *string* | :heavy_minus_sign: | N/A | Caprica | | `parentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
| `grandparentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 | | `parentTitle` | *string* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
| `parentSlug` | *string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 | | `parentYear` | *number* | :heavy_minus_sign: | The release year of the parent media item. | 2010 |
| `grandparentSlug` | *string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 | | `primaryExtraKey` | *string* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
| `grandparentArt` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 | | `ratingImage` | *string* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
| `grandparentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 | | `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. | 58683 |
| `media` | [operations.Media](../../../sdk/models/operations/media.md)[] | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | | | `rating` | *number* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
| `genre` | [operations.Genre](../../../sdk/models/operations/genre.md)[] | :heavy_minus_sign: | N/A | | | `seasonCount` | *number* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
| `country` | [operations.Country](../../../sdk/models/operations/country.md)[] | :heavy_minus_sign: | N/A | | | `skipCount` | *number* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
| `director` | [operations.Director](../../../sdk/models/operations/director.md)[] | :heavy_minus_sign: | N/A | | | `slug` | *string* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
| `writer` | [operations.Writer](../../../sdk/models/operations/writer.md)[] | :heavy_minus_sign: | N/A | | | `studio` | *string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `collection` | [operations.Collection](../../../sdk/models/operations/collection.md)[] | :heavy_minus_sign: | N/A | | | `subtype` | *string* | :heavy_minus_sign: | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
| `role` | [operations.Role](../../../sdk/models/operations/role.md)[] | :heavy_minus_sign: | N/A | | | `summary` | *string* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
| `location` | [operations.Location](../../../sdk/models/operations/location.md)[] | :heavy_minus_sign: | N/A | | | `tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
| `mediaGuid` | [operations.MediaGuid](../../../sdk/models/operations/mediaguid.md)[] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | | | `theme` | *string* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
| `ultraBlurColors` | [operations.UltraBlurColors](../../../sdk/models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | | | `thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
| `metaDataRating` | [operations.MetaDataRating](../../../sdk/models/operations/metadatarating.md)[] | :heavy_minus_sign: | N/A | | | `titleSort` | *string* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
| `image` | [operations.GetRecentlyAddedImage](../../../sdk/models/operations/getrecentlyaddedimage.md)[] | :heavy_minus_sign: | N/A | | | `title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
| `titleSort` | *string* | :heavy_minus_sign: | N/A | Whale | | `type` | [operations.GetRecentlyAddedHubsType](../../../sdk/models/operations/getrecentlyaddedhubstype.md) | :heavy_check_mark: | N/A | movie |
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 | | `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1682752242 | | `userRating` | *number* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
| `originalTitle` | *string* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 | | `viewCount` | *number* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
| `viewOffset` | *number* | :heavy_minus_sign: | N/A | 5222500 | | `viewOffset` | *number* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
| `skipCount` | *number* | :heavy_minus_sign: | N/A | 1 | | `viewedLeafCount` | *number* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
| `index` | *number* | :heavy_minus_sign: | N/A | 1 | | `year` | *number* | :heavy_minus_sign: | The release year of the media item. | 2022 |
| `theme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 | | `image` | [operations.GetRecentlyAddedImage](../../../sdk/models/operations/getrecentlyaddedimage.md)[] | :heavy_minus_sign: | N/A | |
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 14 | | `ultraBlurColors` | [operations.UltraBlurColors](../../../sdk/models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `viewedLeafCount` | *number* | :heavy_minus_sign: | N/A | 0 | | `media` | [operations.Media](../../../sdk/models/operations/media.md)[] | :heavy_minus_sign: | N/A | |
| `childCount` | *number* | :heavy_minus_sign: | N/A | 1 | | `genre` | [operations.Genre](../../../sdk/models/operations/genre.md)[] | :heavy_minus_sign: | N/A | |
| `hasPremiumExtras` | *string* | :heavy_minus_sign: | N/A | 1 | | `country` | [operations.Country](../../../sdk/models/operations/country.md)[] | :heavy_minus_sign: | N/A | |
| `hasPremiumPrimaryExtra` | *string* | :heavy_minus_sign: | N/A | 1 | | `director` | [operations.Director](../../../sdk/models/operations/director.md)[] | :heavy_minus_sign: | N/A | |
| `parentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 | | `writer` | [operations.Writer](../../../sdk/models/operations/writer.md)[] | :heavy_minus_sign: | N/A | |
| `parentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 | | `role` | [operations.Role](../../../sdk/models/operations/role.md)[] | :heavy_minus_sign: | N/A | |
| `parentStudio` | *string* | :heavy_minus_sign: | N/A | UCP | | `producer` | [operations.Producer](../../../sdk/models/operations/producer.md)[] | :heavy_minus_sign: | N/A | |
| `parentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66 | | `rating1` | [operations.Rating](../../../sdk/models/operations/rating.md)[] | :heavy_minus_sign: | N/A | |
| `parentTitle` | *string* | :heavy_minus_sign: | N/A | Caprica | | `similar` | [operations.Similar](../../../sdk/models/operations/similar.md)[] | :heavy_minus_sign: | N/A | |
| `parentIndex` | *number* | :heavy_minus_sign: | N/A | 1 | | `location` | [operations.Location](../../../sdk/models/operations/location.md)[] | :heavy_minus_sign: | N/A | |
| `parentYear` | *number* | :heavy_minus_sign: | N/A | 2010 | | `guids` | [operations.Guids](../../../sdk/models/operations/guids.md)[] | :heavy_minus_sign: | N/A | |
| `parentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 | | `collection` | [operations.Collection](../../../sdk/models/operations/collection.md)[] | :heavy_minus_sign: | N/A | |
| `parentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |

20
docs/sdk/models/operations/getrecentlyaddedoptimizedforstreaming.md Normal file
View File

@@ -0,0 +1,20 @@
# GetRecentlyAddedOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Supported Types
### `operations.GetRecentlyAddedOptimizedForStreaming1`
```typescript
const value: operations.GetRecentlyAddedOptimizedForStreaming1 =
GetRecentlyAddedOptimizedForStreaming1.One;
```
### `boolean`
```typescript
const value: boolean = false;
```

17
docs/sdk/models/operations/getrecentlyaddedoptimizedforstreaming1.md Normal file
View File

@@ -0,0 +1,17 @@
# GetRecentlyAddedOptimizedForStreaming1
## Example Usage
```typescript
import { GetRecentlyAddedOptimizedForStreaming1 } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetRecentlyAddedOptimizedForStreaming1 =
GetRecentlyAddedOptimizedForStreaming1.Zero;
```
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

420
docs/sdk/models/operations/getrecentlyaddedresponse.md
View File

@@ -4,27 +4,25 @@
```typescript ```typescript
import { import {
EnableCreditsMarkerGeneration,
EpisodeSort,
FlattenSeasons,
GetRecentlyAddedHubsResponseType, GetRecentlyAddedHubsResponseType,
GetRecentlyAddedHubsType, GetRecentlyAddedHubsType,
GetRecentlyAddedResponse, GetRecentlyAddedResponse,
ShowOrdering,
} from "@lukehagar/plexjs/sdk/models/operations"; } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types"; import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetRecentlyAddedResponse = { let value: GetRecentlyAddedResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 507, statusCode: 101,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),
object: { object: {
mediaContainer: { mediaContainer: {
size: 50, size: 50,
identifier: "com.plexapp.plugins.library", totalSize: 50,
offset: 0,
allowSync: false, allowSync: false,
identifier: "com.plexapp.plugins.library",
meta: { meta: {
type: [ type: [
{ {
@@ -77,172 +75,76 @@ let value: GetRecentlyAddedResponse = {
}, },
metadata: [ metadata: [
{ {
ratingKey: "58683",
key: "/library/metadata/58683",
guid: "plex://movie/5d7768ba96b655001fdc0408",
studio: "20th Century Studios",
skipChildren: false,
librarySectionID: 1,
librarySectionTitle: "Movies",
librarySectionKey: "/library/sections/1",
type: GetRecentlyAddedHubsType.Movie,
title: "Avatar: The Way of Water",
slug: "4-for-texas",
contentRating: "PG-13",
summary:
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.",
rating: 7.6,
audienceRating: 9.2,
year: 2022,
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: FlattenSeasons.Show,
episodeSort: EpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
EnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: ShowOrdering.TvdbAbsolute,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236",
duration: 11558112,
originallyAvailableAt: new RFCDate("2022-12-14T00:00:00Z"),
addedAt: 1556281940, addedAt: 1556281940,
updatedAt: 1556281940, art: "/library/metadata/58683/art/1703239236",
audienceRatingImage: "rottentomatoes://image.rating.upright", audienceRatingImage: "rottentomatoes://image.rating.upright",
audienceRating: 9.2,
chapterSource: "media", chapterSource: "media",
primaryExtraKey: "/library/metadata/58684", childCount: 1,
ratingImage: "rottentomatoes://image.rating.ripe", contentRating: "PG-13",
grandparentRatingKey: "66", createdAtAccuracy: "epoch,local",
createdAtTZOffset: "0",
duration: 11558112,
grandparentArt: "/library/metadata/66/art/1705716261",
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4", grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
grandparentKey: "/library/metadata/66", grandparentKey: "/library/metadata/66",
grandparentTitle: "Caprica", grandparentRatingKey: "66",
grandparentThumb: "/library/metadata/66/thumb/1705716261",
parentSlug: "alice-in-borderland-2020",
grandparentSlug: "alice-in-borderland-2020", grandparentSlug: "alice-in-borderland-2020",
grandparentArt: "/library/metadata/66/art/1705716261",
grandparentTheme: "/library/metadata/66/theme/1705716261", grandparentTheme: "/library/metadata/66/theme/1705716261",
media: [ grandparentThumb: "/library/metadata/66/thumb/1705716261",
grandparentTitle: "Caprica",
guid: "plex://movie/5d7768ba96b655001fdc0408",
index: 1,
key: "/library/metadata/58683",
lastRatedAt: 1721813113,
lastViewedAt: 1682752242,
leafCount: 14,
librarySectionID: 1,
librarySectionKey: "/library/sections/1",
librarySectionTitle: "Movies",
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
originallyAvailableAt: new RFCDate("2022-12-14"),
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
parentIndex: 1,
parentKey: "/library/metadata/66",
parentRatingKey: "66",
parentSlug: "alice-in-borderland-2020",
parentStudio: "UCP",
parentTheme: "/library/metadata/66/theme/1705716261",
parentThumb: "/library/metadata/66/thumb/1705716261",
parentTitle: "Caprica",
parentYear: 2010,
primaryExtraKey: "/library/metadata/58684",
ratingImage: "rottentomatoes://image.rating.ripe",
ratingKey: "58683",
rating: 7.6,
seasonCount: 2022,
skipCount: 1,
slug: "4-for-texas",
studio: "20th Century Studios",
subtype: "clip",
summary:
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
+ "",
tagline: "Return to Pandora.",
theme: "/library/metadata/1/theme/1705636920",
thumb: "/library/metadata/58683/thumb/1703239236",
titleSort: "Whale",
title: "Avatar: The Way of Water",
type: GetRecentlyAddedHubsType.Movie,
updatedAt: 1556281940,
userRating: 10,
viewCount: 1,
viewOffset: 5222500,
viewedLeafCount: 0,
year: 2022,
image: [
{ {
id: 119534, alt: "Episode 1",
duration: 11558112, type: GetRecentlyAddedHubsResponseType.Background,
bitrate: 25025, url: "/library/metadata/45521/thumb/1644710589",
width: 3840,
height: 2072,
aspectRatio: 1.85,
audioProfile: "dts",
audioChannels: 6,
audioCodec: "eac3",
videoCodec: "hevc",
videoResolution: "4k",
container: "mkv",
videoFrameRate: "24p",
videoProfile: "main 10",
hasVoiceActivity: false,
has64bitOffsets: false,
part: [
{
id: 119542,
key: "/library/parts/119542/1680457526/file.mkv",
duration: 11558112,
file:
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
size: 36158371307,
container: "mkv",
audioProfile: "dts",
has64bitOffsets: false,
optimizedForStreaming: false,
videoProfile: "main 10",
indexes: "sd",
stream: [
{
id: 272796,
streamType: 1,
default: true,
selected: true,
codec: "h264",
index: 0,
bitrate: 6273,
colorPrimaries: "bt709",
colorRange: "tv",
colorSpace: "bt709",
colorTrc: "bt709",
bitDepth: 8,
chromaLocation: "left",
streamIdentifier: "2",
chromaSubsampling: "4:2:0",
codedHeight: 1088,
codedWidth: 1920,
frameRate: 29.97,
hasScalingMatrix: false,
hearingImpaired: false,
closedCaptions: false,
embeddedInVideo: "1",
height: 1080,
level: 40,
profile: "main",
refFrames: 4,
scanType: "progressive",
width: 1920,
displayTitle: "1080p (H.264)",
extendedDisplayTitle: "1080p (H.264)",
channels: 2,
language: "English",
languageTag: "en",
languageCode: "eng",
audioChannelLayout: "stereo",
samplingRate: 48000,
title: "English",
canAutoSync: false,
},
],
},
],
},
],
genre: [
{
tag: "Adventure",
},
],
country: [
{
tag: "United States of America",
},
],
director: [
{
tag: "James Cameron",
},
],
writer: [
{
tag: "James Cameron",
},
],
collection: [
{
tag: "Working NL Subs",
},
],
role: [
{
id: 294129,
filter: "actor=294129",
thumb:
"https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg",
tag: "Mike Smith",
tagKey: "668e7e7b22bcad9064350c91",
role: "Self",
},
],
location: [
{
path: "/TV Shows/House",
},
],
mediaGuid: [
{
id: "imdb://tt13015952",
}, },
], ],
ultraBlurColors: { ultraBlurColors: {
@@ -251,42 +153,174 @@ let value: GetRecentlyAddedResponse = {
bottomRight: "73958", bottomRight: "73958",
bottomLeft: "1f5066", bottomLeft: "1f5066",
}, },
metaDataRating: [ media: [
{ {
image: "themoviedb://image.rating", id: 387322,
value: 3, duration: 9610350,
bitrate: 25512,
width: 3840,
height: 1602,
aspectRatio: 2.35,
audioChannels: 6,
displayOffset: 50,
audioCodec: "eac3",
videoCodec: "hevc",
videoResolution: "4k",
container: "mkv",
videoFrameRate: "24p",
videoProfile: "main 10",
hasVoiceActivity: false,
audioProfile: "dts",
has64bitOffsets: false,
part: [
{
accessible: true,
exists: true,
id: 418385,
key: "/library/parts/418385/1735864239/file.mkv",
indexes: "sd",
duration: 9610350,
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
size: 30649952104,
packetLength: 188,
container: "mkv",
videoProfile: "main 10",
audioProfile: "dts",
has64bitOffsets: false,
stream: [
{
id: 1002625,
streamType: 1,
default: true,
codec: "hevc",
index: 0,
bitrate: 24743,
language: "English",
languageTag: "en",
languageCode: "eng",
headerCompression: true,
doviblCompatID: 1,
doviblPresent: true,
dovielPresent: false,
doviLevel: 6,
doviPresent: true,
doviProfile: 8,
dovirpuPresent: true,
doviVersion: "1.0",
bitDepth: 10,
chromaLocation: "topleft",
chromaSubsampling: "4:2:0",
codedHeight: 1608,
codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020",
colorRange: "tv",
colorSpace: "bt2020nc",
colorTrc: "smpte2084",
frameRate: 23.976,
height: 1602,
level: 150,
original: true,
hasScalingMatrix: false,
profile: "main 10",
scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1,
width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
selected: true,
forced: true,
channels: 6,
audioChannelLayout: "5.1(side)",
samplingRate: 48000,
canAutoSync: false,
hearingImpaired: true,
dub: true,
title: "SDH",
},
],
},
],
},
],
genre: [
{
id: 259,
filter: "genre=19",
tag: "Crime",
},
],
country: [
{
id: 259,
tag: "United States of America",
filter: "country=19",
},
],
director: [
{
tag: "Danny Boyle",
},
],
writer: [
{
id: 126522,
filter: "writer=126522",
tag: "Jamie P. Hanson",
tagKey: "5d77683d85719b001f3a535e",
},
],
role: [
{
id: 126522,
filter: "actor=126522",
tag: "Teller",
tagKey: "5d77683d85719b001f3a535e",
role: "Self - Judge",
thumb:
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
},
],
producer: [
{
id: 126522,
filter: "producer=126522",
tag: "Amelia Knapp",
tagKey: "5d77683d85719b001f3a535e",
thumb:
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
},
],
rating1: [
{
image: "imdb://image.rating",
value: 5.1,
type: "audience", type: "audience",
}, },
], ],
image: [ similar: [
{ {
alt: "Episode 1", id: 259,
type: GetRecentlyAddedHubsResponseType.Background, filter: "similar=259",
url: "/library/metadata/45521/thumb/1644710589", tag: "Criss Angel Mindfreak",
},
],
location: [
{
path: "/TV Shows/Clarkson's Farm",
},
],
guids: [
{
id: "tvdb://2337",
},
],
collection: [
{
tag: "My Awesome Collection",
}, },
], ],
titleSort: "Whale",
viewCount: 1,
lastViewedAt: 1682752242,
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
viewOffset: 5222500,
skipCount: 1,
index: 1,
theme: "/library/metadata/1/theme/1705636920",
leafCount: 14,
viewedLeafCount: 0,
childCount: 1,
hasPremiumExtras: "1",
hasPremiumPrimaryExtra: "1",
parentRatingKey: "66",
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
parentStudio: "UCP",
parentKey: "/library/metadata/66",
parentTitle: "Caprica",
parentIndex: 1,
parentYear: 2010,
parentThumb: "/library/metadata/66/thumb/1705716261",
parentTheme: "/library/metadata/66/theme/1705716261",
}, },
], ],
}, },

418
docs/sdk/models/operations/getrecentlyaddedresponsebody.md
View File

@@ -6,21 +6,19 @@ A successful response with recently added content.
```typescript ```typescript
import { import {
EnableCreditsMarkerGeneration,
EpisodeSort,
FlattenSeasons,
GetRecentlyAddedHubsResponseType, GetRecentlyAddedHubsResponseType,
GetRecentlyAddedHubsType, GetRecentlyAddedHubsType,
GetRecentlyAddedResponseBody, GetRecentlyAddedResponseBody,
ShowOrdering,
} from "@lukehagar/plexjs/sdk/models/operations"; } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types"; import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetRecentlyAddedResponseBody = { let value: GetRecentlyAddedResponseBody = {
mediaContainer: { mediaContainer: {
size: 50, size: 50,
identifier: "com.plexapp.plugins.library", totalSize: 50,
offset: 0,
allowSync: false, allowSync: false,
identifier: "com.plexapp.plugins.library",
meta: { meta: {
type: [ type: [
{ {
@@ -73,172 +71,76 @@ let value: GetRecentlyAddedResponseBody = {
}, },
metadata: [ metadata: [
{ {
ratingKey: "58683",
key: "/library/metadata/58683",
guid: "plex://movie/5d7768ba96b655001fdc0408",
studio: "20th Century Studios",
skipChildren: false,
librarySectionID: 1,
librarySectionTitle: "Movies",
librarySectionKey: "/library/sections/1",
type: GetRecentlyAddedHubsType.Movie,
title: "Avatar: The Way of Water",
slug: "4-for-texas",
contentRating: "PG-13",
summary:
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.",
rating: 7.6,
audienceRating: 9.2,
year: 2022,
seasonCount: 2022,
tagline: "Return to Pandora.",
flattenSeasons: FlattenSeasons.Show,
episodeSort: EpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
EnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: ShowOrdering.TvdbAbsolute,
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236",
duration: 11558112,
originallyAvailableAt: new RFCDate("2022-12-14T00:00:00Z"),
addedAt: 1556281940, addedAt: 1556281940,
updatedAt: 1556281940, art: "/library/metadata/58683/art/1703239236",
audienceRatingImage: "rottentomatoes://image.rating.upright", audienceRatingImage: "rottentomatoes://image.rating.upright",
audienceRating: 9.2,
chapterSource: "media", chapterSource: "media",
primaryExtraKey: "/library/metadata/58684", childCount: 1,
ratingImage: "rottentomatoes://image.rating.ripe", contentRating: "PG-13",
grandparentRatingKey: "66", createdAtAccuracy: "epoch,local",
createdAtTZOffset: "0",
duration: 11558112,
grandparentArt: "/library/metadata/66/art/1705716261",
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4", grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
grandparentKey: "/library/metadata/66", grandparentKey: "/library/metadata/66",
grandparentTitle: "Caprica", grandparentRatingKey: "66",
grandparentThumb: "/library/metadata/66/thumb/1705716261",
parentSlug: "alice-in-borderland-2020",
grandparentSlug: "alice-in-borderland-2020", grandparentSlug: "alice-in-borderland-2020",
grandparentArt: "/library/metadata/66/art/1705716261",
grandparentTheme: "/library/metadata/66/theme/1705716261", grandparentTheme: "/library/metadata/66/theme/1705716261",
media: [ grandparentThumb: "/library/metadata/66/thumb/1705716261",
grandparentTitle: "Caprica",
guid: "plex://movie/5d7768ba96b655001fdc0408",
index: 1,
key: "/library/metadata/58683",
lastRatedAt: 1721813113,
lastViewedAt: 1682752242,
leafCount: 14,
librarySectionID: 1,
librarySectionKey: "/library/sections/1",
librarySectionTitle: "Movies",
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
originallyAvailableAt: new RFCDate("2022-12-14"),
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
parentIndex: 1,
parentKey: "/library/metadata/66",
parentRatingKey: "66",
parentSlug: "alice-in-borderland-2020",
parentStudio: "UCP",
parentTheme: "/library/metadata/66/theme/1705716261",
parentThumb: "/library/metadata/66/thumb/1705716261",
parentTitle: "Caprica",
parentYear: 2010,
primaryExtraKey: "/library/metadata/58684",
ratingImage: "rottentomatoes://image.rating.ripe",
ratingKey: "58683",
rating: 7.6,
seasonCount: 2022,
skipCount: 1,
slug: "4-for-texas",
studio: "20th Century Studios",
subtype: "clip",
summary:
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
+ "",
tagline: "Return to Pandora.",
theme: "/library/metadata/1/theme/1705636920",
thumb: "/library/metadata/58683/thumb/1703239236",
titleSort: "Whale",
title: "Avatar: The Way of Water",
type: GetRecentlyAddedHubsType.Movie,
updatedAt: 1556281940,
userRating: 10,
viewCount: 1,
viewOffset: 5222500,
viewedLeafCount: 0,
year: 2022,
image: [
{ {
id: 119534, alt: "Episode 1",
duration: 11558112, type: GetRecentlyAddedHubsResponseType.Background,
bitrate: 25025, url: "/library/metadata/45521/thumb/1644710589",
width: 3840,
height: 2072,
aspectRatio: 1.85,
audioProfile: "dts",
audioChannels: 6,
audioCodec: "eac3",
videoCodec: "hevc",
videoResolution: "4k",
container: "mkv",
videoFrameRate: "24p",
videoProfile: "main 10",
hasVoiceActivity: false,
has64bitOffsets: false,
part: [
{
id: 119542,
key: "/library/parts/119542/1680457526/file.mkv",
duration: 11558112,
file:
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
size: 36158371307,
container: "mkv",
audioProfile: "dts",
has64bitOffsets: false,
optimizedForStreaming: false,
videoProfile: "main 10",
indexes: "sd",
stream: [
{
id: 272796,
streamType: 1,
default: true,
selected: true,
codec: "h264",
index: 0,
bitrate: 6273,
colorPrimaries: "bt709",
colorRange: "tv",
colorSpace: "bt709",
colorTrc: "bt709",
bitDepth: 8,
chromaLocation: "left",
streamIdentifier: "2",
chromaSubsampling: "4:2:0",
codedHeight: 1088,
codedWidth: 1920,
frameRate: 29.97,
hasScalingMatrix: false,
hearingImpaired: false,
closedCaptions: false,
embeddedInVideo: "1",
height: 1080,
level: 40,
profile: "main",
refFrames: 4,
scanType: "progressive",
width: 1920,
displayTitle: "1080p (H.264)",
extendedDisplayTitle: "1080p (H.264)",
channels: 2,
language: "English",
languageTag: "en",
languageCode: "eng",
audioChannelLayout: "stereo",
samplingRate: 48000,
title: "English",
canAutoSync: false,
},
],
},
],
},
],
genre: [
{
tag: "Adventure",
},
],
country: [
{
tag: "United States of America",
},
],
director: [
{
tag: "James Cameron",
},
],
writer: [
{
tag: "James Cameron",
},
],
collection: [
{
tag: "Working NL Subs",
},
],
role: [
{
id: 294129,
filter: "actor=294129",
thumb:
"https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg",
tag: "Mike Smith",
tagKey: "668e7e7b22bcad9064350c91",
role: "Self",
},
],
location: [
{
path: "/TV Shows/House",
},
],
mediaGuid: [
{
id: "imdb://tt13015952",
}, },
], ],
ultraBlurColors: { ultraBlurColors: {
@@ -247,42 +149,174 @@ let value: GetRecentlyAddedResponseBody = {
bottomRight: "73958", bottomRight: "73958",
bottomLeft: "1f5066", bottomLeft: "1f5066",
}, },
metaDataRating: [ media: [
{ {
image: "themoviedb://image.rating", id: 387322,
value: 3, duration: 9610350,
bitrate: 25512,
width: 3840,
height: 1602,
aspectRatio: 2.35,
audioChannels: 6,
displayOffset: 50,
audioCodec: "eac3",
videoCodec: "hevc",
videoResolution: "4k",
container: "mkv",
videoFrameRate: "24p",
videoProfile: "main 10",
hasVoiceActivity: false,
audioProfile: "dts",
has64bitOffsets: false,
part: [
{
accessible: true,
exists: true,
id: 418385,
key: "/library/parts/418385/1735864239/file.mkv",
indexes: "sd",
duration: 9610350,
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
size: 30649952104,
packetLength: 188,
container: "mkv",
videoProfile: "main 10",
audioProfile: "dts",
has64bitOffsets: false,
stream: [
{
id: 1002625,
streamType: 1,
default: true,
codec: "hevc",
index: 0,
bitrate: 24743,
language: "English",
languageTag: "en",
languageCode: "eng",
headerCompression: true,
doviblCompatID: 1,
doviblPresent: true,
dovielPresent: false,
doviLevel: 6,
doviPresent: true,
doviProfile: 8,
dovirpuPresent: true,
doviVersion: "1.0",
bitDepth: 10,
chromaLocation: "topleft",
chromaSubsampling: "4:2:0",
codedHeight: 1608,
codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020",
colorRange: "tv",
colorSpace: "bt2020nc",
colorTrc: "smpte2084",
frameRate: 23.976,
height: 1602,
level: 150,
original: true,
hasScalingMatrix: false,
profile: "main 10",
scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1,
width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
selected: true,
forced: true,
channels: 6,
audioChannelLayout: "5.1(side)",
samplingRate: 48000,
canAutoSync: false,
hearingImpaired: true,
dub: true,
title: "SDH",
},
],
},
],
},
],
genre: [
{
id: 259,
filter: "genre=19",
tag: "Crime",
},
],
country: [
{
id: 259,
tag: "United States of America",
filter: "country=19",
},
],
director: [
{
tag: "Danny Boyle",
},
],
writer: [
{
id: 126522,
filter: "writer=126522",
tag: "Jamie P. Hanson",
tagKey: "5d77683d85719b001f3a535e",
},
],
role: [
{
id: 126522,
filter: "actor=126522",
tag: "Teller",
tagKey: "5d77683d85719b001f3a535e",
role: "Self - Judge",
thumb:
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
},
],
producer: [
{
id: 126522,
filter: "producer=126522",
tag: "Amelia Knapp",
tagKey: "5d77683d85719b001f3a535e",
thumb:
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
},
],
rating1: [
{
image: "imdb://image.rating",
value: 5.1,
type: "audience", type: "audience",
}, },
], ],
image: [ similar: [
{ {
alt: "Episode 1", id: 259,
type: GetRecentlyAddedHubsResponseType.Background, filter: "similar=259",
url: "/library/metadata/45521/thumb/1644710589", tag: "Criss Angel Mindfreak",
},
],
location: [
{
path: "/TV Shows/Clarkson's Farm",
},
],
guids: [
{
id: "tvdb://2337",
},
],
collection: [
{
tag: "My Awesome Collection",
}, },
], ],
titleSort: "Whale",
viewCount: 1,
lastViewedAt: 1682752242,
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
viewOffset: 5222500,
skipCount: 1,
index: 1,
theme: "/library/metadata/1/theme/1705636920",
leafCount: 14,
viewedLeafCount: 0,
childCount: 1,
hasPremiumExtras: "1",
hasPremiumPrimaryExtra: "1",
parentRatingKey: "66",
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
parentStudio: "UCP",
parentKey: "/library/metadata/66",
parentTitle: "Caprica",
parentIndex: 1,
parentYear: 2010,
parentThumb: "/library/metadata/66/thumb/1705716261",
parentTheme: "/library/metadata/66/theme/1705716261",
}, },
], ],
}, },

2
docs/sdk/models/operations/getrefreshlibrarymetadatarequest.md
View File

@@ -6,7 +6,7 @@
import { Force, GetRefreshLibraryMetadataRequest } from "@lukehagar/plexjs/sdk/models/operations"; import { Force, GetRefreshLibraryMetadataRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetRefreshLibraryMetadataRequest = { let value: GetRefreshLibraryMetadataRequest = {
force: Force.One, force: Force.Zero,
sectionKey: 9518, sectionKey: 9518,
}; };
``` ```

2
docs/sdk/models/operations/getrefreshlibrarymetadataresponse.md
View File

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

2
docs/sdk/models/operations/getresourcesstatisticsresponse.md
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: 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" },
}), }),

4
docs/sdk/models/operations/getsearchalllibrariesmediacontainer.md
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: 543.38, size: 2239.24,
searchResult: [ searchResult: [
{ {
score: 1999.96, score: 3453.52,
metadata: { metadata: {
ratingKey: "58683", ratingKey: "58683",
key: "/library/metadata/58683", key: "/library/metadata/58683",

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