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

Normalized imports, regenerated

Browse Source
This commit is contained in:
Luke Hagar
2024-09-08 03:06:14 +00:00
parent 4d8ee6c199
commit 244adab882
1008 changed files with 21410 additions and 19981 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/models/activity.md
View File

@@ -1,22 +0,0 @@
# Activity
## Example Usage
```typescript
import { Activity } from "@lukehagar/plexjs";
let value: Activity = {};
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
| `uuid` | *string* | :heavy_minus_sign: | N/A |
| `type` | *string* | :heavy_minus_sign: | N/A |
| `cancellable` | *boolean* | :heavy_minus_sign: | N/A |
| `userID` | *number* | :heavy_minus_sign: | N/A |
| `title` | *string* | :heavy_minus_sign: | N/A |
| `subtitle` | *string* | :heavy_minus_sign: | N/A |
| `progress` | *number* | :heavy_minus_sign: | N/A |
| `context` | [models.Context](../models/context.md) | :heavy_minus_sign: | N/A |

39
docs/models/addplaylistcontentsmediacontainer.md
View File

@@ -1,39 +0,0 @@
# AddPlaylistContentsMediaContainer
## Example Usage
```typescript
import { AddPlaylistContentsMediaContainer } from "@lukehagar/plexjs";
let value: AddPlaylistContentsMediaContainer = {
size: 1,
leafCountAdded: 1,
leafCountRequested: 1,
metadata: [
{
ratingKey: "94",
key: "/playlists/94/items",
guid: "com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2",
type: "playlist",
title: "A great playlist",
summary: "One of my great playlists",
smart: false,
playlistType: "video",
composite: "/playlists/94/composite/1705800070",
duration: 423000,
leafCount: 3,
addedAt: 1705716458,
updatedAt: 1705800070,
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `size` | *number* | :heavy_minus_sign: | N/A | 1 |
| `leafCountAdded` | *number* | :heavy_minus_sign: | N/A | 1 |
| `leafCountRequested` | *number* | :heavy_minus_sign: | N/A | 1 |
| `metadata` | [models.AddPlaylistContentsMetadata](../models/addplaylistcontentsmetadata.md)[] | :heavy_minus_sign: | N/A | |

18
docs/models/addplaylistcontentsplaylistsresponsebody.md
View File

@@ -1,18 +0,0 @@
# AddPlaylistContentsPlaylistsResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { AddPlaylistContentsPlaylistsResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `errors` | [models.AddPlaylistContentsErrors](../models/addplaylistcontentserrors.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 |

48
docs/models/addplaylistcontentsresponse.md
View File

@@ -1,48 +0,0 @@
# AddPlaylistContentsResponse
## Example Usage
```typescript
import { AddPlaylistContentsResponse } from "@lukehagar/plexjs";
let value: AddPlaylistContentsResponse = {
contentType: "<value>",
statusCode: 820994,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 1,
leafCountAdded: 1,
leafCountRequested: 1,
metadata: [
{
ratingKey: "94",
key: "/playlists/94/items",
guid: "com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2",
type: "playlist",
title: "A great playlist",
summary: "One of my great playlists",
smart: false,
playlistType: "video",
composite: "/playlists/94/composite/1705800070",
duration: 423000,
leafCount: 3,
addedAt: 1705716458,
updatedAt: 1705800070,
},
],
},
},
};
```
## 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` | [models.AddPlaylistContentsResponseBody](../models/addplaylistcontentsresponsebody.md) | :heavy_minus_sign: | Playlist Updated |

18
docs/models/applyupdatesresponsebody.md
View File

@@ -1,18 +0,0 @@
# ApplyUpdatesResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { ApplyUpdatesResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.ApplyUpdatesErrors](../models/applyupdateserrors.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 |

19
docs/models/billing.md
View File

@@ -1,19 +0,0 @@
# Billing
## Example Usage
```typescript
import { Billing } from "@lukehagar/plexjs";
let value: Billing = {
internalPaymentMethod: {},
paymentMethodId: 317983,
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `internalPaymentMethod` | [models.InternalPaymentMethod](../models/internalpaymentmethod.md) | :heavy_check_mark: | N/A |
| `paymentMethodId` | *number* | :heavy_check_mark: | N/A |

25
docs/models/butlertasks.md
View File

@@ -1,25 +0,0 @@
# ButlerTasks
## Example Usage
```typescript
import { ButlerTasks } from "@lukehagar/plexjs";
let value: ButlerTasks = {
butlerTask: [
{
name: "BackupDatabase",
interval: 3,
title: "Backup Database",
description:
"Create a backup copy of the server's database in the configured backup directory",
},
],
};
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `butlerTask` | [models.ButlerTask](../models/butlertask.md)[] | :heavy_minus_sign: | N/A |

18
docs/models/cancelserveractivitiesresponsebody.md
View File

@@ -1,18 +0,0 @@
# CancelServerActivitiesResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { CancelServerActivitiesResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `errors` | [models.CancelServerActivitiesErrors](../models/cancelserveractivitieserrors.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 |

17
docs/models/checkforupdatesrequest.md
View File

@@ -1,17 +0,0 @@
# CheckForUpdatesRequest
## Example Usage
```typescript
import { CheckForUpdatesRequest, Download } from "@lukehagar/plexjs";
let value: CheckForUpdatesRequest = {
download: Download.One,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
| `download` | [models.Download](../models/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |

18
docs/models/clearplaylistcontentsresponsebody.md
View File

@@ -1,18 +0,0 @@
# ClearPlaylistContentsResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { ClearPlaylistContentsResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `errors` | [models.ClearPlaylistContentsErrors](../models/clearplaylistcontentserrors.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 |

38
docs/models/createplaylistmediacontainer.md
View File

@@ -1,38 +0,0 @@
# CreatePlaylistMediaContainer
## Example Usage
```typescript
import { CreatePlaylistMediaContainer } from "@lukehagar/plexjs";
let value: CreatePlaylistMediaContainer = {
size: 7,
metadata: [
{
ratingKey: "96",
key: "/playlists/96/items",
guid: "com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55",
type: "playlist",
title: "A Great Playlist",
summary: "What a great playlist",
smart: false,
playlistType: "video",
icon: "playlist://image.smart",
viewCount: 1,
lastViewedAt: 1705719589,
leafCount: 1,
addedAt: 1705719589,
updatedAt: 1705724593,
composite: "/playlists/96/composite/1705724593",
duration: 141000,
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `size` | *number* | :heavy_minus_sign: | N/A | 7 |
| `metadata` | [models.CreatePlaylistMetadata](../models/createplaylistmetadata.md)[] | :heavy_minus_sign: | N/A | |

18
docs/models/createplaylistplaylistsresponsebody.md
View File

@@ -1,18 +0,0 @@
# CreatePlaylistPlaylistsResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { CreatePlaylistPlaylistsResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.CreatePlaylistErrors](../models/createplaylisterrors.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 |

24
docs/models/createplaylistrequest.md
View File

@@ -1,24 +0,0 @@
# CreatePlaylistRequest
## Example Usage
```typescript
import { CreatePlaylistQueryParamType, CreatePlaylistRequest, Smart } from "@lukehagar/plexjs";
let value: CreatePlaylistRequest = {
title: "<value>",
type: CreatePlaylistQueryParamType.Photo,
smart: Smart.One,
uri: "https://exotic-harm.info",
};
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `title` | *string* | :heavy_check_mark: | name of the playlist |
| `type` | [models.CreatePlaylistQueryParamType](../models/createplaylistqueryparamtype.md) | :heavy_check_mark: | type of playlist to create |
| `smart` | [models.Smart](../models/smart.md) | :heavy_check_mark: | whether the playlist is smart or not |
| `uri` | *string* | :heavy_check_mark: | the content URI for the playlist |
| `playQueueID` | *number* | :heavy_minus_sign: | the play queue to copy to a playlist |

49
docs/models/createplaylistresponse.md
View File

@@ -1,49 +0,0 @@
# CreatePlaylistResponse
## Example Usage
```typescript
import { CreatePlaylistResponse } from "@lukehagar/plexjs";
let value: CreatePlaylistResponse = {
contentType: "<value>",
statusCode: 474697,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 7,
metadata: [
{
ratingKey: "96",
key: "/playlists/96/items",
guid: "com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55",
type: "playlist",
title: "A Great Playlist",
summary: "What a great playlist",
smart: false,
playlistType: "video",
icon: "playlist://image.smart",
viewCount: 1,
lastViewedAt: 1705719589,
leafCount: 1,
addedAt: 1705719589,
updatedAt: 1705724593,
composite: "/playlists/96/composite/1705724593",
duration: 141000,
},
],
},
},
};
```
## 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` | [models.CreatePlaylistResponseBody](../models/createplaylistresponsebody.md) | :heavy_minus_sign: | returns all playlists |

18
docs/models/deletelibraryresponsebody.md
View File

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

18
docs/models/deleteplaylistresponsebody.md
View File

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

18
docs/models/enablepapertrailresponsebody.md
View File

@@ -1,18 +0,0 @@
# EnablePaperTrailResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { EnablePaperTrailResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `errors` | [models.EnablePaperTrailErrors](../models/enablepapertrailerrors.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 |

17
docs/models/feature.md
View File

@@ -1,17 +0,0 @@
# Feature
## Example Usage
```typescript
import { Feature } from "@lukehagar/plexjs";
let value: Feature = {};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| `key` | *string* | :heavy_minus_sign: | N/A |
| `type` | *string* | :heavy_minus_sign: | N/A |
| `directory` | [models.GetMediaProvidersDirectory](../models/getmediaprovidersdirectory.md)[] | :heavy_minus_sign: | N/A |

24
docs/models/fieldtype.md
View File

@@ -1,24 +0,0 @@
# FieldType
## Example Usage
```typescript
import { FieldType } from "@lukehagar/plexjs";
let value: FieldType = {
type: "resolution",
operator: [
{
key: "=",
title: "is",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| `type` | *string* | :heavy_minus_sign: | N/A | resolution |
| `operator` | [models.Operator](../models/operator.md)[] | :heavy_minus_sign: | N/A | |

39
docs/models/friend.md
View File

@@ -1,39 +0,0 @@
# Friend
## Example Usage
```typescript
import { Friend, Status } from "@lukehagar/plexjs";
let value: Friend = {
email: "username@email.com",
friendlyName: "exampleUser",
home: true,
id: 0,
restricted: false,
sharedServers: [{}],
sharedSources: [{}],
status: Status.Accepted,
thumb: "https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578",
title: "username123",
username: "username123",
uuid: "7d1916e0d8f6e76b",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `email` | *string* | :heavy_check_mark: | The account email address | username@email.com |
| `friendlyName` | *string* | :heavy_check_mark: | The account full name | exampleUser |
| `home` | *boolean* | :heavy_check_mark: | If the account is a Plex Home user | |
| `id` | *number* | :heavy_check_mark: | The Plex account ID | |
| `restricted` | *boolean* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
| `sharedServers` | [models.SharedServers](../models/sharedservers.md)[] | :heavy_check_mark: | N/A | |
| `sharedSources` | [models.SharedSources](../models/sharedsources.md)[] | :heavy_check_mark: | N/A | |
| `status` | [models.Status](../models/status.md) | :heavy_check_mark: | Current friend request status | accepted |
| `thumb` | *string* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578 |
| `title` | *string* | :heavy_check_mark: | The title of the account (username or friendly name) | username123 |
| `username` | *string* | :heavy_check_mark: | The account username | username123 |
| `uuid` | *string* | :heavy_check_mark: | The account Universally Unique Identifier (UUID) | 7d1916e0d8f6e76b |

62
docs/models/getalllibrariesdirectory.md
View File

@@ -1,62 +0,0 @@
# GetAllLibrariesDirectory
## Example Usage
```typescript
import { GetAllLibrariesDirectory } from "@lukehagar/plexjs";
let value: GetAllLibrariesDirectory = {
allowSync: true,
art: "/:/resources/movie-fanart.jpg",
composite: "/library/sections/1/composite/1705615584",
filters: true,
refreshing: false,
thumb: "/:/resources/movie.png",
key: "1",
type: "movie",
title: "Movies",
agent: "tv.plex.agents.movie",
scanner: "Plex Movie",
language: "en-US",
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
updatedAt: 1556281940,
createdAt: 1556281940,
scannedAt: 1556281940,
content: true,
directory: true,
contentChangedAt: 3192854,
hidden: 0,
location: [
{
id: 1,
path: "/movies",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
| `art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `composite` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/composite/1705615584 |
| `filters` | *boolean* | :heavy_minus_sign: | N/A | true |
| `refreshing` | *boolean* | :heavy_minus_sign: | N/A | false |
| `thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
| `key` | *string* | :heavy_minus_sign: | N/A | 1 |
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
| `title` | *string* | :heavy_minus_sign: | N/A | Movies |
| `agent` | *string* | :heavy_minus_sign: | N/A | tv.plex.agents.movie |
| `scanner` | *string* | :heavy_minus_sign: | N/A | Plex Movie |
| `language` | *string* | :heavy_minus_sign: | N/A | en-US |
| `uuid` | *string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `createdAt` | *number* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `scannedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `content` | *boolean* | :heavy_minus_sign: | N/A | true |
| `directory` | *boolean* | :heavy_minus_sign: | N/A | true |
| `contentChangedAt` | *number* | :heavy_minus_sign: | N/A | 3192854 |
| `hidden` | *number* | :heavy_minus_sign: | N/A | 0 |
| `location` | [models.Location](../models/location.md)[] | :heavy_minus_sign: | N/A | |

18
docs/models/getalllibrarieslibraryresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetAllLibrariesLibraryResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetAllLibrariesLibraryResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.GetAllLibrariesErrors](../models/getalllibrarieserrors.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 |

52
docs/models/getalllibrariesmediacontainer.md
View File

@@ -1,52 +0,0 @@
# GetAllLibrariesMediaContainer
## Example Usage
```typescript
import { GetAllLibrariesMediaContainer } from "@lukehagar/plexjs";
let value: GetAllLibrariesMediaContainer = {
size: 5,
allowSync: false,
title1: "Plex Library",
directory: [
{
allowSync: true,
art: "/:/resources/movie-fanart.jpg",
composite: "/library/sections/1/composite/1705615584",
filters: true,
refreshing: false,
thumb: "/:/resources/movie.png",
key: "1",
type: "movie",
title: "Movies",
agent: "tv.plex.agents.movie",
scanner: "Plex Movie",
language: "en-US",
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
updatedAt: 1556281940,
createdAt: 1556281940,
scannedAt: 1556281940,
content: true,
directory: true,
contentChangedAt: 3192854,
hidden: 0,
location: [
{
id: 1,
path: "/movies",
},
],
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `size` | *number* | :heavy_check_mark: | N/A | 5 |
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
| `title1` | *string* | :heavy_check_mark: | N/A | Plex Library |
| `directory` | [models.GetAllLibrariesDirectory](../models/getalllibrariesdirectory.md)[] | :heavy_minus_sign: | N/A | |

61
docs/models/getalllibrariesresponse.md
View File

@@ -1,61 +0,0 @@
# GetAllLibrariesResponse
## Example Usage
```typescript
import { GetAllLibrariesResponse } from "@lukehagar/plexjs";
let value: GetAllLibrariesResponse = {
contentType: "<value>",
statusCode: 613064,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 5,
allowSync: false,
title1: "Plex Library",
directory: [
{
allowSync: true,
art: "/:/resources/movie-fanart.jpg",
composite: "/library/sections/1/composite/1705615584",
filters: true,
refreshing: false,
thumb: "/:/resources/movie.png",
key: "1",
type: "movie",
title: "Movies",
agent: "tv.plex.agents.movie",
scanner: "Plex Movie",
language: "en-US",
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
updatedAt: 1556281940,
createdAt: 1556281940,
scannedAt: 1556281940,
content: true,
directory: true,
contentChangedAt: 3192854,
hidden: 0,
location: [
{
id: 1,
path: "/movies",
},
],
},
],
},
},
};
```
## 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` | [models.GetAllLibrariesResponseBody](../models/getalllibrariesresponsebody.md) | :heavy_minus_sign: | The libraries available on the Server |

33
docs/models/getavailableclientsmediacontainer.md
View File

@@ -1,33 +0,0 @@
# GetAvailableClientsMediaContainer
## Example Usage
```typescript
import { GetAvailableClientsMediaContainer } from "@lukehagar/plexjs";
let value: GetAvailableClientsMediaContainer = {
size: 1,
server: [
{
name: "iPad",
host: "10.10.10.102",
address: "10.10.10.102",
port: 32500,
machineIdentifier: "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05",
version: "8.17",
protocol: "plex",
product: "Plex for iOS",
deviceClass: "tablet",
protocolVersion: 2,
protocolCapabilities: "playback,playqueues,timeline,provider-playback",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `size` | *number* | :heavy_minus_sign: | N/A | 1 |
| `server` | [models.GetAvailableClientsServer](../models/getavailableclientsserver.md)[] | :heavy_minus_sign: | N/A | |

44
docs/models/getavailableclientsresponse.md
View File

@@ -1,44 +0,0 @@
# GetAvailableClientsResponse
## Example Usage
```typescript
import { GetAvailableClientsResponse } from "@lukehagar/plexjs";
let value: GetAvailableClientsResponse = {
contentType: "<value>",
statusCode: 715190,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 1,
server: [
{
name: "iPad",
host: "10.10.10.102",
address: "10.10.10.102",
port: 32500,
machineIdentifier: "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05",
version: "8.17",
protocol: "plex",
product: "Plex for iOS",
deviceClass: "tablet",
protocolVersion: 2,
protocolCapabilities: "playback,playqueues,timeline,provider-playback",
},
],
},
},
};
```
## 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` | [models.GetAvailableClientsResponseBody](../models/getavailableclientsresponsebody.md) | :heavy_minus_sign: | Available Clients |

36
docs/models/getavailableclientsresponsebody.md
View File

@@ -1,36 +0,0 @@
# GetAvailableClientsResponseBody
Available Clients
## Example Usage
```typescript
import { GetAvailableClientsResponseBody } from "@lukehagar/plexjs";
let value: GetAvailableClientsResponseBody = {
mediaContainer: {
size: 1,
server: [
{
name: "iPad",
host: "10.10.10.102",
address: "10.10.10.102",
port: 32500,
machineIdentifier: "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05",
version: "8.17",
protocol: "plex",
product: "Plex for iOS",
deviceClass: "tablet",
protocolVersion: 2,
protocolCapabilities: "playback,playqueues,timeline,provider-playback",
},
],
},
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `mediaContainer` | [models.GetAvailableClientsMediaContainer](../models/getavailableclientsmediacontainer.md) | :heavy_minus_sign: | N/A |

18
docs/models/getavailableclientsserverresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetAvailableClientsServerResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetAvailableClientsServerResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `errors` | [models.GetAvailableClientsErrors](../models/getavailableclientserrors.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 |

51
docs/models/getbandwidthstatisticsmediacontainer.md
View File

@@ -1,51 +0,0 @@
# GetBandwidthStatisticsMediaContainer
## Example Usage
```typescript
import { GetBandwidthStatisticsMediaContainer } from "@lukehagar/plexjs";
let value: GetBandwidthStatisticsMediaContainer = {
size: 5497,
device: [
{
id: 208,
name: "Roku Express",
platform: "Roku",
clientIdentifier: "793095d235660625108ef785cc7646e9",
createdAt: 1706470556,
},
],
account: [
{
id: 238960586,
key: "/accounts/238960586",
name: "Diane",
defaultAudioLanguage: "en",
autoSelectAudio: true,
defaultSubtitleLanguage: "en",
subtitleMode: 1,
thumb: "https://plex.tv/users/50d83634246da1de/avatar?c=1707110967",
},
],
statisticsBandwidth: [
{
accountID: 238960586,
deviceID: 208,
timespan: 6,
at: 1718387650,
lan: true,
bytes: 22,
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `size` | *number* | :heavy_minus_sign: | N/A | 5497 |
| `device` | [models.GetBandwidthStatisticsDevice](../models/getbandwidthstatisticsdevice.md)[] | :heavy_minus_sign: | N/A | |
| `account` | [models.GetBandwidthStatisticsAccount](../models/getbandwidthstatisticsaccount.md)[] | :heavy_minus_sign: | N/A | |
| `statisticsBandwidth` | [models.StatisticsBandwidth](../models/statisticsbandwidth.md)[] | :heavy_minus_sign: | N/A | |

60
docs/models/getbandwidthstatisticsresponse.md
View File

@@ -1,60 +0,0 @@
# GetBandwidthStatisticsResponse
## Example Usage
```typescript
import { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs";
let value: GetBandwidthStatisticsResponse = {
contentType: "<value>",
statusCode: 916723,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 5497,
device: [
{
id: 208,
name: "Roku Express",
platform: "Roku",
clientIdentifier: "793095d235660625108ef785cc7646e9",
createdAt: 1706470556,
},
],
account: [
{
id: 238960586,
key: "/accounts/238960586",
name: "Diane",
defaultAudioLanguage: "en",
autoSelectAudio: true,
defaultSubtitleLanguage: "en",
subtitleMode: 1,
thumb: "https://plex.tv/users/50d83634246da1de/avatar?c=1707110967",
},
],
statisticsBandwidth: [
{
accountID: 238960586,
deviceID: 208,
timespan: 6,
at: 1718387650,
lan: true,
bytes: 22,
},
],
},
},
};
```
## 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` | [models.GetBandwidthStatisticsResponseBody](../models/getbandwidthstatisticsresponsebody.md) | :heavy_minus_sign: | Bandwidth Statistics |

18
docs/models/getbandwidthstatisticsstatisticsresponsebody.md
View File

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

18
docs/models/getbannerimageresponsebody.md
View File

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

18
docs/models/getbutlertasksbutlerresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetButlerTasksButlerResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetButlerTasksButlerResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.GetButlerTasksErrors](../models/getbutlertaskserrors.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 |

37
docs/models/getbutlertasksresponse.md
View File

@@ -1,37 +0,0 @@
# GetButlerTasksResponse
## Example Usage
```typescript
import { GetButlerTasksResponse } from "@lukehagar/plexjs";
let value: GetButlerTasksResponse = {
contentType: "<value>",
statusCode: 812169,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
object: {
butlerTasks: {
butlerTask: [
{
name: "BackupDatabase",
interval: 3,
title: "Backup Database",
description:
"Create a backup copy of the server's database in the configured backup directory",
},
],
},
},
};
```
## 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` | [models.GetButlerTasksResponseBody](../models/getbutlertasksresponsebody.md) | :heavy_minus_sign: | All butler tasks |

29
docs/models/getbutlertasksresponsebody.md
View File

@@ -1,29 +0,0 @@
# GetButlerTasksResponseBody
All butler tasks
## Example Usage
```typescript
import { GetButlerTasksResponseBody } from "@lukehagar/plexjs";
let value: GetButlerTasksResponseBody = {
butlerTasks: {
butlerTask: [
{
name: "BackupDatabase",
interval: 3,
title: "Backup Database",
description:
"Create a backup copy of the server's database in the configured backup directory",
},
],
},
};
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `butlerTasks` | [models.ButlerTasks](../models/butlertasks.md) | :heavy_minus_sign: | N/A |

34
docs/models/getcompanionsdataresponse.md
View File

@@ -1,34 +0,0 @@
# GetCompanionsDataResponse
## Example Usage
```typescript
import { GetCompanionsDataResponse } from "@lukehagar/plexjs";
let value: GetCompanionsDataResponse = {
contentType: "<value>",
statusCode: 87129,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
responseBodies: [
{
identifier: "tv.plex.sonos",
baseURL: "https://sonos.plex.tv",
title: "Sonos",
linkURL: "https://sonos.plex.tv/link",
provides: "client,player",
token: "<value>",
},
],
};
```
## 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 |
| `responseBodies` | [models.ResponseBody](../models/responsebody.md)[] | :heavy_minus_sign: | Companions Data |

18
docs/models/getcompanionsdataresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetCompanionsDataResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetCompanionsDataResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `errors` | [models.GetCompanionsDataErrors](../models/getcompanionsdataerrors.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 |

28
docs/models/getdevicesmediacontainer.md
View File

@@ -1,28 +0,0 @@
# GetDevicesMediaContainer
## Example Usage
```typescript
import { GetDevicesMediaContainer } from "@lukehagar/plexjs";
let value: GetDevicesMediaContainer = {
size: 151,
identifier: "com.plexapp.system.devices",
device: [
{
id: 1,
name: "iPhone",
platform: "iOS",
createdAt: 1654131230,
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
| `size` | *number* | :heavy_minus_sign: | N/A | 151 |
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.system.devices |
| `device` | [models.Device](../models/device.md)[] | :heavy_minus_sign: | N/A | |

38
docs/models/getdevicesresponse.md
View File

@@ -1,38 +0,0 @@
# GetDevicesResponse
## Example Usage
```typescript
import { GetDevicesResponse } from "@lukehagar/plexjs";
let value: GetDevicesResponse = {
contentType: "<value>",
statusCode: 844266,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 151,
identifier: "com.plexapp.system.devices",
device: [
{
id: 1,
name: "iPhone",
platform: "iOS",
createdAt: 1654131230,
},
],
},
},
};
```
## 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` | [models.GetDevicesResponseBody](../models/getdevicesresponsebody.md) | :heavy_minus_sign: | Devices |

30
docs/models/getdevicesresponsebody.md
View File

@@ -1,30 +0,0 @@
# GetDevicesResponseBody
Devices
## Example Usage
```typescript
import { GetDevicesResponseBody } from "@lukehagar/plexjs";
let value: GetDevicesResponseBody = {
mediaContainer: {
size: 151,
identifier: "com.plexapp.system.devices",
device: [
{
id: 1,
name: "iPhone",
platform: "iOS",
createdAt: 1654131230,
},
],
},
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `mediaContainer` | [models.GetDevicesMediaContainer](../models/getdevicesmediacontainer.md) | :heavy_minus_sign: | N/A |

18
docs/models/getdevicesserverresponsebody.md
View File

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

18
docs/models/getfilehashresponsebody.md
View File

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

18
docs/models/getgeodataresponsebody.md
View File

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

18
docs/models/getglobalhubshubsresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetGlobalHubsHubsResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetGlobalHubsHubsResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.GetGlobalHubsErrors](../models/getglobalhubserrors.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 |

57
docs/models/getglobalhubsmediacontainer.md
View File

@@ -1,57 +0,0 @@
# GetGlobalHubsMediaContainer
## Example Usage
```typescript
import { GetGlobalHubsMediaContainer } from "@lukehagar/plexjs";
let value: GetGlobalHubsMediaContainer = {
size: 8,
allowSync: true,
identifier: "com.plexapp.plugins.library",
hub: [
{
hubKey: "/library/metadata/50768,65523,58188,57341,57302,57070",
key: "/playlists/all?type=15&sort=lastViewedAt:desc&playlistType=video,audio",
title: "Recent Playlists",
type: "playlist",
hubIdentifier: "home.playlists",
context: "hub.home.playlists",
size: 6,
more: true,
style: "shelf",
promoted: true,
metadata: [
{
ratingKey: "57070",
key: "/playlists/57070/items",
guid: "com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c",
type: "playlist",
title: "November Movie Day",
titleSort: "Tracks",
summary: "",
smart: false,
playlistType: "video",
composite: "/playlists/57070/composite/1668787730",
icon: "playlist://image.smart",
viewCount: 2,
lastViewedAt: 1668787732,
duration: 16873000,
leafCount: 3,
addedAt: 1668779618,
updatedAt: 1668787730,
},
],
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `size` | *number* | :heavy_minus_sign: | N/A | 8 |
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `hub` | [models.Hub](../models/hub.md)[] | :heavy_minus_sign: | N/A | |

18
docs/models/gethomedataplexresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetHomeDataPlexResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetHomeDataPlexResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.GetHomeDataErrors](../models/gethomedataerrors.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 |

30
docs/models/gethomedataresponse.md
View File

@@ -1,30 +0,0 @@
# GetHomeDataResponse
## Example Usage
```typescript
import { GetHomeDataResponse } from "@lukehagar/plexjs";
let value: GetHomeDataResponse = {
contentType: "<value>",
statusCode: 368241,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
object: {
id: 1841489,
name: "Blindkitty38's home",
guestUserID: 58815432,
guestUserUUID: "f3df4e01bfca0787",
},
};
```
## 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` | [models.GetHomeDataResponseBody](../models/gethomedataresponsebody.md) | :heavy_minus_sign: | Home Data |

18
docs/models/getlibrarydetailslibraryresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetLibraryDetailsLibraryResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetLibraryDetailsLibraryResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `errors` | [models.GetLibraryDetailsErrors](../models/getlibrarydetailserrors.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 |

97
docs/models/getlibrarydetailsmediacontainer.md
View File

@@ -1,97 +0,0 @@
# GetLibraryDetailsMediaContainer
## Example Usage
```typescript
import { GetLibraryDetailsMediaContainer } from "@lukehagar/plexjs";
let value: GetLibraryDetailsMediaContainer = {
size: 29,
allowSync: false,
art: "/:/resources/movie-fanart.jpg",
content: "secondary",
identifier: "com.plexapp.plugins.library",
librarySectionID: 1,
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1701731894,
thumb: "/:/resources/movie.png",
title1: "Movies",
viewGroup: "secondary",
viewMode: 65592,
directory: [
{
key: "search?type=1",
title: "Search...",
secondary: true,
prompt: "Search Movies",
search: true,
},
],
type: [
{
key: "/library/sections/1/all?type=1",
type: "movie",
title: "Movies",
active: false,
filter: [
{
filter: "label",
filterType: "string",
key: "/library/sections/1/label",
title: "Labels",
type: "filter",
},
],
sort: [
{
default: "asc",
defaultDirection: "desc",
descKey: "random:desc",
firstCharacterKey: "/library/sections/1/firstCharacter",
key: "random",
title: "Randomly",
},
],
field: [
{
key: "label",
title: "Label",
type: "tag",
subType: "bitrate",
},
],
},
],
fieldType: [
{
type: "resolution",
operator: [
{
key: "=",
title: "is",
},
],
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| `size` | *number* | :heavy_minus_sign: | N/A | 29 |
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | false |
| `art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `content` | *string* | :heavy_minus_sign: | N/A | secondary |
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
| `mediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *number* | :heavy_minus_sign: | N/A | 1701731894 |
| `thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
| `title1` | *string* | :heavy_minus_sign: | N/A | Movies |
| `viewGroup` | *string* | :heavy_minus_sign: | N/A | secondary |
| `viewMode` | *number* | :heavy_minus_sign: | N/A | 65592 |
| `directory` | [models.GetLibraryDetailsDirectory](../models/getlibrarydetailsdirectory.md)[] | :heavy_minus_sign: | N/A | |
| `type` | [models.GetLibraryDetailsType](../models/getlibrarydetailstype.md)[] | :heavy_minus_sign: | N/A | |
| `fieldType` | [models.FieldType](../models/fieldtype.md)[] | :heavy_minus_sign: | N/A | |

53
docs/models/getlibrarydetailstype.md
View File

@@ -1,53 +0,0 @@
# GetLibraryDetailsType
## Example Usage
```typescript
import { GetLibraryDetailsType } from "@lukehagar/plexjs";
let value: GetLibraryDetailsType = {
key: "/library/sections/1/all?type=1",
type: "movie",
title: "Movies",
active: false,
filter: [
{
filter: "label",
filterType: "string",
key: "/library/sections/1/label",
title: "Labels",
type: "filter",
},
],
sort: [
{
default: "asc",
defaultDirection: "desc",
descKey: "random:desc",
firstCharacterKey: "/library/sections/1/firstCharacter",
key: "random",
title: "Randomly",
},
],
field: [
{
key: "label",
title: "Label",
type: "tag",
subType: "bitrate",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `key` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/all?type=1 |
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
| `title` | *string* | :heavy_minus_sign: | N/A | Movies |
| `active` | *boolean* | :heavy_minus_sign: | N/A | false |
| `filter` | [models.GetLibraryDetailsFilter](../models/getlibrarydetailsfilter.md)[] | :heavy_minus_sign: | N/A | |
| `sort` | [models.Sort](../models/sort.md)[] | :heavy_minus_sign: | N/A | |
| `field` | [models.Field](../models/field.md)[] | :heavy_minus_sign: | N/A | |

131
docs/models/getlibraryhubshub.md
View File

@@ -1,131 +0,0 @@
# GetLibraryHubsHub
## Example Usage
```typescript
import { GetLibraryHubsHub } from "@lukehagar/plexjs";
import { RFCDate } from "@lukehagar/plexjs/types";
let value: GetLibraryHubsHub = {
key: "/library/sections/1/all?sort=lastViewedAt:desc&unwatched=0&viewOffset=0",
title: "Recently Played Movies",
type: "movie",
hubIdentifier: "movie.recentlyviewed.1",
context: "hub.movie.recentlyviewed",
size: 6,
more: true,
style: "shelf",
hubKey: "/library/metadata/66485,66098,57249,11449,5858,14944",
metadata: [
{
ratingKey: "14944",
key: "/library/metadata/14944",
guid: "plex://movie/5d77686eeb5d26001f1eb339",
studio: "Walt Disney Animation Studios",
type: "movie",
title: "Tangled",
librarySectionTitle: "Movies",
librarySectionID: 1,
librarySectionKey: "/library/sections/1",
contentRating: "PG",
summary:
"The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.",
rating: 8.9,
audienceRating: 8.7,
viewCount: 1,
lastViewedAt: 1704936047,
year: 2010,
tagline: "They're taking adventure to new lengths.",
thumb: "/library/metadata/14944/thumb/1705739847",
art: "/library/metadata/14944/art/1705739847",
duration: 6017237,
originallyAvailableAt: new RFCDate("2010-11-24T00:00:00Z"),
addedAt: 1589412494,
updatedAt: 1705739847,
audienceRatingImage: "rottentomatoes://image.rating.upright",
primaryExtraKey: "/library/metadata/14952",
ratingImage: "rottentomatoes://image.rating.ripe",
media: [
{
id: 38247,
duration: 6017237,
bitrate: 2051,
width: 1920,
height: 1080,
aspectRatio: 1.78,
audioChannels: 2,
audioCodec: "aac",
videoCodec: "h264",
videoResolution: "1080",
container: "mp4",
videoFrameRate: "24p",
optimizedForStreaming: 1,
audioProfile: "lc",
has64bitOffsets: false,
videoProfile: "high",
part: [
{
id: 38247,
key: "/library/parts/38247/1589412494/file.mp4",
duration: 6017237,
file: "/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4",
size: 1545647447,
audioProfile: "lc",
container: "mp4",
has64bitOffsets: false,
optimizedForStreaming: true,
videoProfile: "high",
},
],
},
],
genre: [
{
tag: "Animation",
},
],
country: [
{
tag: "United States of America",
},
],
director: [
{
tag: "Nathan Greno",
},
],
role: [
{
tag: "Donna Murphy",
},
],
writer: [
{
tag: "Wilhelm Grimm",
},
],
skipCount: 1,
chapterSource: "media",
},
],
promoted: true,
random: true,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| `key` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/all?sort=lastViewedAt:desc&unwatched=0&viewOffset=0 |
| `title` | *string* | :heavy_minus_sign: | N/A | Recently Played Movies |
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
| `hubIdentifier` | *string* | :heavy_minus_sign: | N/A | movie.recentlyviewed.1 |
| `context` | *string* | :heavy_minus_sign: | N/A | hub.movie.recentlyviewed |
| `size` | *number* | :heavy_minus_sign: | N/A | 6 |
| `more` | *boolean* | :heavy_minus_sign: | N/A | true |
| `style` | *string* | :heavy_minus_sign: | N/A | shelf |
| `hubKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66485,66098,57249,11449,5858,14944 |
| `metadata` | [models.GetLibraryHubsMetadata](../models/getlibraryhubsmetadata.md)[] | :heavy_minus_sign: | N/A | |
| `promoted` | *boolean* | :heavy_minus_sign: | N/A | true |
| `random` | *boolean* | :heavy_minus_sign: | N/A | true |

18
docs/models/getlibraryhubshubsresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetLibraryHubsHubsResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetLibraryHubsHubsResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.GetLibraryHubsErrors](../models/getlibraryhubserrors.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 |

62
docs/models/getlibraryhubsmedia.md
View File

@@ -1,62 +0,0 @@
# GetLibraryHubsMedia
## Example Usage
```typescript
import { GetLibraryHubsMedia } from "@lukehagar/plexjs";
let value: GetLibraryHubsMedia = {
id: 38247,
duration: 6017237,
bitrate: 2051,
width: 1920,
height: 1080,
aspectRatio: 1.78,
audioChannels: 2,
audioCodec: "aac",
videoCodec: "h264",
videoResolution: "1080",
container: "mp4",
videoFrameRate: "24p",
optimizedForStreaming: 1,
audioProfile: "lc",
has64bitOffsets: false,
videoProfile: "high",
part: [
{
id: 38247,
key: "/library/parts/38247/1589412494/file.mp4",
duration: 6017237,
file: "/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4",
size: 1545647447,
audioProfile: "lc",
container: "mp4",
has64bitOffsets: false,
optimizedForStreaming: true,
videoProfile: "high",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 38247 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 6017237 |
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 2051 |
| `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 | h264 |
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 1080 |
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
| `optimizedForStreaming` | *number* | :heavy_minus_sign: | N/A | 1 |
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
| `part` | [models.GetLibraryHubsPart](../models/getlibraryhubspart.md)[] | :heavy_minus_sign: | N/A | |

18
docs/models/getlibraryitemslibraryresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetLibraryItemsLibraryResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetLibraryItemsLibraryResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.GetLibraryItemsErrors](../models/getlibraryitemserrors.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 |

53
docs/models/getlibraryitemsmedia.md
View File

@@ -1,53 +0,0 @@
# GetLibraryItemsMedia
## Example Usage
```typescript
import { GetLibraryItemsMedia } from "@lukehagar/plexjs";
let value: GetLibraryItemsMedia = {
id: 119534,
duration: 11558112,
bitrate: 25025,
width: 3840,
height: 2072,
aspectRatio: 1.85,
audioChannels: 6,
audioCodec: "eac3",
videoCodec: "hevc",
videoResolution: "4k",
container: "mkv",
videoFrameRate: "24p",
videoProfile: "main 10",
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",
videoProfile: "main 10",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 119534 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 25025 |
| `width` | *number* | :heavy_minus_sign: | N/A | 3840 |
| `height` | *number* | :heavy_minus_sign: | N/A | 2072 |
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 1.85 |
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 6 |
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | eac3 |
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | hevc |
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 4k |
| `container` | *string* | :heavy_minus_sign: | N/A | mkv |
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main 10 |
| `part` | [models.GetLibraryItemsPart](../models/getlibraryitemspart.md)[] | :heavy_minus_sign: | N/A | |

155
docs/models/getlibraryitemsmediacontainer.md
View File

@@ -1,155 +0,0 @@
# GetLibraryItemsMediaContainer
## Example Usage
```typescript
import { GetLibraryItemsMediaContainer } from "@lukehagar/plexjs";
import { RFCDate } from "@lukehagar/plexjs/types";
let value: GetLibraryItemsMediaContainer = {
size: 70,
allowSync: true,
art: "/:/resources/movie-fanart.jpg",
identifier: "com.plexapp.plugins.library",
librarySectionTitle: "Movies",
librarySectionUUID: "322a231a-b7f7-49f5-920f-14c61199cd30",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1701731894,
thumb: "/:/resources/movie.png",
title1: "Movies",
title2: "Recently Released",
viewGroup: "movie",
viewMode: 65592,
mixedParents: true,
metadata: [
{
ratingKey: "58683",
key: "/library/metadata/58683",
guid: "plex://movie/5d7768ba96b655001fdc0408",
studio: "20th Century Studios",
type: "movie",
title: "Avatar: The Way of Water",
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,
tagline: "Return to Pandora.",
thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236",
duration: 11558112,
originallyAvailableAt: new RFCDate("2022-12-14T00:00:00Z"),
addedAt: 1680457607,
updatedAt: 1703239236,
audienceRatingImage: "rottentomatoes://image.rating.upright",
chapterSource: "media",
primaryExtraKey: "/library/metadata/58684",
ratingImage: "rottentomatoes://image.rating.ripe",
grandparentRatingKey: "66",
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
grandparentKey: "/library/metadata/66",
grandparentTitle: "Caprica",
grandparentThumb: "/library/metadata/66/thumb/1705716261",
grandparentArt: "/library/metadata/66/art/1705716261",
grandparentTheme: "/library/metadata/66/theme/1705716261",
media: [
{
id: 119534,
duration: 11558112,
bitrate: 25025,
width: 3840,
height: 2072,
aspectRatio: 1.85,
audioChannels: 6,
audioCodec: "eac3",
videoCodec: "hevc",
videoResolution: "4k",
container: "mkv",
videoFrameRate: "24p",
videoProfile: "main 10",
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",
videoProfile: "main 10",
},
],
},
],
genre: [
{
tag: "Adventure",
},
],
country: [
{
tag: "United States of America",
},
],
director: [
{
tag: "James Cameron",
},
],
writer: [
{
tag: "James Cameron",
},
],
role: [
{
tag: "Sigourney Weaver",
},
],
titleSort: "Whale",
viewCount: 1,
lastViewedAt: 1682752242,
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
viewOffset: 5222500,
skipCount: 1,
index: 1,
theme: "/library/metadata/1/theme/1705636920",
leafCount: 14,
viewedLeafCount: 0,
childCount: 1,
hasPremiumExtras: "1",
hasPremiumPrimaryExtra: "1",
parentRatingKey: "66",
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
parentStudio: "UCP",
parentKey: "/library/metadata/66",
parentTitle: "Caprica",
parentIndex: 1,
parentYear: 2010,
parentThumb: "/library/metadata/66/thumb/1705716261",
parentTheme: "/library/metadata/66/theme/1705716261",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `size` | *number* | :heavy_minus_sign: | N/A | 70 |
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
| `art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `librarySectionID` | *models.LibrarySectionID* | :heavy_minus_sign: | N/A | |
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionUUID` | *string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `mediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *number* | :heavy_minus_sign: | N/A | 1701731894 |
| `thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
| `title1` | *string* | :heavy_minus_sign: | N/A | Movies |
| `title2` | *string* | :heavy_minus_sign: | N/A | Recently Released |
| `viewGroup` | *string* | :heavy_minus_sign: | N/A | movie |
| `viewMode` | *number* | :heavy_minus_sign: | N/A | 65592 |
| `mixedParents` | *boolean* | :heavy_minus_sign: | N/A | true |
| `metadata` | [models.GetLibraryItemsMetadata](../models/getlibraryitemsmetadata.md)[] | :heavy_minus_sign: | N/A | |

28
docs/models/getmediaprovidersdirectory.md
View File

@@ -1,28 +0,0 @@
# GetMediaProvidersDirectory
## Example Usage
```typescript
import { GetMediaProvidersDirectory } from "@lukehagar/plexjs";
let value: GetMediaProvidersDirectory = {};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `hubKey` | *string* | :heavy_minus_sign: | N/A |
| `title` | *string* | :heavy_minus_sign: | N/A |
| `agent` | *string* | :heavy_minus_sign: | N/A |
| `language` | *string* | :heavy_minus_sign: | N/A |
| `refreshing` | *boolean* | :heavy_minus_sign: | N/A |
| `scanner` | *string* | :heavy_minus_sign: | N/A |
| `uuid` | *string* | :heavy_minus_sign: | N/A |
| `id` | *string* | :heavy_minus_sign: | N/A |
| `key` | *string* | :heavy_minus_sign: | N/A |
| `type` | *string* | :heavy_minus_sign: | N/A |
| `subtype` | *string* | :heavy_minus_sign: | N/A |
| `updatedAt` | *number* | :heavy_minus_sign: | N/A |
| `scannedAt` | *number* | :heavy_minus_sign: | N/A |
| `pivot` | [models.Pivot](../models/pivot.md)[] | :heavy_minus_sign: | N/A |

58
docs/models/getmediaprovidersmediacontainer.md
View File

@@ -1,58 +0,0 @@
# GetMediaProvidersMediaContainer
## Example Usage
```typescript
import { GetMediaProvidersMediaContainer } from "@lukehagar/plexjs";
let value: GetMediaProvidersMediaContainer = {};
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| `size` | *number* | :heavy_minus_sign: | N/A |
| `allowCameraUpload` | *boolean* | :heavy_minus_sign: | N/A |
| `allowChannelAccess` | *boolean* | :heavy_minus_sign: | N/A |
| `allowSharing` | *boolean* | :heavy_minus_sign: | N/A |
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A |
| `allowTuners` | *boolean* | :heavy_minus_sign: | N/A |
| `backgroundProcessing` | *boolean* | :heavy_minus_sign: | N/A |
| `certificate` | *boolean* | :heavy_minus_sign: | N/A |
| `companionProxy` | *boolean* | :heavy_minus_sign: | N/A |
| `countryCode` | *string* | :heavy_minus_sign: | N/A |
| `diagnostics` | *string* | :heavy_minus_sign: | N/A |
| `eventStream` | *boolean* | :heavy_minus_sign: | N/A |
| `friendlyName` | *string* | :heavy_minus_sign: | N/A |
| `livetv` | *number* | :heavy_minus_sign: | N/A |
| `machineIdentifier` | *string* | :heavy_minus_sign: | N/A |
| `musicAnalysis` | *number* | :heavy_minus_sign: | N/A |
| `myPlex` | *boolean* | :heavy_minus_sign: | N/A |
| `myPlexMappingState` | *string* | :heavy_minus_sign: | N/A |
| `myPlexSigninState` | *string* | :heavy_minus_sign: | N/A |
| `myPlexSubscription` | *boolean* | :heavy_minus_sign: | N/A |
| `myPlexUsername` | *string* | :heavy_minus_sign: | N/A |
| `offlineTranscode` | *number* | :heavy_minus_sign: | N/A |
| `ownerFeatures` | *string* | :heavy_minus_sign: | N/A |
| `platform` | *string* | :heavy_minus_sign: | N/A |
| `platformVersion` | *string* | :heavy_minus_sign: | N/A |
| `pluginHost` | *boolean* | :heavy_minus_sign: | N/A |
| `pushNotifications` | *boolean* | :heavy_minus_sign: | N/A |
| `readOnlyLibraries` | *boolean* | :heavy_minus_sign: | N/A |
| `streamingBrainABRVersion` | *number* | :heavy_minus_sign: | N/A |
| `streamingBrainVersion` | *number* | :heavy_minus_sign: | N/A |
| `sync` | *boolean* | :heavy_minus_sign: | N/A |
| `transcoderActiveVideoSessions` | *number* | :heavy_minus_sign: | N/A |
| `transcoderAudio` | *boolean* | :heavy_minus_sign: | N/A |
| `transcoderLyrics` | *boolean* | :heavy_minus_sign: | N/A |
| `transcoderSubtitles` | *boolean* | :heavy_minus_sign: | N/A |
| `transcoderVideo` | *boolean* | :heavy_minus_sign: | N/A |
| `transcoderVideoBitrates` | *string* | :heavy_minus_sign: | N/A |
| `transcoderVideoQualities` | *string* | :heavy_minus_sign: | N/A |
| `transcoderVideoResolutions` | *string* | :heavy_minus_sign: | N/A |
| `updatedAt` | *number* | :heavy_minus_sign: | N/A |
| `updater` | *boolean* | :heavy_minus_sign: | N/A |
| `version` | *string* | :heavy_minus_sign: | N/A |
| `voiceSearch` | *boolean* | :heavy_minus_sign: | N/A |
| `mediaProvider` | [models.MediaProvider](../models/mediaprovider.md)[] | :heavy_minus_sign: | N/A |

24
docs/models/getmediaprovidersresponse.md
View File

@@ -1,24 +0,0 @@
# GetMediaProvidersResponse
## Example Usage
```typescript
import { GetMediaProvidersResponse } from "@lukehagar/plexjs";
let value: GetMediaProvidersResponse = {
contentType: "<value>",
statusCode: 437587,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
};
```
## 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` | [models.GetMediaProvidersResponseBody](../models/getmediaprovidersresponsebody.md) | :heavy_minus_sign: | Media providers and their features |

17
docs/models/getmediaprovidersresponsebody.md
View File

@@ -1,17 +0,0 @@
# GetMediaProvidersResponseBody
Media providers and their features
## Example Usage
```typescript
import { GetMediaProvidersResponseBody } from "@lukehagar/plexjs";
let value: GetMediaProvidersResponseBody = {};
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `mediaContainer` | [models.GetMediaProvidersMediaContainer](../models/getmediaprovidersmediacontainer.md) | :heavy_minus_sign: | N/A |

18
docs/models/getmediaprovidersserverresponsebody.md
View File

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

18
docs/models/getmetadatabyratingkeylibraryresponsebody.md
View File

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

98
docs/models/getmetadatabyratingkeymedia.md
View File

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

72
docs/models/getmetadatabyratingkeypart.md
View File

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

18
docs/models/getmetadatachildrenlibraryresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetMetadataChildrenLibraryResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetMetadataChildrenLibraryResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `errors` | [models.GetMetadataChildrenErrors](../models/getmetadatachildrenerrors.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 |

39
docs/models/getmyplexaccountresponse.md
View File

@@ -1,39 +0,0 @@
# GetMyPlexAccountResponse
## Example Usage
```typescript
import { GetMyPlexAccountResponse } from "@lukehagar/plexjs";
let value: GetMyPlexAccountResponse = {
contentType: "<value>",
statusCode: 857946,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
object: {
myPlex: {
authToken: "Z5v-PrNASDFpsaCi3CPK7",
username: "example.email@mail.com",
mappingState: "mapped",
signInState: "ok",
publicAddress: "140.20.68.140",
publicPort: 32400,
privateAddress: "10.10.10.47",
privatePort: 32400,
subscriptionFeatures:
"federated-auth,hardware_transcoding,home,hwtranscode,item_clusters,kevin-bacon,livetv,loudness,lyrics,music-analysis,music_videos,pass,photo_autotags,photos-v5,photosV6-edit,photosV6-tv-albums,premium_music_metadata,radio,server-manager,session_bandwidth_restrictions,session_kick,shared-radio,sync,trailers,tuner-sharing,type-first,unsupportedtuners,webhooks",
subscriptionState: "Active",
},
},
};
```
## 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` | [models.GetMyPlexAccountResponseBody](../models/getmyplexaccountresponsebody.md) | :heavy_minus_sign: | MyPlex Account |

18
docs/models/getmyplexaccountserverresponsebody.md
View File

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

18
docs/models/getondecklibraryresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetOnDeckLibraryResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetOnDeckLibraryResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.GetOnDeckErrors](../models/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 |

82
docs/models/getondeckmedia.md
View File

@@ -1,82 +0,0 @@
# GetOnDeckMedia
## Example Usage
```typescript
import { GetOnDeckMedia } from "@lukehagar/plexjs";
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` | [models.GetOnDeckPart](../models/getondeckpart.md)[] | :heavy_minus_sign: | N/A | |

58
docs/models/getondeckpart.md
View File

@@ -1,58 +0,0 @@
# GetOnDeckPart
## Example Usage
```typescript
import { GetOnDeckPart } from "@lukehagar/plexjs";
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` | [models.GetOnDeckStream](../models/getondeckstream.md)[] | :heavy_minus_sign: | N/A | |

62
docs/models/getplaylistcontentsmedia.md
View File

@@ -1,62 +0,0 @@
# GetPlaylistContentsMedia
## Example Usage
```typescript
import { GetPlaylistContentsMedia } from "@lukehagar/plexjs";
let value: GetPlaylistContentsMedia = {
id: 15,
duration: 141416,
bitrate: 2273,
width: 1920,
height: 814,
aspectRatio: 2.35,
audioChannels: 2,
audioCodec: "aac",
videoCodec: "h264",
videoResolution: "1080",
container: "mp4",
videoFrameRate: "24p",
optimizedForStreaming: 0,
audioProfile: "lc",
has64bitOffsets: false,
videoProfile: "high",
part: [
{
id: 15,
key: "/library/parts/15/1705637151/file.mp4",
duration: 141416,
file: "/movies/Serenity (2005)/Serenity (2005).mp4",
size: 40271948,
audioProfile: "lc",
container: "mp4",
has64bitOffsets: false,
optimizedForStreaming: false,
videoProfile: "high",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `id` | *number* | :heavy_minus_sign: | N/A | 15 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 141416 |
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 2273 |
| `width` | *number* | :heavy_minus_sign: | N/A | 1920 |
| `height` | *number* | :heavy_minus_sign: | N/A | 814 |
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 2.35 |
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 2 |
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | aac |
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | h264 |
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 1080 |
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
| `optimizedForStreaming` | *number* | :heavy_minus_sign: | N/A | 0 |
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
| `part` | [models.GetPlaylistContentsPart](../models/getplaylistcontentspart.md)[] | :heavy_minus_sign: | N/A | |

18
docs/models/getplaylistcontentsplaylistsresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetPlaylistContentsPlaylistsResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetPlaylistContentsPlaylistsResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `errors` | [models.GetPlaylistContentsErrors](../models/getplaylistcontentserrors.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 |

38
docs/models/getplaylistmediacontainer.md
View File

@@ -1,38 +0,0 @@
# GetPlaylistMediaContainer
## Example Usage
```typescript
import { GetPlaylistMediaContainer } from "@lukehagar/plexjs";
let value: GetPlaylistMediaContainer = {
size: 1,
metadata: [
{
content:
"library://x/directory/%2Flibrary%2Fsections%2F1%2Fall%3Ftype%3D1%26push%3D1%26title%3D2%26or%3D1%26title%3DSerenity%26pop%3D1",
ratingKey: "95",
key: "/playlists/95/items",
guid: "com.plexapp.agents.none://87425529-380f-44b8-a689-9a0537e7ec91",
type: "playlist",
title: "Smart Movie Playlist",
summary: "",
smart: true,
playlistType: "video",
composite: "/playlists/95/composite/1705717387",
icon: "playlist://image.smart",
duration: 282000,
leafCount: 2,
addedAt: 1705716493,
updatedAt: 1705717387,
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
| `size` | *number* | :heavy_minus_sign: | N/A | 1 |
| `metadata` | [models.GetPlaylistMetadata](../models/getplaylistmetadata.md)[] | :heavy_minus_sign: | N/A | |

18
docs/models/getplaylistplaylistsresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetPlaylistPlaylistsResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetPlaylistPlaylistsResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.GetPlaylistErrors](../models/getplaylisterrors.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 |

49
docs/models/getplaylistresponse.md
View File

@@ -1,49 +0,0 @@
# GetPlaylistResponse
## Example Usage
```typescript
import { GetPlaylistResponse } from "@lukehagar/plexjs";
let value: GetPlaylistResponse = {
contentType: "<value>",
statusCode: 110375,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 1,
metadata: [
{
content:
"library://x/directory/%2Flibrary%2Fsections%2F1%2Fall%3Ftype%3D1%26push%3D1%26title%3D2%26or%3D1%26title%3DSerenity%26pop%3D1",
ratingKey: "95",
key: "/playlists/95/items",
guid: "com.plexapp.agents.none://87425529-380f-44b8-a689-9a0537e7ec91",
type: "playlist",
title: "Smart Movie Playlist",
summary: "",
smart: true,
playlistType: "video",
composite: "/playlists/95/composite/1705717387",
icon: "playlist://image.smart",
duration: 282000,
leafCount: 2,
addedAt: 1705716493,
updatedAt: 1705717387,
},
],
},
},
};
```
## 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` | [models.GetPlaylistResponseBody](../models/getplaylistresponsebody.md) | :heavy_minus_sign: | The playlist |

38
docs/models/getplaylistsmediacontainer.md
View File

@@ -1,38 +0,0 @@
# GetPlaylistsMediaContainer
## Example Usage
```typescript
import { GetPlaylistsMediaContainer } from "@lukehagar/plexjs";
let value: GetPlaylistsMediaContainer = {
size: 4,
metadata: [
{
ratingKey: "92",
key: "/playlists/92/items",
guid: "com.plexapp.agents.none://7ca5aaef-58e8-4828-9e21-c009c97f2903",
type: "playlist",
title: "Static Playlist",
summary: "A Great Playlist",
smart: false,
playlistType: "video",
composite: "/playlists/92/composite/1705716440",
icon: "playlist://image.smart",
viewCount: 1,
lastViewedAt: 1705716298,
duration: 7328000,
leafCount: 32,
addedAt: 1705716298,
updatedAt: 1705716440,
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `size` | *number* | :heavy_minus_sign: | N/A | 4 |
| `metadata` | [models.GetPlaylistsMetadata](../models/getplaylistsmetadata.md)[] | :heavy_minus_sign: | N/A | |

18
docs/models/getplaylistsplaylistsresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetPlaylistsPlaylistsResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetPlaylistsPlaylistsResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.GetPlaylistsErrors](../models/getplaylistserrors.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 |

16
docs/models/getplaylistsrequest.md
View File

@@ -1,16 +0,0 @@
# GetPlaylistsRequest
## Example Usage
```typescript
import { GetPlaylistsRequest } from "@lukehagar/plexjs";
let value: GetPlaylistsRequest = {};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
| `playlistType` | [models.PlaylistType](../models/playlisttype.md) | :heavy_minus_sign: | limit to a type of playlist. |
| `smart` | [models.QueryParamSmart](../models/queryparamsmart.md) | :heavy_minus_sign: | type of playlists to return (default is all). |

49
docs/models/getplaylistsresponse.md
View File

@@ -1,49 +0,0 @@
# GetPlaylistsResponse
## Example Usage
```typescript
import { GetPlaylistsResponse } from "@lukehagar/plexjs";
let value: GetPlaylistsResponse = {
contentType: "<value>",
statusCode: 158969,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 4,
metadata: [
{
ratingKey: "92",
key: "/playlists/92/items",
guid: "com.plexapp.agents.none://7ca5aaef-58e8-4828-9e21-c009c97f2903",
type: "playlist",
title: "Static Playlist",
summary: "A Great Playlist",
smart: false,
playlistType: "video",
composite: "/playlists/92/composite/1705716440",
icon: "playlist://image.smart",
viewCount: 1,
lastViewedAt: 1705716298,
duration: 7328000,
leafCount: 32,
addedAt: 1705716298,
updatedAt: 1705716440,
},
],
},
},
};
```
## 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` | [models.GetPlaylistsResponseBody](../models/getplaylistsresponsebody.md) | :heavy_minus_sign: | returns all playlists |

41
docs/models/getplaylistsresponsebody.md
View File

@@ -1,41 +0,0 @@
# GetPlaylistsResponseBody
returns all playlists
## Example Usage
```typescript
import { GetPlaylistsResponseBody } from "@lukehagar/plexjs";
let value: GetPlaylistsResponseBody = {
mediaContainer: {
size: 4,
metadata: [
{
ratingKey: "92",
key: "/playlists/92/items",
guid: "com.plexapp.agents.none://7ca5aaef-58e8-4828-9e21-c009c97f2903",
type: "playlist",
title: "Static Playlist",
summary: "A Great Playlist",
smart: false,
playlistType: "video",
composite: "/playlists/92/composite/1705716440",
icon: "playlist://image.smart",
viewCount: 1,
lastViewedAt: 1705716298,
duration: 7328000,
leafCount: 32,
addedAt: 1705716298,
updatedAt: 1705716440,
},
],
},
};
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `mediaContainer` | [models.GetPlaylistsMediaContainer](../models/getplaylistsmediacontainer.md) | :heavy_minus_sign: | N/A |

18
docs/models/getrecentlyaddedlibraryresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetRecentlyAddedLibraryResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetRecentlyAddedLibraryResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `errors` | [models.GetRecentlyAddedErrors](../models/getrecentlyaddederrors.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 |

57
docs/models/getrecentlyaddedmedia.md
View File

@@ -1,57 +0,0 @@
# GetRecentlyAddedMedia
## Example Usage
```typescript
import { GetRecentlyAddedMedia } from "@lukehagar/plexjs";
let value: GetRecentlyAddedMedia = {
id: 120345,
duration: 7474422,
bitrate: 3623,
width: 1920,
height: 804,
aspectRatio: 2.35,
audioChannels: 6,
audioCodec: "ac3",
videoCodec: "h264",
videoResolution: 1080,
container: "mp4",
videoFrameRate: "24p",
optimizedForStreaming: 0,
videoProfile: "high",
part: [
{
id: 120353,
key: "/library/parts/120353/1681803203/file.mp4",
duration: 7474422,
file: "/movies/Ant-Man and the Wasp Quantumania (2023)/Ant-Man.and.the.Wasp.Quantumania.2023.1080p.mp4",
size: 3395307162,
container: "mp4",
hasThumbnail: 1,
videoProfile: "high",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 120345 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 7474422 |
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 3623 |
| `width` | *number* | :heavy_minus_sign: | N/A | 1920 |
| `height` | *number* | :heavy_minus_sign: | N/A | 804 |
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 2.35 |
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 6 |
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | ac3 |
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | h264 |
| `videoResolution` | *number* | :heavy_minus_sign: | N/A | 1080 |
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
| `optimizedForStreaming` | *number* | :heavy_minus_sign: | N/A | 0 |
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | |
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
| `part` | [models.Part](../models/part.md)[] | :heavy_minus_sign: | N/A | |

18
docs/models/getrefreshlibrarymetadataresponsebody.md
View File

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

18
docs/models/getresizedphotoresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetResizedPhotoResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetResizedPhotoResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.GetResizedPhotoErrors](../models/getresizedphotoerrors.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 |

28
docs/models/getresourcesstatisticsmediacontainer.md
View File

@@ -1,28 +0,0 @@
# GetResourcesStatisticsMediaContainer
## Example Usage
```typescript
import { GetResourcesStatisticsMediaContainer } from "@lukehagar/plexjs";
let value: GetResourcesStatisticsMediaContainer = {
size: 5497,
statisticsResources: [
{
timespan: 6,
at: 1718384427,
hostCpuUtilization: 1.276,
processCpuUtilization: 0.025,
hostMemoryUtilization: 17.026,
processMemoryUtilization: 0.493,
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
| `size` | *number* | :heavy_minus_sign: | N/A | 5497 |
| `statisticsResources` | [models.StatisticsResources](../models/statisticsresources.md)[] | :heavy_minus_sign: | N/A | |

39
docs/models/getresourcesstatisticsresponse.md
View File

@@ -1,39 +0,0 @@
# GetResourcesStatisticsResponse
## Example Usage
```typescript
import { GetResourcesStatisticsResponse } from "@lukehagar/plexjs";
let value: GetResourcesStatisticsResponse = {
contentType: "<value>",
statusCode: 523248,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 5497,
statisticsResources: [
{
timespan: 6,
at: 1718384427,
hostCpuUtilization: 1.276,
processCpuUtilization: 0.025,
hostMemoryUtilization: 17.026,
processMemoryUtilization: 0.493,
},
],
},
},
};
```
## 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` | [models.GetResourcesStatisticsResponseBody](../models/getresourcesstatisticsresponsebody.md) | :heavy_minus_sign: | Resource Statistics |

31
docs/models/getresourcesstatisticsresponsebody.md
View File

@@ -1,31 +0,0 @@
# GetResourcesStatisticsResponseBody
Resource Statistics
## Example Usage
```typescript
import { GetResourcesStatisticsResponseBody } from "@lukehagar/plexjs";
let value: GetResourcesStatisticsResponseBody = {
mediaContainer: {
size: 5497,
statisticsResources: [
{
timespan: 6,
at: 1718384427,
hostCpuUtilization: 1.276,
processCpuUtilization: 0.025,
hostMemoryUtilization: 17.026,
processMemoryUtilization: 0.493,
},
],
},
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `mediaContainer` | [models.GetResourcesStatisticsMediaContainer](../models/getresourcesstatisticsmediacontainer.md) | :heavy_minus_sign: | N/A |

18
docs/models/getresourcesstatisticsstatisticsresponsebody.md
View File

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

18
docs/models/getsearchlibrarylibraryresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetSearchLibraryLibraryResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetSearchLibraryLibraryResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `errors` | [models.GetSearchLibraryErrors](../models/getsearchlibraryerrors.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 |

65
docs/models/getsearchlibrarymediacontainer.md
View File

@@ -1,65 +0,0 @@
# GetSearchLibraryMediaContainer
## Example Usage
```typescript
import { GetSearchLibraryMediaContainer } from "@lukehagar/plexjs";
let value: GetSearchLibraryMediaContainer = {
size: 2,
allowSync: false,
art: "/:/resources/show-fanart.jpg",
identifier: "com.plexapp.plugins.library",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1698860922,
nocache: true,
thumb: "/:/resources/show.png",
title1: "TV Shows",
title2: "Search for ''",
viewGroup: "season",
viewMode: 65593,
metadata: [
{
ratingKey: "2",
key: "/library/metadata/2/children",
parentRatingKey: "1",
guid: "plex://season/602e67e766dfdb002c0a1b5b",
parentGuid: "plex://show/5d9c086c7d06d9001ffd27aa",
parentStudio: "Mutant Enemy Productions",
type: "season",
title: "Season 1",
parentKey: "/library/metadata/1",
parentTitle: "Firefly",
summary:
"Captain Malcolm 'Mal' Reynolds is a former galactic war veteran who is the captain of the transport ship \"Serenity\". Mal and his crew, ensign Zoe Alleyne Washburne; Zoe's husband, pilot Hoban 'Wash' Washburne; muscular mercenary Jayne Cobb; young mechanic Kaylee Frye; former Alliance medical officer Simon Tam; his disturbed teenage sister River (both on the run from the interplanetary government \"The Alliance\"); the beautiful courtesan Inara Serra; and preacher Shepherd Book do any jobs, legal or illegal, they can find as the Serenity crew travels across the outskirts of outer space.",
index: 1,
parentIndex: 1,
parentYear: 2002,
thumb: "/library/metadata/2/thumb/1705636920",
art: "/library/metadata/1/art/1705636920",
parentThumb: "/library/metadata/1/thumb/1705636920",
parentTheme: "/library/metadata/1/theme/1705636920",
addedAt: 1705636916,
updatedAt: 1705636920,
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `size` | *number* | :heavy_minus_sign: | N/A | 2 |
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | false |
| `art` | *string* | :heavy_minus_sign: | N/A | /:/resources/show-fanart.jpg |
| `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 | 1698860922 |
| `nocache` | *boolean* | :heavy_minus_sign: | N/A | true |
| `thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/show.png |
| `title1` | *string* | :heavy_minus_sign: | N/A | TV Shows |
| `title2` | *string* | :heavy_minus_sign: | N/A | Search for '' |
| `viewGroup` | *string* | :heavy_minus_sign: | N/A | season |
| `viewMode` | *number* | :heavy_minus_sign: | N/A | 65593 |
| `metadata` | [models.GetSearchLibraryMetadata](../models/getsearchlibrarymetadata.md)[] | :heavy_minus_sign: | N/A | |

56
docs/models/getsearchresultsmedia.md
View File

@@ -1,56 +0,0 @@
# GetSearchResultsMedia
## Example Usage
```typescript
import { GetSearchResultsMedia } from "@lukehagar/plexjs";
let value: GetSearchResultsMedia = {
id: 26610,
duration: 6612628,
bitrate: 4751,
width: 1916,
height: 796,
aspectRatio: 2.35,
audioChannels: 6,
audioCodec: "aac",
videoCodec: "hevc",
videoResolution: 1080,
container: "mkv",
videoFrameRate: "24p",
audioProfile: "lc",
videoProfile: "main 10",
part: [
{
id: 26610,
key: "/library/parts/26610/1589234571/file.mkv",
duration: 6612628,
file: "/movies/Mission Impossible (1996)/Mission Impossible (1996) Bluray-1080p.mkv",
size: 3926903851,
audioProfile: "lc",
container: "mkv",
videoProfile: "main 10",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `id` | *number* | :heavy_minus_sign: | N/A | 26610 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 6612628 |
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 4751 |
| `width` | *number* | :heavy_minus_sign: | N/A | 1916 |
| `height` | *number* | :heavy_minus_sign: | N/A | 796 |
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 2.35 |
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 6 |
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | aac |
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | hevc |
| `videoResolution` | *number* | :heavy_minus_sign: | N/A | 1080 |
| `container` | *string* | :heavy_minus_sign: | N/A | mkv |
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main 10 |
| `part` | [models.GetSearchResultsPart](../models/getsearchresultspart.md)[] | :heavy_minus_sign: | N/A | |

18
docs/models/getsearchresultssearchresponsebody.md
View File

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

18
docs/models/getserveractivitiesactivitiesresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetServerActivitiesActivitiesResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetServerActivitiesActivitiesResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `errors` | [models.GetServerActivitiesErrors](../models/getserveractivitieserrors.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 |

16
docs/models/getserveractivitiesmediacontainer.md
View File

@@ -1,16 +0,0 @@
# GetServerActivitiesMediaContainer
## Example Usage
```typescript
import { GetServerActivitiesMediaContainer } from "@lukehagar/plexjs";
let value: GetServerActivitiesMediaContainer = {};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| `size` | *number* | :heavy_minus_sign: | N/A |
| `activity` | [models.Activity](../models/activity.md)[] | :heavy_minus_sign: | N/A |

24
docs/models/getserveractivitiesresponse.md
View File

@@ -1,24 +0,0 @@
# GetServerActivitiesResponse
## Example Usage
```typescript
import { GetServerActivitiesResponse } from "@lukehagar/plexjs";
let value: GetServerActivitiesResponse = {
contentType: "<value>",
statusCode: 477665,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
};
```
## 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` | [models.GetServerActivitiesResponseBody](../models/getserveractivitiesresponsebody.md) | :heavy_minus_sign: | The Server Activities |

17
docs/models/getserveractivitiesresponsebody.md
View File

@@ -1,17 +0,0 @@
# GetServerActivitiesResponseBody
The Server Activities
## Example Usage
```typescript
import { GetServerActivitiesResponseBody } from "@lukehagar/plexjs";
let value: GetServerActivitiesResponseBody = {};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `mediaContainer` | [models.GetServerActivitiesMediaContainer](../models/getserveractivitiesmediacontainer.md) | :heavy_minus_sign: | N/A |

24
docs/models/getservercapabilitiesresponse.md
View File

@@ -1,24 +0,0 @@
# GetServerCapabilitiesResponse
## Example Usage
```typescript
import { GetServerCapabilitiesResponse } from "@lukehagar/plexjs";
let value: GetServerCapabilitiesResponse = {
contentType: "<value>",
statusCode: 548814,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
};
```
## 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` | [models.GetServerCapabilitiesResponseBody](../models/getservercapabilitiesresponsebody.md) | :heavy_minus_sign: | The Server Capabilities |

17
docs/models/getservercapabilitiesresponsebody.md
View File

@@ -1,17 +0,0 @@
# GetServerCapabilitiesResponseBody
The Server Capabilities
## Example Usage
```typescript
import { GetServerCapabilitiesResponseBody } from "@lukehagar/plexjs";
let value: GetServerCapabilitiesResponseBody = {};
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| `mediaContainer` | [models.MediaContainer](../models/mediacontainer.md) | :heavy_minus_sign: | N/A |

18
docs/models/getservercapabilitiesserverresponsebody.md
View File

@@ -1,18 +0,0 @@
# GetServerCapabilitiesServerResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetServerCapabilitiesServerResponseBody } from "@lukehagar/plexjs";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.Errors](../models/errors.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 |

31
docs/models/getserveridentityresponse.md
View File

@@ -1,31 +0,0 @@
# GetServerIdentityResponse
## Example Usage
```typescript
import { GetServerIdentityResponse } from "@lukehagar/plexjs";
let value: GetServerIdentityResponse = {
contentType: "<value>",
statusCode: 602763,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 0,
machineIdentifier: "96f2fe7a78c9dc1f16a16bedbe90f98149be16b4",
version: "1.31.3.6868-28fc46b27",
},
},
};
```
## 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` | [models.GetServerIdentityResponseBody](../models/getserveridentityresponsebody.md) | :heavy_minus_sign: | The Server Identity information |

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