LukeParke/plexjs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexjs.git synced 2025-12-06 12:37: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

31
docs/sdk/models/operations/account.md Normal file
View File

@@ -0,0 +1,31 @@
# Account
## Example Usage
```typescript
import { Account } from "@lukehagar/plexjs/sdk/models/operations";
let value: 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",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 238960586 |
| `key` | *string* | :heavy_minus_sign: | N/A | /accounts/238960586 |
| `name` | *string* | :heavy_minus_sign: | N/A | Diane |
| `defaultAudioLanguage` | *string* | :heavy_minus_sign: | N/A | en |
| `autoSelectAudio` | *boolean* | :heavy_minus_sign: | N/A | true |
| `defaultSubtitleLanguage` | *string* | :heavy_minus_sign: | N/A | en |
| `subtitleMode` | *number* | :heavy_minus_sign: | N/A | 1 |
| `thumb` | *string* | :heavy_minus_sign: | N/A | https://plex.tv/users/50d83634246da1de/avatar?c=1707110967 |

22
docs/sdk/models/operations/activity.md Normal file
View File

@@ -0,0 +1,22 @@
# Activity
## Example Usage
```typescript
import { Activity } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.Context](../../../sdk/models/operations/context.md) | :heavy_minus_sign: | N/A |

39
docs/sdk/models/operations/addplaylistcontentsmediacontainer.md Normal file
View File

@@ -0,0 +1,39 @@
# AddPlaylistContentsMediaContainer
## Example Usage
```typescript
import { AddPlaylistContentsMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.AddPlaylistContentsMetadata](../../../sdk/models/operations/addplaylistcontentsmetadata.md)[] | :heavy_minus_sign: | N/A | |

41
docs/sdk/models/operations/addplaylistcontentsmetadata.md Normal file
View File

@@ -0,0 +1,41 @@
# AddPlaylistContentsMetadata
## Example Usage
```typescript
import { AddPlaylistContentsMetadata } from "@lukehagar/plexjs/sdk/models/operations";
let value: AddPlaylistContentsMetadata = {
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 |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 94 |
| `key` | *string* | :heavy_minus_sign: | N/A | /playlists/94/items |
| `guid` | *string* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2 |
| `type` | *string* | :heavy_minus_sign: | N/A | playlist |
| `title` | *string* | :heavy_minus_sign: | N/A | A great playlist |
| `summary` | *string* | :heavy_minus_sign: | N/A | One of my great playlists |
| `smart` | *boolean* | :heavy_minus_sign: | N/A | false |
| `playlistType` | *string* | :heavy_minus_sign: | N/A | video |
| `composite` | *string* | :heavy_minus_sign: | N/A | /playlists/94/composite/1705800070 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 423000 |
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 3 |
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1705716458 |
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705800070 |

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

@@ -0,0 +1,21 @@
# AddPlaylistContentsRequest
## Example Usage
```typescript
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: AddPlaylistContentsRequest = {
playlistID: 6625.27,
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
playQueueID: 123,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| `playlistID` | *number* | :heavy_check_mark: | the ID of the playlist | |
| `uri` | *string* | :heavy_check_mark: | the content URI for the playlist | server://12345/com.plexapp.plugins.library/library/metadata/1 |
| `playQueueID` | *number* | :heavy_minus_sign: | the play queue to add to a playlist | 123 |

48
docs/sdk/models/operations/addplaylistcontentsresponse.md Normal file
View File

@@ -0,0 +1,48 @@
# AddPlaylistContentsResponse
## Example Usage
```typescript
import { AddPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.AddPlaylistContentsResponseBody](../../../sdk/models/operations/addplaylistcontentsresponsebody.md) | :heavy_minus_sign: | Playlist Updated |

40
docs/sdk/models/operations/addplaylistcontentsresponsebody.md Normal file
View File

@@ -0,0 +1,40 @@
# AddPlaylistContentsResponseBody
Playlist Updated
## Example Usage
```typescript
import { AddPlaylistContentsResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
let value: AddPlaylistContentsResponseBody = {
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 |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.AddPlaylistContentsMediaContainer](../../../sdk/models/operations/addplaylistcontentsmediacontainer.md) | :heavy_minus_sign: | N/A |

19
docs/sdk/models/operations/applyupdatesrequest.md Normal file
View File

@@ -0,0 +1,19 @@
# ApplyUpdatesRequest
## Example Usage
```typescript
import { ApplyUpdatesRequest, Skip, Tonight } from "@lukehagar/plexjs/sdk/models/operations";
let value: ApplyUpdatesRequest = {
tonight: Tonight.One,
skip: Skip.One,
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tonight` | [operations.Tonight](../../../sdk/models/operations/tonight.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install | 1 |
| `skip` | [operations.Skip](../../../sdk/models/operations/skip.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The [Release] entry for this version will have the `state` set to `skipped`. | 1 |

23
docs/sdk/models/operations/applyupdatesresponse.md Normal file
View File

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

18
docs/sdk/models/operations/autoselectsubtitle.md Normal file
View File

@@ -0,0 +1,18 @@
# AutoSelectSubtitle
The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled)
## Example Usage
```typescript
import { AutoSelectSubtitle } from "@lukehagar/plexjs/sdk/models/operations";
let value: AutoSelectSubtitle = AutoSelectSubtitle.One;
```
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

19
docs/sdk/models/operations/billing.md Normal file
View File

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

25
docs/sdk/models/operations/butlertask.md Normal file
View File

@@ -0,0 +1,25 @@
# ButlerTask
## Example Usage
```typescript
import { ButlerTask } from "@lukehagar/plexjs/sdk/models/operations";
let value: 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 | Example |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `name` | *string* | :heavy_minus_sign: | N/A | BackupDatabase |
| `interval` | *number* | :heavy_minus_sign: | N/A | 3 |
| `scheduleRandomized` | *boolean* | :heavy_minus_sign: | N/A | |
| `enabled` | *boolean* | :heavy_minus_sign: | N/A | |
| `title` | *string* | :heavy_minus_sign: | N/A | Backup Database |
| `description` | *string* | :heavy_minus_sign: | N/A | Create a backup copy of the server's database in the configured backup directory |

25
docs/sdk/models/operations/butlertasks.md Normal file
View File

@@ -0,0 +1,25 @@
# ButlerTasks
## Example Usage
```typescript
import { ButlerTasks } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.ButlerTask](../../../sdk/models/operations/butlertask.md)[] | :heavy_minus_sign: | N/A |

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

@@ -0,0 +1,17 @@
# CancelServerActivitiesRequest
## Example Usage
```typescript
import { CancelServerActivitiesRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: CancelServerActivitiesRequest = {
activityUUID: "25b71ed5-0f9d-461c-baa7-d404e9e10d3e",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `activityUUID` | *string* | :heavy_check_mark: | The UUID of the activity to cancel. | 25b71ed5-0f9d-461c-baa7-d404e9e10d3e |

23
docs/sdk/models/operations/cancelserveractivitiesresponse.md Normal file
View File

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

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

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

23
docs/sdk/models/operations/checkforupdatesresponse.md Normal file
View File

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

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

@@ -0,0 +1,17 @@
# ClearPlaylistContentsRequest
## Example Usage
```typescript
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: ClearPlaylistContentsRequest = {
playlistID: 9495.72,
};
```
## Fields
| Field | Type | Required | Description |
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `playlistID` | *number* | :heavy_check_mark: | the ID of the playlist |

23
docs/sdk/models/operations/clearplaylistcontentsresponse.md Normal file
View File

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

29
docs/sdk/models/operations/connections.md Normal file
View File

@@ -0,0 +1,29 @@
# Connections
## Example Usage
```typescript
import { Connections } from "@lukehagar/plexjs/sdk/models/operations";
let value: Connections = {
protocol: "<value>",
address: "971 Strosin Wall",
port: 4736.08,
uri: "https://starry-initialise.name",
local: false,
relay: false,
iPv6: false,
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `protocol` | *string* | :heavy_check_mark: | N/A |
| `address` | *string* | :heavy_check_mark: | N/A |
| `port` | *number* | :heavy_check_mark: | N/A |
| `uri` | *string* | :heavy_check_mark: | N/A |
| `local` | *boolean* | :heavy_check_mark: | N/A |
| `relay` | *boolean* | :heavy_check_mark: | N/A |
| `iPv6` | *boolean* | :heavy_check_mark: | N/A |

15
docs/sdk/models/operations/context.md Normal file
View File

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

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

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

38
docs/sdk/models/operations/createplaylistmediacontainer.md Normal file
View File

@@ -0,0 +1,38 @@
# CreatePlaylistMediaContainer
## Example Usage
```typescript
import { CreatePlaylistMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.CreatePlaylistMetadata](../../../sdk/models/operations/createplaylistmetadata.md)[] | :heavy_minus_sign: | N/A | |

47
docs/sdk/models/operations/createplaylistmetadata.md Normal file
View File

@@ -0,0 +1,47 @@
# CreatePlaylistMetadata
## Example Usage
```typescript
import { CreatePlaylistMetadata } from "@lukehagar/plexjs/sdk/models/operations";
let value: CreatePlaylistMetadata = {
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 |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 96 |
| `key` | *string* | :heavy_minus_sign: | N/A | /playlists/96/items |
| `guid` | *string* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55 |
| `type` | *string* | :heavy_minus_sign: | N/A | playlist |
| `title` | *string* | :heavy_minus_sign: | N/A | A Great Playlist |
| `summary` | *string* | :heavy_minus_sign: | N/A | What a great playlist |
| `smart` | *boolean* | :heavy_minus_sign: | N/A | false |
| `playlistType` | *string* | :heavy_minus_sign: | N/A | video |
| `icon` | *string* | :heavy_minus_sign: | N/A | playlist://image.smart |
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1705719589 |
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 1 |
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1705719589 |
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705724593 |
| `composite` | *string* | :heavy_minus_sign: | N/A | /playlists/96/composite/1705724593 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 141000 |

19
docs/sdk/models/operations/createplaylistqueryparamtype.md Normal file
View File

@@ -0,0 +1,19 @@
# CreatePlaylistQueryParamType
type of playlist to create
## Example Usage
```typescript
import { CreatePlaylistQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Video;
```
## Values
| Name | Value |
| ------- | ------- |
| `Audio` | audio |
| `Video` | video |
| `Photo` | photo |

24
docs/sdk/models/operations/createplaylistrequest.md Normal file
View File

@@ -0,0 +1,24 @@
# CreatePlaylistRequest
## Example Usage
```typescript
import { CreatePlaylistQueryParamType, CreatePlaylistRequest, Smart } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.CreatePlaylistQueryParamType](../../../sdk/models/operations/createplaylistqueryparamtype.md) | :heavy_check_mark: | type of playlist to create |
| `smart` | [operations.Smart](../../../sdk/models/operations/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/sdk/models/operations/createplaylistresponse.md Normal file
View File

@@ -0,0 +1,49 @@
# CreatePlaylistResponse
## Example Usage
```typescript
import { CreatePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.CreatePlaylistResponseBody](../../../sdk/models/operations/createplaylistresponsebody.md) | :heavy_minus_sign: | returns all playlists |

41
docs/sdk/models/operations/createplaylistresponsebody.md Normal file
View File

@@ -0,0 +1,41 @@
# CreatePlaylistResponseBody
returns all playlists
## Example Usage
```typescript
import { CreatePlaylistResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
let value: CreatePlaylistResponseBody = {
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 |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.CreatePlaylistMediaContainer](../../../sdk/models/operations/createplaylistmediacontainer.md) | :heavy_minus_sign: | N/A |

18
docs/sdk/models/operations/defaultsubtitleaccessibility.md Normal file
View File

@@ -0,0 +1,18 @@
# DefaultSubtitleAccessibility
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles)
## Example Usage
```typescript
import { DefaultSubtitleAccessibility } from "@lukehagar/plexjs/sdk/models/operations";
let value: DefaultSubtitleAccessibility = DefaultSubtitleAccessibility.One;
```
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

18
docs/sdk/models/operations/defaultsubtitleforced.md Normal file
View File

@@ -0,0 +1,18 @@
# DefaultSubtitleForced
The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles)
## Example Usage
```typescript
import { DefaultSubtitleForced } from "@lukehagar/plexjs/sdk/models/operations";
let value: DefaultSubtitleForced = DefaultSubtitleForced.One;
```
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

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

@@ -0,0 +1,17 @@
# DeleteLibraryRequest
## Example Usage
```typescript
import { DeleteLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: DeleteLibraryRequest = {
sectionKey: 9518,
};
```
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |

23
docs/sdk/models/operations/deletelibraryresponse.md Normal file
View File

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

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

@@ -0,0 +1,17 @@
# DeletePlaylistRequest
## Example Usage
```typescript
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: DeletePlaylistRequest = {
playlistID: 6747.52,
};
```
## Fields
| Field | Type | Required | Description |
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `playlistID` | *number* | :heavy_check_mark: | the ID of the playlist |

23
docs/sdk/models/operations/deleteplaylistresponse.md Normal file
View File

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

24
docs/sdk/models/operations/device.md Normal file
View File

@@ -0,0 +1,24 @@
# Device
## Example Usage
```typescript
import { Device } from "@lukehagar/plexjs/sdk/models/operations";
let value: Device = {
id: 1,
name: "iPhone",
platform: "iOS",
createdAt: 1654131230,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *number* | :heavy_minus_sign: | N/A | 1 |
| `name` | *string* | :heavy_minus_sign: | N/A | iPhone |
| `platform` | *string* | :heavy_minus_sign: | N/A | iOS |
| `clientIdentifier` | *string* | :heavy_minus_sign: | N/A | |
| `createdAt` | *number* | :heavy_minus_sign: | N/A | 1654131230 |

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

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

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

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

18
docs/sdk/models/operations/download.md Normal file
View File

@@ -0,0 +1,18 @@
# Download
Indicate that you want to start download any updates found.
## Example Usage
```typescript
import { Download } from "@lukehagar/plexjs/sdk/models/operations";
let value: Download = Download.One;
```
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

23
docs/sdk/models/operations/enablepapertrailresponse.md Normal file
View File

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

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

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

73
docs/sdk/models/operations/features.md Normal file
View File

@@ -0,0 +1,73 @@
# Features
## Example Usage
```typescript
import { Features } from "@lukehagar/plexjs/sdk/models/operations";
let value: Features = Features.WatchTogetherInvite;
```
## Values
| Name | Value |
| --------------------------------------- | --------------------------------------- |
| `AndroidDolbyVision` | Android - Dolby Vision |
| `AndroidPiP` | Android - PiP |
| `CUSunset` | CU Sunset |
| `HRKEnableEUR` | HRK_enable_EUR |
| `TREBLEShowFeatures` | TREBLE-show-features |
| `AdCountdownTimer` | ad-countdown-timer |
| `AdaptiveBitrate` | adaptive_bitrate |
| `AmazonLoopDebug` | amazon-loop-debug |
| `AvodAdAnalysis` | avod-ad-analysis |
| `AvodNewMedia` | avod-new-media |
| `BlacklistGetSignin` | blacklist_get_signin |
| `ClientRadioStations` | client-radio-stations |
| `CloudflareTurnstileRequired` | cloudflare-turnstile-required |
| `Collections` | collections |
| `CommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications |
| `CommunityAccessPlexTv` | community_access_plex_tv |
| `CompanionsSonos` | companions_sonos |
| `CustomHomeRemoval` | custom-home-removal |
| `DisableHomeUserFriendships` | disable_home_user_friendships |
| `DisableSharingFriendships` | disable_sharing_friendships |
| `DrmSupport` | drm_support |
| `ExcludeRestrictions` | exclude restrictions |
| `FederatedAuth` | federated-auth |
| `FriendRequestPushNotifications` | friend_request_push_notifications |
| `GuidedUpgrade` | guided-upgrade |
| `Home` | home |
| `IncreasePasswordComplexity` | increase-password-complexity |
| `Ios14PrivacyBanner` | ios14-privacy-banner |
| `IterableNotificationTokens` | iterable-notification-tokens |
| `KeepPaymentMethod` | keep-payment-method |
| `KevinBacon` | kevin-bacon |
| `KoreaConsent` | korea-consent |
| `LeIsrgRootX1` | le_isrg_root_x1 |
| `LetsEncrypt` | lets_encrypt |
| `LightningDvrPivot` | lightning-dvr-pivot |
| `LiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments |
| `Livetv` | livetv |
| `MetadataSearch` | metadata_search |
| `NewPlexPassPrices` | new_plex_pass_prices |
| `NewsProviderSunsetModal` | news-provider-sunset-modal |
| `PhotosFavorites` | photos-favorites |
| `PhotosMetadataEdition` | photos-metadata-edition |
| `PmsHealth` | pms_health |
| `Radio` | radio |
| `RateLimitClientToken` | rate-limit-client-token |
| `ScrobblingServicePlexTv` | scrobbling-service-plex-tv |
| `SharedServerNotification` | shared_server_notification |
| `SharedSourceNotification` | shared_source_notification |
| `SigninWithApple` | signin_with_apple |
| `SpringServeAdProvider` | spring_serve_ad_provider |
| `TranscoderCache` | transcoder_cache |
| `TunerSharing` | tuner-sharing |
| `TwoFactorAuthentication` | two-factor-authentication |
| `Unsupportedtuners` | unsupportedtuners |
| `Upgrade3ds2` | upgrade-3ds2 |
| `VodSchema` | vod-schema |
| `VodCloudflare` | vod_cloudflare |
| `WatchTogetherInvite` | watch-together-invite |
| `WebServerDashboard` | web_server_dashboard |

23
docs/sdk/models/operations/field.md Normal file
View File

@@ -0,0 +1,23 @@
# Field
## Example Usage
```typescript
import { Field } from "@lukehagar/plexjs/sdk/models/operations";
let value: Field = {
key: "label",
title: "Label",
type: "tag",
subType: "bitrate",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `key` | *string* | :heavy_minus_sign: | N/A | label |
| `title` | *string* | :heavy_minus_sign: | N/A | Label |
| `type` | *string* | :heavy_minus_sign: | N/A | tag |
| `subType` | *string* | :heavy_minus_sign: | N/A | bitrate |

24
docs/sdk/models/operations/fieldtype.md Normal file
View File

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

19
docs/sdk/models/operations/filter.md Normal file
View File

@@ -0,0 +1,19 @@
# Filter
Filter
## Example Usage
```typescript
import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
let value: Filter = Filter.Available;
```
## Values
| Name | Value |
| ----------- | ----------- |
| `All` | all |
| `Available` | available |
| `Released` | released |

18
docs/sdk/models/operations/force.md Normal file
View File

@@ -0,0 +1,18 @@
# Force
Force the refresh even if the library is already being refreshed.
## Example Usage
```typescript
import { Force } from "@lukehagar/plexjs/sdk/models/operations";
let value: Force = Force.One;
```
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

39
docs/sdk/models/operations/friend.md Normal file
View File

@@ -0,0 +1,39 @@
# Friend
## Example Usage
```typescript
import { Friend, Status } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.SharedServers](../../../sdk/models/operations/sharedservers.md)[] | :heavy_check_mark: | N/A | |
| `sharedSources` | [operations.SharedSources](../../../sdk/models/operations/sharedsources.md)[] | :heavy_check_mark: | N/A | |
| `status` | [operations.Status](../../../sdk/models/operations/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 |

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

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

39
docs/sdk/models/operations/geodata.md Normal file
View File

@@ -0,0 +1,39 @@
# GeoData
Geo location data
## Example Usage
```typescript
import { GeoData } from "@lukehagar/plexjs/sdk/models/operations";
let value: GeoData = {
code: "VI",
continentCode: "NA",
country: "United States Virgin Islands",
city: "Amsterdam",
europeanUnionMember: true,
timeZone: "America/St_Thomas",
postalCode: 802,
inPrivacyRestrictedCountry: true,
inPrivacyRestrictedRegion: true,
subdivisions: "Saint Thomas",
coordinates: "18.3381, -64.8941",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `code` | *string* | :heavy_check_mark: | The ISO 3166-1 alpha-2 code of the country. | VI |
| `continentCode` | *string* | :heavy_check_mark: | The continent code where the country is located. | NA |
| `country` | *string* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands |
| `city` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `europeanUnionMember` | *boolean* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
| `timeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `postalCode` | *number* | :heavy_check_mark: | The postal code of the location. | 802 |
| `inPrivacyRestrictedCountry` | *boolean* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
| `inPrivacyRestrictedRegion` | *boolean* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
| `subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `coordinates` | *string* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |

62
docs/sdk/models/operations/getalllibrariesdirectory.md Normal file
View File

@@ -0,0 +1,62 @@
# GetAllLibrariesDirectory
## Example Usage
```typescript
import { GetAllLibrariesDirectory } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.Location](../../../sdk/models/operations/location.md)[] | :heavy_minus_sign: | N/A | |

52
docs/sdk/models/operations/getalllibrariesmediacontainer.md Normal file
View File

@@ -0,0 +1,52 @@
# GetAllLibrariesMediaContainer
## Example Usage
```typescript
import { GetAllLibrariesMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.GetAllLibrariesDirectory](../../../sdk/models/operations/getalllibrariesdirectory.md)[] | :heavy_minus_sign: | N/A | |

61
docs/sdk/models/operations/getalllibrariesresponse.md Normal file
View File

@@ -0,0 +1,61 @@
# GetAllLibrariesResponse
## Example Usage
```typescript
import { GetAllLibrariesResponse } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.GetAllLibrariesResponseBody](../../../sdk/models/operations/getalllibrariesresponsebody.md) | :heavy_minus_sign: | The libraries available on the Server |

53
docs/sdk/models/operations/getalllibrariesresponsebody.md Normal file
View File

@@ -0,0 +1,53 @@
# GetAllLibrariesResponseBody
The libraries available on the Server
## Example Usage
```typescript
import { GetAllLibrariesResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllLibrariesResponseBody = {
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 |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.GetAllLibrariesMediaContainer](../../../sdk/models/operations/getalllibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |

33
docs/sdk/models/operations/getavailableclientsmediacontainer.md Normal file
View File

@@ -0,0 +1,33 @@
# GetAvailableClientsMediaContainer
## Example Usage
```typescript
import { GetAvailableClientsMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.Server](../../../sdk/models/operations/server.md)[] | :heavy_minus_sign: | N/A | |

44
docs/sdk/models/operations/getavailableclientsresponse.md Normal file
View File

@@ -0,0 +1,44 @@
# GetAvailableClientsResponse
## Example Usage
```typescript
import { GetAvailableClientsResponse } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.GetAvailableClientsResponseBody](../../../sdk/models/operations/getavailableclientsresponsebody.md) | :heavy_minus_sign: | Available Clients |

36
docs/sdk/models/operations/getavailableclientsresponsebody.md Normal file
View File

@@ -0,0 +1,36 @@
# GetAvailableClientsResponseBody
Available Clients
## Example Usage
```typescript
import { GetAvailableClientsResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.GetAvailableClientsMediaContainer](../../../sdk/models/operations/getavailableclientsmediacontainer.md) | :heavy_minus_sign: | N/A |

31
docs/sdk/models/operations/getbandwidthstatisticsaccount.md Normal file
View File

@@ -0,0 +1,31 @@
# GetBandwidthStatisticsAccount
## Example Usage
```typescript
import { GetBandwidthStatisticsAccount } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetBandwidthStatisticsAccount = {
id: 238960586,
key: "/accounts/238960586",
name: "Diane",
defaultAudioLanguage: "en",
autoSelectAudio: true,
defaultSubtitleLanguage: "en",
subtitleMode: 1,
thumb: "https://plex.tv/users/50d83634246da1de/avatar?c=1707110967",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 238960586 |
| `key` | *string* | :heavy_minus_sign: | N/A | /accounts/238960586 |
| `name` | *string* | :heavy_minus_sign: | N/A | Diane |
| `defaultAudioLanguage` | *string* | :heavy_minus_sign: | N/A | en |
| `autoSelectAudio` | *boolean* | :heavy_minus_sign: | N/A | true |
| `defaultSubtitleLanguage` | *string* | :heavy_minus_sign: | N/A | en |
| `subtitleMode` | *number* | :heavy_minus_sign: | N/A | 1 |
| `thumb` | *string* | :heavy_minus_sign: | N/A | https://plex.tv/users/50d83634246da1de/avatar?c=1707110967 |

25
docs/sdk/models/operations/getbandwidthstatisticsdevice.md Normal file
View File

@@ -0,0 +1,25 @@
# GetBandwidthStatisticsDevice
## Example Usage
```typescript
import { GetBandwidthStatisticsDevice } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetBandwidthStatisticsDevice = {
id: 208,
name: "Roku Express",
platform: "Roku",
clientIdentifier: "793095d235660625108ef785cc7646e9",
createdAt: 1706470556,
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 208 |
| `name` | *string* | :heavy_minus_sign: | N/A | Roku Express |
| `platform` | *string* | :heavy_minus_sign: | N/A | Roku |
| `clientIdentifier` | *string* | :heavy_minus_sign: | N/A | 793095d235660625108ef785cc7646e9 |
| `createdAt` | *number* | :heavy_minus_sign: | N/A | 1706470556 |

51
docs/sdk/models/operations/getbandwidthstatisticsmediacontainer.md Normal file
View File

@@ -0,0 +1,51 @@
# GetBandwidthStatisticsMediaContainer
## Example Usage
```typescript
import { GetBandwidthStatisticsMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.GetBandwidthStatisticsDevice](../../../sdk/models/operations/getbandwidthstatisticsdevice.md)[] | :heavy_minus_sign: | N/A | |
| `account` | [operations.GetBandwidthStatisticsAccount](../../../sdk/models/operations/getbandwidthstatisticsaccount.md)[] | :heavy_minus_sign: | N/A | |
| `statisticsBandwidth` | [operations.StatisticsBandwidth](../../../sdk/models/operations/statisticsbandwidth.md)[] | :heavy_minus_sign: | N/A | |

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

@@ -0,0 +1,17 @@
# GetBandwidthStatisticsRequest
## Example Usage
```typescript
import { GetBandwidthStatisticsRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetBandwidthStatisticsRequest = {
timespan: 4,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `timespan` | *number* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |

60
docs/sdk/models/operations/getbandwidthstatisticsresponse.md Normal file
View File

@@ -0,0 +1,60 @@
# GetBandwidthStatisticsResponse
## Example Usage
```typescript
import { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.GetBandwidthStatisticsResponseBody](../../../sdk/models/operations/getbandwidthstatisticsresponsebody.md) | :heavy_minus_sign: | Bandwidth Statistics |

52
docs/sdk/models/operations/getbandwidthstatisticsresponsebody.md Normal file
View File

@@ -0,0 +1,52 @@
# GetBandwidthStatisticsResponseBody
Bandwidth Statistics
## Example Usage
```typescript
import { GetBandwidthStatisticsResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetBandwidthStatisticsResponseBody = {
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 |
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.GetBandwidthStatisticsMediaContainer](../../../sdk/models/operations/getbandwidthstatisticsmediacontainer.md) | :heavy_minus_sign: | N/A |

27
docs/sdk/models/operations/getbannerimagerequest.md Normal file
View File

@@ -0,0 +1,27 @@
# GetBannerImageRequest
## Example Usage
```typescript
import { GetBannerImageRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetBannerImageRequest = {
ratingKey: 9518,
width: 396,
height: 396,
minSize: 1,
upscale: 1,
xPlexToken: "CV5xoxjTpFKUzBTShsaf",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `ratingKey` | *number* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
| `width` | *number* | :heavy_check_mark: | N/A | 396 |
| `height` | *number* | :heavy_check_mark: | N/A | 396 |
| `minSize` | *number* | :heavy_check_mark: | N/A | 1 |
| `upscale` | *number* | :heavy_check_mark: | N/A | 1 |
| `xPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |

19
docs/sdk/models/operations/getbannerimageresponse.md Normal file
View File

@@ -0,0 +1,19 @@
# GetBannerImageResponse
## Example Usage
```typescript
import { GetBannerImageResponse } from "@lukehagar/plexjs/sdk/models/operations";
// No examples available for this model
```
## 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 |
| `responseStream` | *ReadableStream<Uint8Array>* | :heavy_minus_sign: | Successful response returning an image |
| `headers` | Record<string, *string*[]> | :heavy_check_mark: | N/A |

37
docs/sdk/models/operations/getbutlertasksresponse.md Normal file
View File

@@ -0,0 +1,37 @@
# GetButlerTasksResponse
## Example Usage
```typescript
import { GetButlerTasksResponse } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.GetButlerTasksResponseBody](../../../sdk/models/operations/getbutlertasksresponsebody.md) | :heavy_minus_sign: | All butler tasks |

29
docs/sdk/models/operations/getbutlertasksresponsebody.md Normal file
View File

@@ -0,0 +1,29 @@
# GetButlerTasksResponseBody
All butler tasks
## Example Usage
```typescript
import { GetButlerTasksResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.ButlerTasks](../../../sdk/models/operations/butlertasks.md) | :heavy_minus_sign: | N/A |

34
docs/sdk/models/operations/getcompanionsdataresponse.md Normal file
View File

@@ -0,0 +1,34 @@
# GetCompanionsDataResponse
## Example Usage
```typescript
import { GetCompanionsDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.ResponseBody](../../../sdk/models/operations/responsebody.md)[] | :heavy_minus_sign: | Companions Data |

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

@@ -0,0 +1,28 @@
# GetDevicesMediaContainer
## Example Usage
```typescript
import { GetDevicesMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.Device](../../../sdk/models/operations/device.md)[] | :heavy_minus_sign: | N/A | |

38
docs/sdk/models/operations/getdevicesresponse.md Normal file
View File

@@ -0,0 +1,38 @@
# GetDevicesResponse
## Example Usage
```typescript
import { GetDevicesResponse } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.GetDevicesResponseBody](../../../sdk/models/operations/getdevicesresponsebody.md) | :heavy_minus_sign: | Devices |

30
docs/sdk/models/operations/getdevicesresponsebody.md Normal file
View File

@@ -0,0 +1,30 @@
# GetDevicesResponseBody
Devices
## Example Usage
```typescript
import { GetDevicesResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.GetDevicesMediaContainer](../../../sdk/models/operations/getdevicesmediacontainer.md) | :heavy_minus_sign: | N/A |

18
docs/sdk/models/operations/getfilehashrequest.md Normal file
View File

@@ -0,0 +1,18 @@
# GetFileHashRequest
## Example Usage
```typescript
import { GetFileHashRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetFileHashRequest = {
url: "file://C:Image.png&type=13",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
| `url` | *string* | :heavy_check_mark: | This is the path to the local file, must be prefixed by `file://` | file://C:\Image.png&type=13 |
| `type` | *number* | :heavy_minus_sign: | Item type | |

23
docs/sdk/models/operations/getfilehashresponse.md Normal file
View File

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

39
docs/sdk/models/operations/getgeodatageodata.md Normal file
View File

@@ -0,0 +1,39 @@
# GetGeoDataGeoData
Geo location data
## Example Usage
```typescript
import { GetGeoDataGeoData } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetGeoDataGeoData = {
code: "VI",
continentCode: "NA",
country: "United States Virgin Islands",
city: "Amsterdam",
europeanUnionMember: true,
timeZone: "America/St_Thomas",
postalCode: 802,
inPrivacyRestrictedCountry: true,
inPrivacyRestrictedRegion: true,
subdivisions: "Saint Thomas",
coordinates: "18.3381, -64.8941",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `code` | *string* | :heavy_check_mark: | The ISO 3166-1 alpha-2 code of the country. | VI |
| `continentCode` | *string* | :heavy_check_mark: | The continent code where the country is located. | NA |
| `country` | *string* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands |
| `city` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `europeanUnionMember` | *boolean* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
| `timeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `postalCode` | *number* | :heavy_check_mark: | The postal code of the location. | 802 |
| `inPrivacyRestrictedCountry` | *boolean* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
| `inPrivacyRestrictedRegion` | *boolean* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
| `subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `coordinates` | *string* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |

37
docs/sdk/models/operations/getgeodataresponse.md Normal file
View File

@@ -0,0 +1,37 @@
# GetGeoDataResponse
## Example Usage
```typescript
import { GetGeoDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetGeoDataResponse = {
contentType: "<value>",
statusCode: 20218,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
geoData: {
code: "VI",
continentCode: "NA",
country: "United States Virgin Islands",
city: "Amsterdam",
europeanUnionMember: true,
timeZone: "America/St_Thomas",
postalCode: 802,
inPrivacyRestrictedCountry: true,
inPrivacyRestrictedRegion: true,
subdivisions: "Saint Thomas",
coordinates: "18.3381, -64.8941",
},
};
```
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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 | |
| `geoData` | [operations.GetGeoDataGeoData](../../../sdk/models/operations/getgeodatageodata.md) | :heavy_minus_sign: | Gets the geo location data of the user | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} |

57
docs/sdk/models/operations/getglobalhubsmediacontainer.md Normal file
View File

@@ -0,0 +1,57 @@
# GetGlobalHubsMediaContainer
## Example Usage
```typescript
import { GetGlobalHubsMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.Hub](../../../sdk/models/operations/hub.md)[] | :heavy_minus_sign: | N/A | |

49
docs/sdk/models/operations/getglobalhubsmetadata.md Normal file
View File

@@ -0,0 +1,49 @@
# GetGlobalHubsMetadata
## Example Usage
```typescript
import { GetGlobalHubsMetadata } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetGlobalHubsMetadata = {
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 |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 57070 |
| `key` | *string* | :heavy_minus_sign: | N/A | /playlists/57070/items |
| `guid` | *string* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c |
| `type` | *string* | :heavy_minus_sign: | N/A | playlist |
| `title` | *string* | :heavy_minus_sign: | N/A | November Movie Day |
| `titleSort` | *string* | :heavy_minus_sign: | N/A | Tracks |
| `summary` | *string* | :heavy_minus_sign: | N/A | |
| `smart` | *boolean* | :heavy_minus_sign: | N/A | false |
| `playlistType` | *string* | :heavy_minus_sign: | N/A | video |
| `composite` | *string* | :heavy_minus_sign: | N/A | /playlists/57070/composite/1668787730 |
| `icon` | *string* | :heavy_minus_sign: | N/A | playlist://image.smart |
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 2 |
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1668787732 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 16873000 |
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 3 |
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1668779618 |
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1668787730 |

16
docs/sdk/models/operations/getglobalhubsrequest.md Normal file
View File

@@ -0,0 +1,16 @@
# GetGlobalHubsRequest
## Example Usage
```typescript
import { GetGlobalHubsRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetGlobalHubsRequest = {};
```
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `count` | *number* | :heavy_minus_sign: | The number of items to return with each hub. |
| `onlyTransient` | [operations.OnlyTransient](../../../sdk/models/operations/onlytransient.md) | :heavy_minus_sign: | Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added). |

66
docs/sdk/models/operations/getglobalhubsresponse.md Normal file
View File

@@ -0,0 +1,66 @@
# GetGlobalHubsResponse
## Example Usage
```typescript
import { GetGlobalHubsResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetGlobalHubsResponse = {
contentType: "<value>",
statusCode: 149675,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
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 |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.GetGlobalHubsResponseBody](../../../sdk/models/operations/getglobalhubsresponsebody.md) | :heavy_minus_sign: | returns global hubs |

58
docs/sdk/models/operations/getglobalhubsresponsebody.md Normal file
View File

@@ -0,0 +1,58 @@
# GetGlobalHubsResponseBody
returns global hubs
## Example Usage
```typescript
import { GetGlobalHubsResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetGlobalHubsResponseBody = {
mediaContainer: {
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 |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.GetGlobalHubsMediaContainer](../../../sdk/models/operations/getglobalhubsmediacontainer.md) | :heavy_minus_sign: | N/A |

30
docs/sdk/models/operations/gethomedataresponse.md Normal file
View File

@@ -0,0 +1,30 @@
# GetHomeDataResponse
## Example Usage
```typescript
import { GetHomeDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.GetHomeDataResponseBody](../../../sdk/models/operations/gethomedataresponsebody.md) | :heavy_minus_sign: | Home Data |

27
docs/sdk/models/operations/gethomedataresponsebody.md Normal file
View File

@@ -0,0 +1,27 @@
# GetHomeDataResponseBody
Home Data
## Example Usage
```typescript
import { GetHomeDataResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetHomeDataResponseBody = {
id: 1841489,
name: "Blindkitty38's home",
guestUserID: 58815432,
guestUserUUID: "f3df4e01bfca0787",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 1841489 |
| `name` | *string* | :heavy_minus_sign: | N/A | Blindkitty38's home |
| `guestUserID` | *number* | :heavy_minus_sign: | N/A | 58815432 |
| `guestUserUUID` | *string* | :heavy_minus_sign: | N/A | f3df4e01bfca0787 |
| `guestEnabled` | *boolean* | :heavy_minus_sign: | N/A | |
| `subscription` | *boolean* | :heavy_minus_sign: | N/A | |

25
docs/sdk/models/operations/getlibrarydetailsdirectory.md Normal file
View File

@@ -0,0 +1,25 @@
# GetLibraryDetailsDirectory
## Example Usage
```typescript
import { GetLibraryDetailsDirectory } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryDetailsDirectory = {
key: "search?type=1",
title: "Search...",
secondary: true,
prompt: "Search Movies",
search: true,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `key` | *string* | :heavy_minus_sign: | N/A | search?type=1 |
| `title` | *string* | :heavy_minus_sign: | N/A | Search... |
| `secondary` | *boolean* | :heavy_minus_sign: | N/A | true |
| `prompt` | *string* | :heavy_minus_sign: | N/A | Search Movies |
| `search` | *boolean* | :heavy_minus_sign: | N/A | true |

25
docs/sdk/models/operations/getlibrarydetailsfilter.md Normal file
View File

@@ -0,0 +1,25 @@
# GetLibraryDetailsFilter
## Example Usage
```typescript
import { GetLibraryDetailsFilter } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryDetailsFilter = {
filter: "label",
filterType: "string",
key: "/library/sections/1/label",
title: "Labels",
type: "filter",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `filter` | *string* | :heavy_minus_sign: | N/A | label |
| `filterType` | *string* | :heavy_minus_sign: | N/A | string |
| `key` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/label |
| `title` | *string* | :heavy_minus_sign: | N/A | Labels |
| `type` | *string* | :heavy_minus_sign: | N/A | filter |

97
docs/sdk/models/operations/getlibrarydetailsmediacontainer.md Normal file
View File

@@ -0,0 +1,97 @@
# GetLibraryDetailsMediaContainer
## Example Usage
```typescript
import { GetLibraryDetailsMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.GetLibraryDetailsDirectory](../../../sdk/models/operations/getlibrarydetailsdirectory.md)[] | :heavy_minus_sign: | N/A | |
| `type` | [operations.GetLibraryDetailsType](../../../sdk/models/operations/getlibrarydetailstype.md)[] | :heavy_minus_sign: | N/A | |
| `fieldType` | [operations.FieldType](../../../sdk/models/operations/fieldtype.md)[] | :heavy_minus_sign: | N/A | |

18
docs/sdk/models/operations/getlibrarydetailsrequest.md Normal file
View File

@@ -0,0 +1,18 @@
# GetLibraryDetailsRequest
## Example Usage
```typescript
import { GetLibraryDetailsRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryDetailsRequest = {
sectionKey: 9518,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `includeDetails` | [operations.IncludeDetails](../../../sdk/models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |

95
docs/sdk/models/operations/getlibrarydetailsresponse.md Normal file
View File

@@ -0,0 +1,95 @@
# GetLibraryDetailsResponse
## Example Usage
```typescript
import { GetLibraryDetailsResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryDetailsResponse = {
contentType: "<value>",
statusCode: 902349,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
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 |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.GetLibraryDetailsResponseBody](../../../sdk/models/operations/getlibrarydetailsresponsebody.md) | :heavy_minus_sign: | The details of the library |

87
docs/sdk/models/operations/getlibrarydetailsresponsebody.md Normal file
View File

@@ -0,0 +1,87 @@
# GetLibraryDetailsResponseBody
The details of the library
## Example Usage
```typescript
import { GetLibraryDetailsResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryDetailsResponseBody = {
mediaContainer: {
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 |
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.GetLibraryDetailsMediaContainer](../../../sdk/models/operations/getlibrarydetailsmediacontainer.md) | :heavy_minus_sign: | N/A |

53
docs/sdk/models/operations/getlibrarydetailstype.md Normal file
View File

@@ -0,0 +1,53 @@
# GetLibraryDetailsType
## Example Usage
```typescript
import { GetLibraryDetailsType } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.GetLibraryDetailsFilter](../../../sdk/models/operations/getlibrarydetailsfilter.md)[] | :heavy_minus_sign: | N/A | |
| `sort` | [operations.Sort](../../../sdk/models/operations/sort.md)[] | :heavy_minus_sign: | N/A | |
| `field` | [operations.Field](../../../sdk/models/operations/field.md)[] | :heavy_minus_sign: | N/A | |

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

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

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

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

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

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

131
docs/sdk/models/operations/getlibraryhubshub.md Normal file
View File

@@ -0,0 +1,131 @@
# GetLibraryHubsHub
## Example Usage
```typescript
import { GetLibraryHubsHub } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/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` | [operations.GetLibraryHubsMetadata](../../../sdk/models/operations/getlibraryhubsmetadata.md)[] | :heavy_minus_sign: | N/A | |
| `promoted` | *boolean* | :heavy_minus_sign: | N/A | true |
| `random` | *boolean* | :heavy_minus_sign: | N/A | true |

62
docs/sdk/models/operations/getlibraryhubsmedia.md Normal file
View File

@@ -0,0 +1,62 @@
# GetLibraryHubsMedia
## Example Usage
```typescript
import { GetLibraryHubsMedia } from "@lukehagar/plexjs/sdk/models/operations";
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` | [operations.GetLibraryHubsPart](../../../sdk/models/operations/getlibraryhubspart.md)[] | :heavy_minus_sign: | N/A | |

136
docs/sdk/models/operations/getlibraryhubsmediacontainer.md Normal file
View File

@@ -0,0 +1,136 @@
# GetLibraryHubsMediaContainer
## Example Usage
```typescript
import { GetLibraryHubsMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetLibraryHubsMediaContainer = {
size: 7,
allowSync: true,
identifier: "com.plexapp.plugins.library",
librarySectionID: 1,
librarySectionTitle: "Movies",
librarySectionUUID: "322a231a-b7f7-49f5-920f-14c61199cd30",
hub: [
{
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 |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `size` | *number* | :heavy_minus_sign: | N/A | 7 |
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionUUID` | *string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `hub` | [operations.GetLibraryHubsHub](../../../sdk/models/operations/getlibraryhubshub.md)[] | :heavy_minus_sign: | N/A | |

138
docs/sdk/models/operations/getlibraryhubsmetadata.md Normal file
View File

@@ -0,0 +1,138 @@
# GetLibraryHubsMetadata
## Example Usage
```typescript
import { GetLibraryHubsMetadata } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetLibraryHubsMetadata = {
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",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 14944 |
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/14944 |
| `guid` | *string* | :heavy_minus_sign: | N/A | plex://movie/5d77686eeb5d26001f1eb339 |
| `studio` | *string* | :heavy_minus_sign: | N/A | Walt Disney Animation Studios |
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
| `title` | *string* | :heavy_minus_sign: | N/A | Tangled |
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG |
| `summary` | *string* | :heavy_minus_sign: | N/A | 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` | *number* | :heavy_minus_sign: | N/A | 8.9 |
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 8.7 |
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1704936047 |
| `year` | *number* | :heavy_minus_sign: | N/A | 2010 |
| `tagline` | *string* | :heavy_minus_sign: | N/A | They're taking adventure to new lengths. |
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/14944/thumb/1705739847 |
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/14944/art/1705739847 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 6017237 |
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2010-11-24 00:00:00 +0000 UTC |
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1589412494 |
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705739847 |
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `primaryExtraKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/14952 |
| `ratingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
| `media` | [operations.GetLibraryHubsMedia](../../../sdk/models/operations/getlibraryhubsmedia.md)[] | :heavy_minus_sign: | N/A | |
| `genre` | [operations.GetLibraryHubsGenre](../../../sdk/models/operations/getlibraryhubsgenre.md)[] | :heavy_minus_sign: | N/A | |
| `country` | [operations.GetLibraryHubsCountry](../../../sdk/models/operations/getlibraryhubscountry.md)[] | :heavy_minus_sign: | N/A | |
| `director` | [operations.GetLibraryHubsDirector](../../../sdk/models/operations/getlibraryhubsdirector.md)[] | :heavy_minus_sign: | N/A | |
| `role` | [operations.GetLibraryHubsRole](../../../sdk/models/operations/getlibraryhubsrole.md)[] | :heavy_minus_sign: | N/A | |
| `writer` | [operations.GetLibraryHubsWriter](../../../sdk/models/operations/getlibraryhubswriter.md)[] | :heavy_minus_sign: | N/A | |
| `skipCount` | *number* | :heavy_minus_sign: | N/A | 1 |
| `chapterSource` | *string* | :heavy_minus_sign: | N/A | media |

35
docs/sdk/models/operations/getlibraryhubspart.md Normal file
View File

@@ -0,0 +1,35 @@
# GetLibraryHubsPart
## Example Usage
```typescript
import { GetLibraryHubsPart } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryHubsPart = {
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 |
| `key` | *string* | :heavy_minus_sign: | N/A | /library/parts/38247/1589412494/file.mp4 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 6017237 |
| `file` | *string* | :heavy_minus_sign: | N/A | /movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4 |
| `size` | *number* | :heavy_minus_sign: | N/A | 1545647447 |
| `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 | true |
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |

19
docs/sdk/models/operations/getlibraryhubsrequest.md Normal file
View File

@@ -0,0 +1,19 @@
# GetLibraryHubsRequest
## Example Usage
```typescript
import { GetLibraryHubsRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryHubsRequest = {
sectionId: 2223.21,
};
```
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sectionId` | *number* | :heavy_check_mark: | the Id of the library to query |
| `count` | *number* | :heavy_minus_sign: | The number of items to return with each hub. |
| `onlyTransient` | [operations.QueryParamOnlyTransient](../../../sdk/models/operations/queryparamonlytransient.md) | :heavy_minus_sign: | Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added). |

142
docs/sdk/models/operations/getlibraryhubsresponse.md Normal file
View File

@@ -0,0 +1,142 @@
# GetLibraryHubsResponse
## Example Usage
```typescript
import { GetLibraryHubsResponse } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetLibraryHubsResponse = {
contentType: "<value>",
statusCode: 616934,
rawResponse: new Response('{"message": "hello world"}', {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 7,
allowSync: true,
identifier: "com.plexapp.plugins.library",
librarySectionID: 1,
librarySectionTitle: "Movies",
librarySectionUUID: "322a231a-b7f7-49f5-920f-14c61199cd30",
hub: [
{
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 |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.GetLibraryHubsResponseBody](../../../sdk/models/operations/getlibraryhubsresponsebody.md) | :heavy_minus_sign: | The hubs specific to the library |

134
docs/sdk/models/operations/getlibraryhubsresponsebody.md Normal file
View File

@@ -0,0 +1,134 @@
# GetLibraryHubsResponseBody
The hubs specific to the library
## Example Usage
```typescript
import { GetLibraryHubsResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetLibraryHubsResponseBody = {
mediaContainer: {
size: 7,
allowSync: true,
identifier: "com.plexapp.plugins.library",
librarySectionID: 1,
librarySectionTitle: "Movies",
librarySectionUUID: "322a231a-b7f7-49f5-920f-14c61199cd30",
hub: [
{
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 |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.GetLibraryHubsMediaContainer](../../../sdk/models/operations/getlibraryhubsmediacontainer.md) | :heavy_minus_sign: | N/A |

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

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

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

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

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