LukeParke/plexjava
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexjava.git synced 2025-12-10 12:37:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

regerated and working on publishing

Browse Source
This commit is contained in:
Luke Hagar
2024-09-08 02:40:34 +00:00
parent 02ce124a6b
commit ac5716c20d
1312 changed files with 65980 additions and 37728 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/models/operations/Account.md
View File

@@ -5,11 +5,11 @@
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `id` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 238960586 |
| `key` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /accounts/238960586 |
| `name` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Diane |
| `defaultAudioLanguage` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | en |
| `autoSelectAudio` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |
| `defaultSubtitleLanguage` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | en |
| `subtitleMode` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
| `thumb` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | https://plex.tv/users/50d83634246da1de/avatar?c=1707110967 |
| `id` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 238960586 |
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | /accounts/238960586 |
| `name` | *Optional<String>* | :heavy_minus_sign: | N/A | Diane |
| `defaultAudioLanguage` | *Optional<String>* | :heavy_minus_sign: | N/A | en |
| `autoSelectAudio` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `defaultSubtitleLanguage` | *Optional<String>* | :heavy_minus_sign: | N/A | en |
| `subtitleMode` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `thumb` | *Optional<String>* | :heavy_minus_sign: | N/A | https://plex.tv/users/50d83634246da1de/avatar?c=1707110967 |

20
docs/models/operations/Activity.md
View File

@@ -3,13 +3,13 @@
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `uuid` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `type` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `cancellable` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A |
| `userID` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A |
| `title` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `subtitle` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `progress` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A |
| `context` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.Context>](../../models/operations/Context.md) | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `uuid` | *Optional<String>* | :heavy_minus_sign: | N/A |
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A |
| `cancellable` | *Optional<Boolean>* | :heavy_minus_sign: | N/A |
| `userID` | *Optional<Double>* | :heavy_minus_sign: | N/A |
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A |
| `subtitle` | *Optional<String>* | :heavy_minus_sign: | N/A |
| `progress` | *Optional<Double>* | :heavy_minus_sign: | N/A |
| `context` | [Optional<Context>](../../models/operations/Context.md) | :heavy_minus_sign: | N/A |

12
docs/models/operations/AddPlaylistContentsMediaContainer.md
View File

@@ -3,9 +3,9 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `size` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
| `leafCountAdded` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
| `leafCountRequested` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
| `metadata` | List<[lukehagar.plexapi.plexapi.models.operations.AddPlaylistContentsMetadata](../../models/operations/AddPlaylistContentsMetadata.md)> | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `size` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `leafCountAdded` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `leafCountRequested` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `metadata` | List<[AddPlaylistContentsMetadata](../../models/operations/AddPlaylistContentsMetadata.md)> | :heavy_minus_sign: | N/A | |

26
docs/models/operations/AddPlaylistContentsMetadata.md
View File

@@ -5,16 +5,16 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `ratingKey` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 94 |
| `key` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /playlists/94/items |
| `guid` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2 |
| `type` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | playlist |
| `title` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | A great playlist |
| `summary` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | One of my great playlists |
| `smart` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | false |
| `playlistType` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | video |
| `composite` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /playlists/94/composite/1705800070 |
| `duration` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 423000 |
| `leafCount` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 3 |
| `addedAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1705716458 |
| `updatedAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1705800070 |
| `ratingKey` | *Optional<String>* | :heavy_minus_sign: | N/A | 94 |
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | /playlists/94/items |
| `guid` | *Optional<String>* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2 |
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | playlist |
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | A great playlist |
| `summary` | *Optional<String>* | :heavy_minus_sign: | N/A | One of my great playlists |
| `smart` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
| `playlistType` | *Optional<String>* | :heavy_minus_sign: | N/A | video |
| `composite` | *Optional<String>* | :heavy_minus_sign: | N/A | /playlists/94/composite/1705800070 |
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 423000 |
| `leafCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 3 |
| `addedAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1705716458 |
| `updatedAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1705800070 |

2
docs/models/operations/AddPlaylistContentsRequest.md
View File

@@ -7,4 +7,4 @@
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| `playlistID` | *double* | :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` | *Optional<? extends Double>* | :heavy_minus_sign: | the play queue to add to a playlist | 123 |
| `playQueueID` | *Optional<Double>* | :heavy_minus_sign: | the play queue to add to a playlist | 123 |

12
docs/models/operations/AddPlaylistContentsResponse.md
View File

@@ -3,9 +3,9 @@
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.AddPlaylistContentsResponseBody>](../../models/operations/AddPlaylistContentsResponseBody.md) | :heavy_minus_sign: | Playlist Updated |
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<AddPlaylistContentsResponseBody>](../../models/operations/AddPlaylistContentsResponseBody.md) | :heavy_minus_sign: | Playlist Updated |

6
docs/models/operations/AddPlaylistContentsResponseBody.md
View File

@@ -5,6 +5,6 @@ Playlist Updated
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.AddPlaylistContentsMediaContainer>](../../models/operations/AddPlaylistContentsMediaContainer.md) | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional<AddPlaylistContentsMediaContainer>](../../models/operations/AddPlaylistContentsMediaContainer.md) | :heavy_minus_sign: | N/A |

4
docs/models/operations/ApplyUpdatesRequest.md
View File

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tonight` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.Tonight>](../../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` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.Skip>](../../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 |
| `tonight` | [Optional<Tonight>](../../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` | [Optional<Skip>](../../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 |

11
docs/models/operations/AutoSelectSubtitle.md Normal file
View File

@@ -0,0 +1,11 @@
# AutoSelectSubtitle
The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled)
## Values
| Name | Value |
| ------ | ------ |
| `ZERO` | 0 |
| `ONE` | 1 |

9
docs/models/operations/Billing.md Normal file
View File

@@ -0,0 +1,9 @@
# Billing
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `internalPaymentMethod` | [InternalPaymentMethod](../../models/operations/InternalPaymentMethod.md) | :heavy_check_mark: | N/A |
| `paymentMethodId` | *Optional<Long>* | :heavy_check_mark: | N/A |

12
docs/models/operations/ButlerTask.md
View File

@@ -5,9 +5,9 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `name` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | BackupDatabase |
| `interval` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 3 |
| `scheduleRandomized` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | |
| `enabled` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | |
| `title` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Backup Database |
| `description` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Create a backup copy of the server's database in the configured backup directory |
| `name` | *Optional<String>* | :heavy_minus_sign: | N/A | BackupDatabase |
| `interval` | *Optional<Double>* | :heavy_minus_sign: | N/A | 3 |
| `scheduleRandomized` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | |
| `enabled` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | |
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Backup Database |
| `description` | *Optional<String>* | :heavy_minus_sign: | N/A | Create a backup copy of the server's database in the configured backup directory |

6
docs/models/operations/ButlerTasks.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `butlerTask` | List<[lukehagar.plexapi.plexapi.models.operations.ButlerTask](../../models/operations/ButlerTask.md)> | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
| `butlerTask` | List<[ButlerTask](../../models/operations/ButlerTask.md)> | :heavy_minus_sign: | N/A |

6
docs/models/operations/CheckForUpdatesRequest.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `download` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.Download>](../../models/operations/Download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
| `download` | [Optional<Download>](../../models/operations/Download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |

14
docs/models/operations/Connections.md Normal file
View File

@@ -0,0 +1,14 @@
# Connections
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `protocol` | *String* | :heavy_check_mark: | N/A |
| `address` | *String* | :heavy_check_mark: | N/A |
| `port` | *double* | :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 |

6
docs/models/operations/Context.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `librarySectionID` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `librarySectionID` | *Optional<String>* | :heavy_minus_sign: | N/A |

6
docs/models/operations/Country.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | United States of America |
| Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | United States of America |

8
docs/models/operations/CreatePlaylistMediaContainer.md
View File

@@ -3,7 +3,7 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `size` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 7 |
| `metadata` | List<[lukehagar.plexapi.plexapi.models.operations.CreatePlaylistMetadata](../../models/operations/CreatePlaylistMetadata.md)> | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `size` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 7 |
| `metadata` | List<[CreatePlaylistMetadata](../../models/operations/CreatePlaylistMetadata.md)> | :heavy_minus_sign: | N/A | |

32
docs/models/operations/CreatePlaylistMetadata.md
View File

@@ -5,19 +5,19 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `ratingKey` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 96 |
| `key` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /playlists/96/items |
| `guid` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55 |
| `type` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | playlist |
| `title` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | A Great Playlist |
| `summary` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | What a great playlist |
| `smart` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | false |
| `playlistType` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | video |
| `icon` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | playlist://image.smart |
| `viewCount` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
| `lastViewedAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1705719589 |
| `leafCount` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
| `addedAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1705719589 |
| `updatedAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1705724593 |
| `composite` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /playlists/96/composite/1705724593 |
| `duration` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 141000 |
| `ratingKey` | *Optional<String>* | :heavy_minus_sign: | N/A | 96 |
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | /playlists/96/items |
| `guid` | *Optional<String>* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55 |
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | playlist |
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | A Great Playlist |
| `summary` | *Optional<String>* | :heavy_minus_sign: | N/A | What a great playlist |
| `smart` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
| `playlistType` | *Optional<String>* | :heavy_minus_sign: | N/A | video |
| `icon` | *Optional<String>* | :heavy_minus_sign: | N/A | playlist://image.smart |
| `viewCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `lastViewedAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1705719589 |
| `leafCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `addedAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1705719589 |
| `updatedAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1705724593 |
| `composite` | *Optional<String>* | :heavy_minus_sign: | N/A | /playlists/96/composite/1705724593 |
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 141000 |

12
docs/models/operations/CreatePlaylistQueryParamType.md Normal file
View File

@@ -0,0 +1,12 @@
# CreatePlaylistQueryParamType
type of playlist to create
## Values
| Name | Value |
| ------- | ------- |
| `AUDIO` | audio |
| `VIDEO` | video |
| `PHOTO` | photo |

14
docs/models/operations/CreatePlaylistRequest.md
View File

@@ -3,10 +3,10 @@
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `title` | *String* | :heavy_check_mark: | name of the playlist |
| `type` | [lukehagar.plexapi.plexapi.models.operations.QueryParamType](../../models/operations/QueryParamType.md) | :heavy_check_mark: | type of playlist to create |
| `smart` | [lukehagar.plexapi.plexapi.models.operations.Smart](../../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` | *Optional<? extends Double>* | :heavy_minus_sign: | the play queue to copy to a playlist |
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `title` | *String* | :heavy_check_mark: | name of the playlist |
| `type` | [CreatePlaylistQueryParamType](../../models/operations/CreatePlaylistQueryParamType.md) | :heavy_check_mark: | type of playlist to create |
| `smart` | [Smart](../../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` | *Optional<Double>* | :heavy_minus_sign: | the play queue to copy to a playlist |

12
docs/models/operations/CreatePlaylistResponse.md
View File

@@ -3,9 +3,9 @@
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.CreatePlaylistResponseBody>](../../models/operations/CreatePlaylistResponseBody.md) | :heavy_minus_sign: | returns all playlists |
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<CreatePlaylistResponseBody>](../../models/operations/CreatePlaylistResponseBody.md) | :heavy_minus_sign: | returns all playlists |

6
docs/models/operations/CreatePlaylistResponseBody.md
View File

@@ -5,6 +5,6 @@ returns all playlists
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.CreatePlaylistMediaContainer>](../../models/operations/CreatePlaylistMediaContainer.md) | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional<CreatePlaylistMediaContainer>](../../models/operations/CreatePlaylistMediaContainer.md) | :heavy_minus_sign: | N/A |

11
docs/models/operations/DefaultSubtitleAccessibility.md Normal file
View File

@@ -0,0 +1,11 @@
# 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)
## Values
| Name | Value |
| ------ | ------ |
| `ZERO` | 0 |
| `ONE` | 1 |

11
docs/models/operations/DefaultSubtitleForced.md Normal file
View File

@@ -0,0 +1,11 @@
# 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)
## Values
| Name | Value |
| ------ | ------ |
| `ZERO` | 0 |
| `ONE` | 1 |

6
docs/models/operations/DeleteLibraryRequest.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `sectionId` | *double* | :heavy_check_mark: | the Id of the library to query | 1000 |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |

14
docs/models/operations/Device.md
View File

@@ -3,10 +3,10 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `id` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1 |
| `name` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | iPhone |
| `platform` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | iOS |
| `clientIdentifier` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | |
| `createdAt` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1654131230 |
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1 |
| `name` | *Optional<String>* | :heavy_minus_sign: | N/A | iPhone |
| `platform` | *Optional<String>* | :heavy_minus_sign: | N/A | iOS |
| `clientIdentifier` | *Optional<String>* | :heavy_minus_sign: | N/A | |
| `createdAt` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1654131230 |

6
docs/models/operations/Director.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Peyton Reed |
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Peyton Reed |

10
docs/models/operations/Directory.md
View File

@@ -3,8 +3,8 @@
## Fields
| Field | Type | Required | Description |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `count` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A |
| `key` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `title` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `count` | *Optional<Double>* | :heavy_minus_sign: | N/A |
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A |
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A |

10
docs/models/operations/Feature.md Normal file
View File

@@ -0,0 +1,10 @@
# Feature
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A |
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A |
| `directory` | List<[GetMediaProvidersDirectory](../../models/operations/GetMediaProvidersDirectory.md)> | :heavy_minus_sign: | N/A |

66
docs/models/operations/Features.md Normal file
View File

@@ -0,0 +1,66 @@
# Features
## Values
| Name | Value |
| ----------------------------------------- | ----------------------------------------- |
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
| `ANDROID_PI_P` | Android - PiP |
| `CU_SUNSET` | CU Sunset |
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
| `AVOD_NEW_MEDIA` | avod-new-media |
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
| `COLLECTIONS` | collections |
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
| `COMPANIONS_SONOS` | companions_sonos |
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
| `DRM_SUPPORT` | drm_support |
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
| `FEDERATED_AUTH` | federated-auth |
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
| `GUIDED_UPGRADE` | guided-upgrade |
| `HOME` | home |
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
| `KEVIN_BACON` | kevin-bacon |
| `KOREA_CONSENT` | korea-consent |
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
| `LETS_ENCRYPT` | lets_encrypt |
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
| `LIVETV` | livetv |
| `METADATA_SEARCH` | metadata_search |
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
| `PHOTOS_FAVORITES` | photos-favorites |
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
| `PMS_HEALTH` | pms_health |
| `RADIO` | radio |
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
| `SIGNIN_WITH_APPLE` | signin_with_apple |
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
| `TRANSCODER_CACHE` | transcoder_cache |
| `TUNER_SHARING` | tuner-sharing |
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
| `UPGRADE3DS2` | upgrade-3ds2 |
| `VOD_SCHEMA` | vod-schema |
| `VOD_CLOUDFLARE` | vod_cloudflare |
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |

12
docs/models/operations/Field.md
View File

@@ -3,9 +3,9 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `key` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | label |
| `title` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Label |
| `type` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | tag |
| `subType` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | bitrate |
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | label |
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Label |
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | tag |
| `subType` | *Optional<String>* | :heavy_minus_sign: | N/A | bitrate |

8
docs/models/operations/FieldType.md
View File

@@ -3,7 +3,7 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `type` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | resolution |
| `operator` | List<[lukehagar.plexapi.plexapi.models.operations.Operator](../../models/operations/Operator.md)> | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | resolution |
| `operator` | List<[Operator](../../models/operations/Operator.md)> | :heavy_minus_sign: | N/A | |

13
docs/models/operations/Filter.md
View File

@@ -1,11 +1,12 @@
# Filter
Filters content by field and direction/equality
(Unknown if viewedAt is the only supported column)
Filter
## Values
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |
| Name | Value |
| ----------- | ----------- |
| `ALL` | all |
| `AVAILABLE` | available |
| `RELEASED` | released |

6
docs/models/operations/Force.md
View File

@@ -1,10 +1,6 @@
# Force
Force overwriting of duplicate playlists.
By default, a playlist file uploaded with the same path will overwrite the existing playlist.
The `force` argument is used to disable overwriting.
If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.
Force the refresh even if the library is already being refreshed.
## Values

19
docs/models/operations/Friend.md Normal file
View File

@@ -0,0 +1,19 @@
# Friend
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
| `email` | *String* | :heavy_check_mark: | The account email address | username@email.com |
| `friendlyName` | *Optional<String>* | :heavy_check_mark: | The account full name | exampleUser |
| `home` | *boolean* | :heavy_check_mark: | If the account is a Plex Home user | |
| `id` | *int* | :heavy_check_mark: | The Plex account ID | |
| `restricted` | *Optional<Boolean>* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
| `sharedServers` | List<[SharedServers](../../models/operations/SharedServers.md)> | :heavy_check_mark: | N/A | |
| `sharedSources` | List<[SharedSources](../../models/operations/SharedSources.md)> | :heavy_check_mark: | N/A | |
| `status` | [Status](../../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 |

6
docs/models/operations/Genre.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Comedy |
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Comedy |

20
docs/models/operations/GeoData.md Normal file
View File

@@ -0,0 +1,20 @@
# GeoData
Geo location data
## 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` | *Optional<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` | *long* | :heavy_check_mark: | The postal code of the location. | 802 |
| `inPrivacyRestrictedCountry` | *Optional<Boolean>* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
| `inPrivacyRestrictedRegion` | *Optional<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 |

28
docs/models/operations/GetAllLibrariesDirectory.md Normal file
View File

@@ -0,0 +1,28 @@
# GetAllLibrariesDirectory
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `allowSync` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `art` | *Optional<String>* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `composite` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/sections/1/composite/1705615584 |
| `filters` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `refreshing` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
| `thumb` | *Optional<String>* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | 1 |
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | movie |
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Movies |
| `agent` | *Optional<String>* | :heavy_minus_sign: | N/A | tv.plex.agents.movie |
| `scanner` | *Optional<String>* | :heavy_minus_sign: | N/A | Plex Movie |
| `language` | *Optional<String>* | :heavy_minus_sign: | N/A | en-US |
| `uuid` | *Optional<String>* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `updatedAt` | *Optional<Integer>* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `createdAt` | *Optional<Integer>* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `scannedAt` | *Optional<Integer>* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `content` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `directory` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `contentChangedAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 3192854 |
| `hidden` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 0 |
| `location` | List<[Location](../../models/operations/Location.md)> | :heavy_minus_sign: | N/A | |

11
docs/models/operations/GetAllLibrariesMediaContainer.md Normal file
View File

@@ -0,0 +1,11 @@
# GetAllLibrariesMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `size` | *int* | :heavy_check_mark: | N/A | 5 |
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
| `title1` | *String* | :heavy_check_mark: | N/A | Plex Library |
| `directory` | List<[GetAllLibrariesDirectory](../../models/operations/GetAllLibrariesDirectory.md)> | :heavy_minus_sign: | N/A | |

11
docs/models/operations/GetAllLibrariesResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetAllLibrariesResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<GetAllLibrariesResponseBody>](../../models/operations/GetAllLibrariesResponseBody.md) | :heavy_minus_sign: | The libraries available on the Server |

10
docs/models/operations/GetAllLibrariesResponseBody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetAllLibrariesResponseBody
The libraries available on the Server
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional<GetAllLibrariesMediaContainer>](../../models/operations/GetAllLibrariesMediaContainer.md) | :heavy_minus_sign: | N/A |

8
docs/models/operations/GetAvailableClientsMediaContainer.md
View File

@@ -3,7 +3,7 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `size` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1 |
| `server` | List<[lukehagar.plexapi.plexapi.models.operations.Server](../../models/operations/Server.md)> | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
| `size` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1 |
| `server` | List<[Server](../../models/operations/Server.md)> | :heavy_minus_sign: | N/A | |

12
docs/models/operations/GetAvailableClientsResponse.md
View File

@@ -3,9 +3,9 @@
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetAvailableClientsResponseBody>](../../models/operations/GetAvailableClientsResponseBody.md) | :heavy_minus_sign: | Available Clients |
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<GetAvailableClientsResponseBody>](../../models/operations/GetAvailableClientsResponseBody.md) | :heavy_minus_sign: | Available Clients |

6
docs/models/operations/GetAvailableClientsResponseBody.md
View File

@@ -5,6 +5,6 @@ Available Clients
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetAvailableClientsMediaContainer>](../../models/operations/GetAvailableClientsMediaContainer.md) | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional<GetAvailableClientsMediaContainer>](../../models/operations/GetAvailableClientsMediaContainer.md) | :heavy_minus_sign: | N/A |

16
docs/models/operations/GetBandwidthStatisticsAccount.md
View File

@@ -5,11 +5,11 @@
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `id` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 238960586 |
| `key` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /accounts/238960586 |
| `name` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Diane |
| `defaultAudioLanguage` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | en |
| `autoSelectAudio` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |
| `defaultSubtitleLanguage` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | en |
| `subtitleMode` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
| `thumb` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | https://plex.tv/users/50d83634246da1de/avatar?c=1707110967 |
| `id` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 238960586 |
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | /accounts/238960586 |
| `name` | *Optional<String>* | :heavy_minus_sign: | N/A | Diane |
| `defaultAudioLanguage` | *Optional<String>* | :heavy_minus_sign: | N/A | en |
| `autoSelectAudio` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `defaultSubtitleLanguage` | *Optional<String>* | :heavy_minus_sign: | N/A | en |
| `subtitleMode` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `thumb` | *Optional<String>* | :heavy_minus_sign: | N/A | https://plex.tv/users/50d83634246da1de/avatar?c=1707110967 |

10
docs/models/operations/GetBandwidthStatisticsDevice.md
View File

@@ -5,8 +5,8 @@
| Field | Type | Required | Description | Example |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `id` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 208 |
| `name` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Roku Express |
| `platform` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Roku |
| `clientIdentifier` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 793095d235660625108ef785cc7646e9 |
| `createdAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1706470556 |
| `id` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 208 |
| `name` | *Optional<String>* | :heavy_minus_sign: | N/A | Roku Express |
| `platform` | *Optional<String>* | :heavy_minus_sign: | N/A | Roku |
| `clientIdentifier` | *Optional<String>* | :heavy_minus_sign: | N/A | 793095d235660625108ef785cc7646e9 |
| `createdAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1706470556 |

12
docs/models/operations/GetBandwidthStatisticsMediaContainer.md
View File

@@ -3,9 +3,9 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `size` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 5497 |
| `device` | List<[lukehagar.plexapi.plexapi.models.operations.GetBandwidthStatisticsDevice](../../models/operations/GetBandwidthStatisticsDevice.md)> | :heavy_minus_sign: | N/A | |
| `account` | List<[lukehagar.plexapi.plexapi.models.operations.GetBandwidthStatisticsAccount](../../models/operations/GetBandwidthStatisticsAccount.md)> | :heavy_minus_sign: | N/A | |
| `statisticsBandwidth` | List<[lukehagar.plexapi.plexapi.models.operations.StatisticsBandwidth](../../models/operations/StatisticsBandwidth.md)> | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `size` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 5497 |
| `device` | List<[GetBandwidthStatisticsDevice](../../models/operations/GetBandwidthStatisticsDevice.md)> | :heavy_minus_sign: | N/A | |
| `account` | List<[GetBandwidthStatisticsAccount](../../models/operations/GetBandwidthStatisticsAccount.md)> | :heavy_minus_sign: | N/A | |
| `statisticsBandwidth` | List<[StatisticsBandwidth](../../models/operations/StatisticsBandwidth.md)> | :heavy_minus_sign: | N/A | |

2
docs/models/operations/GetBandwidthStatisticsRequest.md
View File

@@ -5,4 +5,4 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `timespan` | *Optional<? extends Long>* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
| `timespan` | *Optional<Long>* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |

12
docs/models/operations/GetBandwidthStatisticsResponse.md
View File

@@ -3,9 +3,9 @@
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetBandwidthStatisticsResponseBody>](../../models/operations/GetBandwidthStatisticsResponseBody.md) | :heavy_minus_sign: | Bandwidth Statistics |
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<GetBandwidthStatisticsResponseBody>](../../models/operations/GetBandwidthStatisticsResponseBody.md) | :heavy_minus_sign: | Bandwidth Statistics |

6
docs/models/operations/GetBandwidthStatisticsResponseBody.md
View File

@@ -5,6 +5,6 @@ Bandwidth Statistics
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetBandwidthStatisticsMediaContainer>](../../models/operations/GetBandwidthStatisticsMediaContainer.md) | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional<GetBandwidthStatisticsMediaContainer>](../../models/operations/GetBandwidthStatisticsMediaContainer.md) | :heavy_minus_sign: | N/A |

13
docs/models/operations/GetBannerImageRequest.md Normal file
View File

@@ -0,0 +1,13 @@
# GetBannerImageRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `ratingKey` | *long* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
| `width` | *long* | :heavy_check_mark: | N/A | 396 |
| `height` | *long* | :heavy_check_mark: | N/A | 396 |
| `minSize` | *long* | :heavy_check_mark: | N/A | 1 |
| `upscale` | *long* | :heavy_check_mark: | N/A | 1 |
| `xPlexToken` | *String* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |

12
docs/models/operations/GetBannerImageResponse.md Normal file
View File

@@ -0,0 +1,12 @@
# GetBannerImageResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `responseStream` | *Optional<InputStream>* | :heavy_minus_sign: | Successful response returning an image |
| `headers` | Map<String, List<*String*>> | :heavy_check_mark: | N/A |

12
docs/models/operations/GetButlerTasksResponse.md
View File

@@ -3,9 +3,9 @@
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetButlerTasksResponseBody>](../../models/operations/GetButlerTasksResponseBody.md) | :heavy_minus_sign: | All butler tasks |
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<GetButlerTasksResponseBody>](../../models/operations/GetButlerTasksResponseBody.md) | :heavy_minus_sign: | All butler tasks |

6
docs/models/operations/GetButlerTasksResponseBody.md
View File

@@ -5,6 +5,6 @@ All butler tasks
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `butlerTasks` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.ButlerTasks>](../../models/operations/ButlerTasks.md) | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
| `butlerTasks` | [Optional<ButlerTasks>](../../models/operations/ButlerTasks.md) | :heavy_minus_sign: | N/A |

11
docs/models/operations/GetCompanionsDataResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetCompanionsDataResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `responseBodies` | List<[ResponseBody](../../models/operations/ResponseBody.md)> | :heavy_minus_sign: | Companions Data |

10
docs/models/operations/GetDevicesMediaContainer.md
View File

@@ -3,8 +3,8 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `size` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 151 |
| `identifier` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | com.plexapp.system.devices |
| `device` | List<[lukehagar.plexapi.plexapi.models.operations.Device](../../models/operations/Device.md)> | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
| `size` | *Optional<Double>* | :heavy_minus_sign: | N/A | 151 |
| `identifier` | *Optional<String>* | :heavy_minus_sign: | N/A | com.plexapp.system.devices |
| `device` | List<[Device](../../models/operations/Device.md)> | :heavy_minus_sign: | N/A | |

12
docs/models/operations/GetDevicesResponse.md
View File

@@ -3,9 +3,9 @@
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetDevicesResponseBody>](../../models/operations/GetDevicesResponseBody.md) | :heavy_minus_sign: | Devices |
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<GetDevicesResponseBody>](../../models/operations/GetDevicesResponseBody.md) | :heavy_minus_sign: | Devices |

6
docs/models/operations/GetDevicesResponseBody.md
View File

@@ -5,6 +5,6 @@ Devices
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetDevicesMediaContainer>](../../models/operations/GetDevicesMediaContainer.md) | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional<GetDevicesMediaContainer>](../../models/operations/GetDevicesMediaContainer.md) | :heavy_minus_sign: | N/A |

2
docs/models/operations/GetFileHashRequest.md
View File

@@ -6,4 +6,4 @@
| 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` | *Optional<? extends Double>* | :heavy_minus_sign: | Item type | |
| `type` | *Optional<Double>* | :heavy_minus_sign: | Item type | |

20
docs/models/operations/GetGeoDataGeoData.md Normal file
View File

@@ -0,0 +1,20 @@
# GetGeoDataGeoData
Geo location data
## 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` | *Optional<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` | *long* | :heavy_check_mark: | The postal code of the location. | 802 |
| `inPrivacyRestrictedCountry` | *Optional<Boolean>* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
| `inPrivacyRestrictedRegion` | *Optional<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 |

24
docs/models/operations/GetPinResponseBody.md → docs/models/operations/GetGeoDataResponse.md
View File

@@ -1,21 +1,11 @@
# GetPinResponseBody
The Pin
# GetGeoDataResponse
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *Optional<? extends Double>* | :heavy_minus_sign: | PinID for use with authentication | 1272322473 |
| `code` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 3patfx1a78ukcbr7x0n9bl26t |
| `product` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Plex Web |
| `trusted` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | |
| `qr` | *Optional<? extends String>* | :heavy_minus_sign: | a link to a QR code hosted on plex.tv <br/>The QR code redirects to the relevant `plex.tv/link` authentication page<br/>Which then prompts the user for the 4 Digit Link Pin<br/> | https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t |
| `clientIdentifier` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Postman |
| `location` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.Location>](../../models/operations/Location.md) | :heavy_minus_sign: | N/A | |
| `expiresIn` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1800 |
| `createdAt` | [OffsetDateTime](https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html) | :heavy_minus_sign: | N/A | 2023-04-12 17:00:03 +0000 UTC |
| `expiresAt` | [OffsetDateTime](https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html) | :heavy_minus_sign: | N/A | 2023-04-12 17:30:03 +0000 UTC |
| `authToken` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | |
| `newRegistration` | *JsonNullable<? extends Boolean>* | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | |
| `geoData` | [Optional<GetGeoDataGeoData>](../../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/>} |

12
docs/models/operations/GetGlobalHubsMediaContainer.md
View File

@@ -3,9 +3,9 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `size` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 8 |
| `allowSync` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |
| `identifier` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `hub` | List<[lukehagar.plexapi.plexapi.models.operations.Hub](../../models/operations/Hub.md)> | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
| `size` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 8 |
| `allowSync` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `identifier` | *Optional<String>* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `hub` | List<[Hub](../../models/operations/Hub.md)> | :heavy_minus_sign: | N/A | |

34
docs/models/operations/GetGlobalHubsMetadata.md
View File

@@ -5,20 +5,20 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `ratingKey` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 57070 |
| `key` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /playlists/57070/items |
| `guid` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c |
| `type` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | playlist |
| `title` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | November Movie Day |
| `titleSort` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Tracks |
| `summary` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | |
| `smart` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | false |
| `playlistType` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | video |
| `composite` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /playlists/57070/composite/1668787730 |
| `icon` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | playlist://image.smart |
| `viewCount` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 2 |
| `lastViewedAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1668787732 |
| `duration` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 16873000 |
| `leafCount` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 3 |
| `addedAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1668779618 |
| `updatedAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1668787730 |
| `ratingKey` | *Optional<String>* | :heavy_minus_sign: | N/A | 57070 |
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | /playlists/57070/items |
| `guid` | *Optional<String>* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c |
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | playlist |
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | November Movie Day |
| `titleSort` | *Optional<String>* | :heavy_minus_sign: | N/A | Tracks |
| `summary` | *Optional<String>* | :heavy_minus_sign: | N/A | |
| `smart` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
| `playlistType` | *Optional<String>* | :heavy_minus_sign: | N/A | video |
| `composite` | *Optional<String>* | :heavy_minus_sign: | N/A | /playlists/57070/composite/1668787730 |
| `icon` | *Optional<String>* | :heavy_minus_sign: | N/A | playlist://image.smart |
| `viewCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2 |
| `lastViewedAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1668787732 |
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 16873000 |
| `leafCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 3 |
| `addedAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1668779618 |
| `updatedAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1668787730 |

4
docs/models/operations/GetGlobalHubsRequest.md
View File

@@ -5,5 +5,5 @@
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `count` | *Optional<? extends Double>* | :heavy_minus_sign: | The number of items to return with each hub. |
| `onlyTransient` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.OnlyTransient>](../../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). |
| `count` | *Optional<Double>* | :heavy_minus_sign: | The number of items to return with each hub. |
| `onlyTransient` | [Optional<OnlyTransient>](../../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). |

12
docs/models/operations/GetGlobalHubsResponse.md
View File

@@ -3,9 +3,9 @@
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetGlobalHubsResponseBody>](../../models/operations/GetGlobalHubsResponseBody.md) | :heavy_minus_sign: | returns global hubs |
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<GetGlobalHubsResponseBody>](../../models/operations/GetGlobalHubsResponseBody.md) | :heavy_minus_sign: | returns global hubs |

6
docs/models/operations/GetGlobalHubsResponseBody.md
View File

@@ -5,6 +5,6 @@ returns global hubs
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetGlobalHubsMediaContainer>](../../models/operations/GetGlobalHubsMediaContainer.md) | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional<GetGlobalHubsMediaContainer>](../../models/operations/GetGlobalHubsMediaContainer.md) | :heavy_minus_sign: | N/A |

12
docs/models/operations/GetHomeDataResponse.md
View File

@@ -3,9 +3,9 @@
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetHomeDataResponseBody>](../../models/operations/GetHomeDataResponseBody.md) | :heavy_minus_sign: | Home Data |
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<GetHomeDataResponseBody>](../../models/operations/GetHomeDataResponseBody.md) | :heavy_minus_sign: | Home Data |

16
docs/models/operations/GetHomeDataResponseBody.md
View File

@@ -5,11 +5,11 @@ Home Data
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
| `id` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1841489 |
| `name` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Blindkitty38's home |
| `guestUserID` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 58815432 |
| `guestUserUUID` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | f3df4e01bfca0787 |
| `guestEnabled` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | |
| `subscription` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
| `id` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1841489 |
| `name` | *Optional<String>* | :heavy_minus_sign: | N/A | Blindkitty38's home |
| `guestUserID` | *Optional<Double>* | :heavy_minus_sign: | N/A | 58815432 |
| `guestUserUUID` | *Optional<String>* | :heavy_minus_sign: | N/A | f3df4e01bfca0787 |
| `guestEnabled` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | |
| `subscription` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | |

28
docs/models/operations/GetLibrariesDirectory.md
View File

@@ -1,28 +0,0 @@
# GetLibrariesDirectory
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `allowSync` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |
| `art` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `composite` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/sections/1/composite/1705615584 |
| `filters` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |
| `refreshing` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | false |
| `thumb` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
| `key` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 1 |
| `type` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | movie |
| `title` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Movies |
| `agent` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | tv.plex.agents.movie |
| `scanner` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Plex Movie |
| `language` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | en-US |
| `uuid` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `updatedAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1705615634 |
| `createdAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1654131312 |
| `scannedAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1705615584 |
| `content` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |
| `directory` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |
| `contentChangedAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 3192854 |
| `hidden` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 0 |
| `location` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibrariesLocation](../../models/operations/GetLibrariesLocation.md)> | :heavy_minus_sign: | N/A | |

9
docs/models/operations/GetLibrariesLocation.md
View File

@@ -1,9 +0,0 @@
# GetLibrariesLocation
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
| `id` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
| `path` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /movies |

11
docs/models/operations/GetLibrariesMediaContainer.md
View File

@@ -1,11 +0,0 @@
# GetLibrariesMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `size` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 5 |
| `allowSync` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | false |
| `title1` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Plex Library |
| `directory` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibrariesDirectory](../../models/operations/GetLibrariesDirectory.md)> | :heavy_minus_sign: | N/A | |

11
docs/models/operations/GetLibrariesResponse.md
View File

@@ -1,11 +0,0 @@
# GetLibrariesResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetLibrariesResponseBody>](../../models/operations/GetLibrariesResponseBody.md) | :heavy_minus_sign: | The libraries available on the Server |

10
docs/models/operations/GetLibrariesResponseBody.md
View File

@@ -1,10 +0,0 @@
# GetLibrariesResponseBody
The libraries available on the Server
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetLibrariesMediaContainer>](../../models/operations/GetLibrariesMediaContainer.md) | :heavy_minus_sign: | N/A |

12
docs/models/operations/GetLibraryDetailsDirectory.md Normal file
View File

@@ -0,0 +1,12 @@
# GetLibraryDetailsDirectory
## Fields
| Field | Type | Required | Description | Example |
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | search?type=1 |
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Search... |
| `secondary` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `prompt` | *Optional<String>* | :heavy_minus_sign: | N/A | Search Movies |
| `search` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |

12
docs/models/operations/GetLibraryDetailsFilter.md Normal file
View File

@@ -0,0 +1,12 @@
# GetLibraryDetailsFilter
## Fields
| Field | Type | Required | Description | Example |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `filter` | *Optional<String>* | :heavy_minus_sign: | N/A | label |
| `filterType` | *Optional<String>* | :heavy_minus_sign: | N/A | string |
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/sections/1/label |
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Labels |
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | filter |

22
docs/models/operations/GetLibraryDetailsMediaContainer.md Normal file
View File

@@ -0,0 +1,22 @@
# GetLibraryDetailsMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `size` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 29 |
| `allowSync` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
| `art` | *Optional<String>* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `content` | *Optional<String>* | :heavy_minus_sign: | N/A | secondary |
| `identifier` | *Optional<String>* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `librarySectionID` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `mediaTagPrefix` | *Optional<String>* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1701731894 |
| `thumb` | *Optional<String>* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
| `title1` | *Optional<String>* | :heavy_minus_sign: | N/A | Movies |
| `viewGroup` | *Optional<String>* | :heavy_minus_sign: | N/A | secondary |
| `viewMode` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 65592 |
| `directory` | List<[GetLibraryDetailsDirectory](../../models/operations/GetLibraryDetailsDirectory.md)> | :heavy_minus_sign: | N/A | |
| `type` | List<[GetLibraryDetailsType](../../models/operations/GetLibraryDetailsType.md)> | :heavy_minus_sign: | N/A | |
| `fieldType` | List<[FieldType](../../models/operations/FieldType.md)> | :heavy_minus_sign: | N/A | |

6
docs/models/operations/GetLibraryRequest.md → docs/models/operations/GetLibraryDetailsRequest.md
View File

@@ -1,9 +1,9 @@
# GetLibraryRequest
# GetLibraryDetailsRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `sectionId` | *double* | :heavy_check_mark: | the Id of the library to query | 1000 |
| `includeDetails` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.IncludeDetails>](../../models/operations/IncludeDetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
| `sectionKey` | *int* | :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` | [Optional<IncludeDetails>](../../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/> | |

11
docs/models/operations/GetLibraryDetailsResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetLibraryDetailsResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<GetLibraryDetailsResponseBody>](../../models/operations/GetLibraryDetailsResponseBody.md) | :heavy_minus_sign: | The details of the library |

10
docs/models/operations/GetLibraryDetailsResponseBody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetLibraryDetailsResponseBody
The details of the library
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional<GetLibraryDetailsMediaContainer>](../../models/operations/GetLibraryDetailsMediaContainer.md) | :heavy_minus_sign: | N/A |

14
docs/models/operations/GetLibraryDetailsType.md Normal file
View File

@@ -0,0 +1,14 @@
# GetLibraryDetailsType
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/sections/1/all?type=1 |
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | movie |
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Movies |
| `active` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
| `filter` | List<[GetLibraryDetailsFilter](../../models/operations/GetLibraryDetailsFilter.md)> | :heavy_minus_sign: | N/A | |
| `sort` | List<[Sort](../../models/operations/Sort.md)> | :heavy_minus_sign: | N/A | |
| `field` | List<[Field](../../models/operations/Field.md)> | :heavy_minus_sign: | N/A | |

12
docs/models/operations/GetLibraryDirectory.md
View File

@@ -1,12 +0,0 @@
# GetLibraryDirectory
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
| `key` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | search?type=1 |
| `title` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Search... |
| `secondary` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |
| `prompt` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Search Movies |
| `search` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |

12
docs/models/operations/GetLibraryFilter.md
View File

@@ -1,12 +0,0 @@
# GetLibraryFilter
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `filter` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | label |
| `filterType` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | string |
| `key` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/sections/1/label |
| `title` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Labels |
| `type` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | filter |

6
docs/models/operations/GetLibraryHubsCountry.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | United States of America |
| Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | United States of America |

6
docs/models/operations/GetLibraryHubsDirector.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Nathan Greno |
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Nathan Greno |

6
docs/models/operations/GetLibraryHubsGenre.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Animation |
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Animation |

28
docs/models/operations/GetLibraryHubsHub.md
View File

@@ -3,17 +3,17 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `key` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/sections/1/all?sort=lastViewedAt:desc&unwatched=0&viewOffset=0 |
| `title` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Recently Played Movies |
| `type` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | movie |
| `hubIdentifier` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | movie.recentlyviewed.1 |
| `context` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | hub.movie.recentlyviewed |
| `size` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 6 |
| `more` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |
| `style` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | shelf |
| `hubKey` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/66485,66098,57249,11449,5858,14944 |
| `metadata` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryHubsMetadata](../../models/operations/GetLibraryHubsMetadata.md)> | :heavy_minus_sign: | N/A | |
| `promoted` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |
| `random` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/sections/1/all?sort=lastViewedAt:desc&unwatched=0&viewOffset=0 |
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Recently Played Movies |
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | movie |
| `hubIdentifier` | *Optional<String>* | :heavy_minus_sign: | N/A | movie.recentlyviewed.1 |
| `context` | *Optional<String>* | :heavy_minus_sign: | N/A | hub.movie.recentlyviewed |
| `size` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 6 |
| `more` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `style` | *Optional<String>* | :heavy_minus_sign: | N/A | shelf |
| `hubKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66485,66098,57249,11449,5858,14944 |
| `metadata` | List<[GetLibraryHubsMetadata](../../models/operations/GetLibraryHubsMetadata.md)> | :heavy_minus_sign: | N/A | |
| `promoted` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `random` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |

38
docs/models/operations/GetLibraryHubsMedia.md
View File

@@ -3,22 +3,22 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `id` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 38247 |
| `duration` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 6017237 |
| `bitrate` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 2051 |
| `width` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1920 |
| `height` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1080 |
| `aspectRatio` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1.78 |
| `audioChannels` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 2 |
| `audioCodec` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | aac |
| `videoCodec` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | h264 |
| `videoResolution` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 1080 |
| `container` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | mp4 |
| `videoFrameRate` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 24p |
| `optimizedForStreaming` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
| `audioProfile` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | lc |
| `has64bitOffsets` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | false |
| `videoProfile` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | high |
| `part` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryHubsPart](../../models/operations/GetLibraryHubsPart.md)> | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `id` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 38247 |
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 6017237 |
| `bitrate` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2051 |
| `width` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1920 |
| `height` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1080 |
| `aspectRatio` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1.78 |
| `audioChannels` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2 |
| `audioCodec` | *Optional<String>* | :heavy_minus_sign: | N/A | aac |
| `videoCodec` | *Optional<String>* | :heavy_minus_sign: | N/A | h264 |
| `videoResolution` | *Optional<String>* | :heavy_minus_sign: | N/A | 1080 |
| `container` | *Optional<String>* | :heavy_minus_sign: | N/A | mp4 |
| `videoFrameRate` | *Optional<String>* | :heavy_minus_sign: | N/A | 24p |
| `optimizedForStreaming` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `audioProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | lc |
| `has64bitOffsets` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
| `videoProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | high |
| `part` | List<[GetLibraryHubsPart](../../models/operations/GetLibraryHubsPart.md)> | :heavy_minus_sign: | N/A | |

18
docs/models/operations/GetLibraryHubsMediaContainer.md
View File

@@ -3,12 +3,12 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `size` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 7 |
| `allowSync` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |
| `identifier` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `librarySectionID` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionTitle` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionUUID` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `hub` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryHubsHub](../../models/operations/GetLibraryHubsHub.md)> | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| `size` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 7 |
| `allowSync` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `identifier` | *Optional<String>* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `librarySectionID` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionUUID` | *Optional<String>* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `hub` | List<[GetLibraryHubsHub](../../models/operations/GetLibraryHubsHub.md)> | :heavy_minus_sign: | N/A | |

66
docs/models/operations/GetLibraryHubsMetadata.md
View File

@@ -5,37 +5,37 @@
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ratingKey` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 14944 |
| `key` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/14944 |
| `guid` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | plex://movie/5d77686eeb5d26001f1eb339 |
| `studio` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Walt Disney Animation Studios |
| `type` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | movie |
| `title` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Tangled |
| `librarySectionTitle` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionID` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionKey` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `contentRating` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | PG |
| `summary` | *Optional<? extends 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` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 8.9 |
| `audienceRating` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 8.7 |
| `viewCount` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
| `lastViewedAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1704936047 |
| `year` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 2010 |
| `tagline` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | They're taking adventure to new lengths. |
| `thumb` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/14944/thumb/1705739847 |
| `art` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/14944/art/1705739847 |
| `duration` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 6017237 |
| `ratingKey` | *Optional<String>* | :heavy_minus_sign: | N/A | 14944 |
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/14944 |
| `guid` | *Optional<String>* | :heavy_minus_sign: | N/A | plex://movie/5d77686eeb5d26001f1eb339 |
| `studio` | *Optional<String>* | :heavy_minus_sign: | N/A | Walt Disney Animation Studios |
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | movie |
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Tangled |
| `librarySectionTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionID` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `contentRating` | *Optional<String>* | :heavy_minus_sign: | N/A | PG |
| `summary` | *Optional<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` | *Optional<Double>* | :heavy_minus_sign: | N/A | 8.9 |
| `audienceRating` | *Optional<Double>* | :heavy_minus_sign: | N/A | 8.7 |
| `viewCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `lastViewedAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1704936047 |
| `year` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2010 |
| `tagline` | *Optional<String>* | :heavy_minus_sign: | N/A | They're taking adventure to new lengths. |
| `thumb` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/14944/thumb/1705739847 |
| `art` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/14944/art/1705739847 |
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 6017237 |
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_minus_sign: | N/A | 2010-11-24 00:00:00 +0000 UTC |
| `addedAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1589412494 |
| `updatedAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1705739847 |
| `audienceRatingImage` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `primaryExtraKey` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/14952 |
| `ratingImage` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
| `media` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryHubsMedia](../../models/operations/GetLibraryHubsMedia.md)> | :heavy_minus_sign: | N/A | |
| `genre` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryHubsGenre](../../models/operations/GetLibraryHubsGenre.md)> | :heavy_minus_sign: | N/A | |
| `country` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryHubsCountry](../../models/operations/GetLibraryHubsCountry.md)> | :heavy_minus_sign: | N/A | |
| `director` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryHubsDirector](../../models/operations/GetLibraryHubsDirector.md)> | :heavy_minus_sign: | N/A | |
| `role` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryHubsRole](../../models/operations/GetLibraryHubsRole.md)> | :heavy_minus_sign: | N/A | |
| `writer` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryHubsWriter](../../models/operations/GetLibraryHubsWriter.md)> | :heavy_minus_sign: | N/A | |
| `skipCount` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
| `chapterSource` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | media |
| `addedAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1589412494 |
| `updatedAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1705739847 |
| `audienceRatingImage` | *Optional<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `primaryExtraKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/14952 |
| `ratingImage` | *Optional<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
| `media` | List<[GetLibraryHubsMedia](../../models/operations/GetLibraryHubsMedia.md)> | :heavy_minus_sign: | N/A | |
| `genre` | List<[GetLibraryHubsGenre](../../models/operations/GetLibraryHubsGenre.md)> | :heavy_minus_sign: | N/A | |
| `country` | List<[GetLibraryHubsCountry](../../models/operations/GetLibraryHubsCountry.md)> | :heavy_minus_sign: | N/A | |
| `director` | List<[GetLibraryHubsDirector](../../models/operations/GetLibraryHubsDirector.md)> | :heavy_minus_sign: | N/A | |
| `role` | List<[GetLibraryHubsRole](../../models/operations/GetLibraryHubsRole.md)> | :heavy_minus_sign: | N/A | |
| `writer` | List<[GetLibraryHubsWriter](../../models/operations/GetLibraryHubsWriter.md)> | :heavy_minus_sign: | N/A | |
| `skipCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `chapterSource` | *Optional<String>* | :heavy_minus_sign: | N/A | media |

20
docs/models/operations/GetLibraryHubsPart.md
View File

@@ -5,13 +5,13 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
| `id` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 38247 |
| `key` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/parts/38247/1589412494/file.mp4 |
| `duration` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 6017237 |
| `file` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4 |
| `size` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1545647447 |
| `audioProfile` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | lc |
| `container` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | mp4 |
| `has64bitOffsets` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |
| `videoProfile` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | high |
| `id` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 38247 |
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/parts/38247/1589412494/file.mp4 |
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 6017237 |
| `file` | *Optional<String>* | :heavy_minus_sign: | N/A | /movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4 |
| `size` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1545647447 |
| `audioProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | lc |
| `container` | *Optional<String>* | :heavy_minus_sign: | N/A | mp4 |
| `has64bitOffsets` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `videoProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | high |

4
docs/models/operations/GetLibraryHubsRequest.md
View File

@@ -6,5 +6,5 @@
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sectionId` | *double* | :heavy_check_mark: | the Id of the library to query |
| `count` | *Optional<? extends Double>* | :heavy_minus_sign: | The number of items to return with each hub. |
| `onlyTransient` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.QueryParamOnlyTransient>](../../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). |
| `count` | *Optional<Double>* | :heavy_minus_sign: | The number of items to return with each hub. |
| `onlyTransient` | [Optional<QueryParamOnlyTransient>](../../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). |

12
docs/models/operations/GetLibraryHubsResponse.md
View File

@@ -3,9 +3,9 @@
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetLibraryHubsResponseBody>](../../models/operations/GetLibraryHubsResponseBody.md) | :heavy_minus_sign: | The hubs specific to the library |
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional<GetLibraryHubsResponseBody>](../../models/operations/GetLibraryHubsResponseBody.md) | :heavy_minus_sign: | The hubs specific to the library |

6
docs/models/operations/GetLibraryHubsResponseBody.md
View File

@@ -5,6 +5,6 @@ The hubs specific to the library
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetLibraryHubsMediaContainer>](../../models/operations/GetLibraryHubsMediaContainer.md) | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional<GetLibraryHubsMediaContainer>](../../models/operations/GetLibraryHubsMediaContainer.md) | :heavy_minus_sign: | N/A |

6
docs/models/operations/GetLibraryHubsRole.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Donna Murphy |
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Donna Murphy |

6
docs/models/operations/GetLibraryHubsWriter.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Wilhelm Grimm |
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Wilhelm Grimm |

6
docs/models/operations/GetLibraryItemsCountry.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | United States of America |
| Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | United States of America |

6
docs/models/operations/GetLibraryItemsDirector.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | James Cameron |
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | James Cameron |

6
docs/models/operations/GetLibraryItemsGenre.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Adventure |
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Adventure |

32
docs/models/operations/GetLibraryItemsMedia.md
View File

@@ -3,19 +3,19 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `id` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 119534 |
| `duration` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 11558112 |
| `bitrate` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 25025 |
| `width` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 3840 |
| `height` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 2072 |
| `aspectRatio` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1.85 |
| `audioChannels` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 6 |
| `audioCodec` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | eac3 |
| `videoCodec` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | hevc |
| `videoResolution` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 4k |
| `container` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | mkv |
| `videoFrameRate` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 24p |
| `videoProfile` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | main 10 |
| `part` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryItemsPart](../../models/operations/GetLibraryItemsPart.md)> | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `id` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 119534 |
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
| `bitrate` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 25025 |
| `width` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 3840 |
| `height` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2072 |
| `aspectRatio` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1.85 |
| `audioChannels` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 6 |
| `audioCodec` | *Optional<String>* | :heavy_minus_sign: | N/A | eac3 |
| `videoCodec` | *Optional<String>* | :heavy_minus_sign: | N/A | hevc |
| `videoResolution` | *Optional<String>* | :heavy_minus_sign: | N/A | 4k |
| `container` | *Optional<String>* | :heavy_minus_sign: | N/A | mkv |
| `videoFrameRate` | *Optional<String>* | :heavy_minus_sign: | N/A | 24p |
| `videoProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | main 10 |
| `part` | List<[GetLibraryItemsPart](../../models/operations/GetLibraryItemsPart.md)> | :heavy_minus_sign: | N/A | |

36
docs/models/operations/GetLibraryItemsMediaContainer.md
View File

@@ -3,21 +3,21 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `size` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 70 |
| `allowSync` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |
| `art` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `identifier` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `librarySectionID` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.LibrarySectionID>](../../models/operations/LibrarySectionID.md) | :heavy_minus_sign: | N/A | |
| `librarySectionTitle` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionUUID` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `mediaTagPrefix` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1701731894 |
| `thumb` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
| `title1` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Movies |
| `title2` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Recently Released |
| `viewGroup` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | movie |
| `viewMode` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 65592 |
| `mixedParents` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |
| `metadata` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryItemsMetadata](../../models/operations/GetLibraryItemsMetadata.md)> | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `size` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 70 |
| `allowSync` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `art` | *Optional<String>* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `identifier` | *Optional<String>* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `librarySectionID` | [Optional<LibrarySectionID>](../../models/operations/LibrarySectionID.md) | :heavy_minus_sign: | N/A | |
| `librarySectionTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionUUID` | *Optional<String>* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `mediaTagPrefix` | *Optional<String>* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1701731894 |
| `thumb` | *Optional<String>* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
| `title1` | *Optional<String>* | :heavy_minus_sign: | N/A | Movies |
| `title2` | *Optional<String>* | :heavy_minus_sign: | N/A | Recently Released |
| `viewGroup` | *Optional<String>* | :heavy_minus_sign: | N/A | movie |
| `viewMode` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 65592 |
| `mixedParents` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `metadata` | List<[GetLibraryItemsMetadata](../../models/operations/GetLibraryItemsMetadata.md)> | :heavy_minus_sign: | N/A | |

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