mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-07 20:47:45 +00:00
nuking repo
This commit is contained in:
@@ -1,15 +0,0 @@
|
||||
# Account
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
@@ -1,15 +0,0 @@
|
||||
# Activity
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AddPlaylistContentsMediaContainer
|
||||
|
||||
|
||||
## 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 | |
|
||||
@@ -1,20 +0,0 @@
|
||||
# AddPlaylistContentsMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# AddPlaylistContentsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| `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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AddPlaylistContentsResponse
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# AddPlaylistContentsResponseBody
|
||||
|
||||
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 |
|
||||
@@ -1,9 +0,0 @@
|
||||
# ApplyUpdatesRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# ApplyUpdatesResponse
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,13 +0,0 @@
|
||||
# ButlerTask
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
@@ -1,8 +0,0 @@
|
||||
# ButlerTasks
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `butlerTask` | List<[lukehagar.plexapi.plexapi.models.operations.ButlerTask](../../models/operations/ButlerTask.md)> | :heavy_minus_sign: | N/A |
|
||||
@@ -1,8 +0,0 @@
|
||||
# CancelServerActivitiesRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||
| `activityUUID` | *String* | :heavy_check_mark: | The UUID of the activity to cancel. | 25b71ed5-0f9d-461c-baa7-d404e9e10d3e |
|
||||
@@ -1,10 +0,0 @@
|
||||
# CancelServerActivitiesResponse
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,8 +0,0 @@
|
||||
# CheckForUpdatesRequest
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# CheckForUpdatesResponse
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,8 +0,0 @@
|
||||
# ClearPlaylistContentsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||
| `playlistID` | *double* | :heavy_check_mark: | the ID of the playlist |
|
||||
@@ -1,10 +0,0 @@
|
||||
# ClearPlaylistContentsResponse
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,8 +0,0 @@
|
||||
# Context
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `librarySectionID` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
|
||||
@@ -1,8 +0,0 @@
|
||||
# Country
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | United States of America |
|
||||
@@ -1,9 +0,0 @@
|
||||
# CreatePlaylistMediaContainer
|
||||
|
||||
|
||||
## 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 | |
|
||||
@@ -1,23 +0,0 @@
|
||||
# CreatePlaylistMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
@@ -1,12 +0,0 @@
|
||||
# CreatePlaylistRequest
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CreatePlaylistResponse
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# CreatePlaylistResponseBody
|
||||
|
||||
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 |
|
||||
@@ -1,8 +0,0 @@
|
||||
# DeleteLibraryRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||
| `sectionId` | *double* | :heavy_check_mark: | the Id of the library to query | 1000 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# DeleteLibraryResponse
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,8 +0,0 @@
|
||||
# DeletePlaylistRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||
| `playlistID` | *double* | :heavy_check_mark: | the ID of the playlist |
|
||||
@@ -1,10 +0,0 @@
|
||||
# DeletePlaylistResponse
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,12 +0,0 @@
|
||||
# Device
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,8 +0,0 @@
|
||||
# Director
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Peyton Reed |
|
||||
@@ -1,10 +0,0 @@
|
||||
# Directory
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# Download
|
||||
|
||||
Indicate that you want to start download any updates found.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `ZERO` | 0 |
|
||||
| `ONE` | 1 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# EnablePaperTrailResponse
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# Field
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,9 +0,0 @@
|
||||
# FieldType
|
||||
|
||||
|
||||
## 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 | |
|
||||
@@ -1,11 +0,0 @@
|
||||
# Filter
|
||||
|
||||
Filters content by field and direction/equality
|
||||
(Unknown if viewedAt is the only supported column)
|
||||
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
@@ -1,15 +0,0 @@
|
||||
# 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.
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `ZERO` | 0 |
|
||||
| `ONE` | 1 |
|
||||
@@ -1,8 +0,0 @@
|
||||
# Genre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Comedy |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetAvailableClientsMediaContainer
|
||||
|
||||
|
||||
## 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 | |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetAvailableClientsResponse
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetAvailableClientsResponseBody
|
||||
|
||||
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 |
|
||||
@@ -1,15 +0,0 @@
|
||||
# GetBandwidthStatisticsAccount
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
@@ -1,12 +0,0 @@
|
||||
# GetBandwidthStatisticsDevice
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetBandwidthStatisticsMediaContainer
|
||||
|
||||
|
||||
## 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 | |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetBandwidthStatisticsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetBandwidthStatisticsResponse
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetBandwidthStatisticsResponseBody
|
||||
|
||||
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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetButlerTasksResponse
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetButlerTasksResponseBody
|
||||
|
||||
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 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetDevicesMediaContainer
|
||||
|
||||
|
||||
## 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 | |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetDevicesResponse
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetDevicesResponseBody
|
||||
|
||||
Devices
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetDevicesMediaContainer>](../../models/operations/GetDevicesMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetFileHashRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `url` | *String* | :heavy_check_mark: | This is the path to the local file, must be prefixed by `file://` | file://C:\Image.png&type=13 |
|
||||
| `type` | *Optional<? extends Double>* | :heavy_minus_sign: | Item type | |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetFileHashResponse
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetGlobalHubsMediaContainer
|
||||
|
||||
|
||||
## 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 | |
|
||||
@@ -1,24 +0,0 @@
|
||||
# GetGlobalHubsMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetGlobalHubsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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). |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetGlobalHubsResponse
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetGlobalHubsResponseBody
|
||||
|
||||
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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetHomeDataResponse
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,15 +0,0 @@
|
||||
# GetHomeDataResponseBody
|
||||
|
||||
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 | |
|
||||
@@ -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 | |
|
||||
@@ -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 |
|
||||
@@ -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 | |
|
||||
@@ -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 |
|
||||
@@ -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 |
|
||||
@@ -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 |
|
||||
@@ -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 |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetLibraryHubsCountry
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | United States of America |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetLibraryHubsDirector
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Nathan Greno |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetLibraryHubsGenre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Animation |
|
||||
@@ -1,19 +0,0 @@
|
||||
# GetLibraryHubsHub
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,24 +0,0 @@
|
||||
# GetLibraryHubsMedia
|
||||
|
||||
|
||||
## 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 | |
|
||||
@@ -1,14 +0,0 @@
|
||||
# GetLibraryHubsMediaContainer
|
||||
|
||||
|
||||
## 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 | |
|
||||
@@ -1,41 +0,0 @@
|
||||
# GetLibraryHubsMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
| `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 |
|
||||
@@ -1,17 +0,0 @@
|
||||
# GetLibraryHubsPart
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetLibraryHubsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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). |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetLibraryHubsResponse
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetLibraryHubsResponseBody
|
||||
|
||||
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 |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetLibraryHubsRole
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Donna Murphy |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetLibraryHubsWriter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Wilhelm Grimm |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetLibraryItemsCountry
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | United States of America |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetLibraryItemsDirector
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetLibraryItemsGenre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Adventure |
|
||||
@@ -1,21 +0,0 @@
|
||||
# GetLibraryItemsMedia
|
||||
|
||||
|
||||
## 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 | |
|
||||
@@ -1,23 +0,0 @@
|
||||
# GetLibraryItemsMediaContainer
|
||||
|
||||
|
||||
## 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 | |
|
||||
@@ -1,64 +0,0 @@
|
||||
# GetLibraryItemsMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ratingKey` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 58683 |
|
||||
| `key` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/58683 |
|
||||
| `guid` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `studio` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||
| `type` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Avatar: The Way of Water |
|
||||
| `contentRating` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
||||
| `rating` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 7.6 |
|
||||
| `audienceRating` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 9.2 |
|
||||
| `year` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `tagline` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||
| `thumb` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `duration` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
||||
| `addedAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1680457607 |
|
||||
| `updatedAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1703239236 |
|
||||
| `audienceRatingImage` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `chapterSource` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | media |
|
||||
| `primaryExtraKey` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||
| `ratingImage` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `grandparentRatingKey` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 66 |
|
||||
| `grandparentGuid` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentKey` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `grandparentTitle` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `grandparentThumb` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `grandparentArt` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||
| `grandparentTheme` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| `media` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryItemsMedia](../../models/operations/GetLibraryItemsMedia.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryItemsGenre](../../models/operations/GetLibraryItemsGenre.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `country` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryItemsCountry](../../models/operations/GetLibraryItemsCountry.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `director` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryItemsDirector](../../models/operations/GetLibraryItemsDirector.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryItemsWriter](../../models/operations/GetLibraryItemsWriter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryItemsRole](../../models/operations/GetLibraryItemsRole.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `titleSort` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `viewCount` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `lastViewedAt` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||
| `originalTitle` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `viewOffset` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 5222500 |
|
||||
| `skipCount` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `index` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `theme` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
||||
| `leafCount` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 14 |
|
||||
| `viewedLeafCount` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `childCount` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `hasPremiumExtras` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `hasPremiumPrimaryExtra` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parentRatingKey` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 66 |
|
||||
| `parentGuid` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `parentStudio` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | UCP |
|
||||
| `parentKey` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `parentTitle` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `parentIndex` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parentYear` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 2010 |
|
||||
| `parentThumb` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `parentTheme` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
@@ -1,14 +0,0 @@
|
||||
# GetLibraryItemsPart
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 119542 |
|
||||
| `key` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `duration` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `file` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `size` | *Optional<? extends Long>* | :heavy_minus_sign: | N/A | 36158371307 |
|
||||
| `container` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | mkv |
|
||||
| `videoProfile` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | main 10 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetLibraryItemsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `sectionId` | *java.lang.Object* | :heavy_check_mark: | the Id of the library to query | |
|
||||
| `tag` | [lukehagar.plexapi.plexapi.models.operations.Tag](../../models/operations/Tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||
| `includeGuids` | *Optional<? extends Long>* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetLibraryItemsResponse
|
||||
|
||||
|
||||
## 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.GetLibraryItemsResponseBody>](../../models/operations/GetLibraryItemsResponseBody.md) | :heavy_minus_sign: | The contents of the library by section and tag |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetLibraryItemsResponseBody
|
||||
|
||||
The contents of the library by section and tag
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetLibraryItemsMediaContainer>](../../models/operations/GetLibraryItemsMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetLibraryItemsRole
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Sigourney Weaver |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetLibraryItemsWriter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
@@ -1,22 +0,0 @@
|
||||
# GetLibraryMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 29 |
|
||||
| `allowSync` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `art` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `content` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | secondary |
|
||||
| `identifier` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `librarySectionID` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `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 |
|
||||
| `viewGroup` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | secondary |
|
||||
| `viewMode` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 65592 |
|
||||
| `directory` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryDirectory](../../models/operations/GetLibraryDirectory.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `type` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryType](../../models/operations/GetLibraryType.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `fieldType` | List<[lukehagar.plexapi.plexapi.models.operations.FieldType](../../models/operations/FieldType.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetLibraryRequest
|
||||
|
||||
|
||||
## 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/> | |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetLibraryResponse
|
||||
|
||||
|
||||
## 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.GetLibraryResponseBody>](../../models/operations/GetLibraryResponseBody.md) | :heavy_minus_sign: | The details of the library |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetLibraryResponseBody
|
||||
|
||||
The details of the library
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetLibraryMediaContainer>](../../models/operations/GetLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,14 +0,0 @@
|
||||
# GetLibraryType
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||
| `key` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/sections/1/all?type=1 |
|
||||
| `type` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `active` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `filter` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryFilter](../../models/operations/GetLibraryFilter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | List<[lukehagar.plexapi.plexapi.models.operations.Sort](../../models/operations/Sort.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `field` | List<[lukehagar.plexapi.plexapi.models.operations.Field](../../models/operations/Field.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,12 +0,0 @@
|
||||
# GetMetadataChildrenDirectory
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `leafCount` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 16 |
|
||||
| `thumb` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/30072/thumb/1705739923 |
|
||||
| `viewedLeafCount` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 16 |
|
||||
| `key` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/30072/allLeaves |
|
||||
| `title` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | All episodes |
|
||||
@@ -1,30 +0,0 @@
|
||||
# GetMetadataChildrenMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 3 |
|
||||
| `allowSync` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||
| `art` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/30072/art/1705739923 |
|
||||
| `identifier` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `key` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 30072 |
|
||||
| `librarySectionID` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `librarySectionTitle` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | TV Shows |
|
||||
| `librarySectionUUID` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | 4bb2521c-8ba9-459b-aaee-8ab8bc35eabd |
|
||||
| `mediaTagPrefix` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1701731894 |
|
||||
| `nocache` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||
| `parentIndex` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parentTitle` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Reacher |
|
||||
| `parentYear` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `summary` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | When retired Military Police Officer Jack Reacher is arrested for a murder he did not commit, he finds himself in the middle of a deadly conspiracy full of dirty cops, shady businessmen, and scheming politicians. With nothing but his wits, he must figure out what is happening in Margrave, Georgia. |
|
||||
| `theme` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/30072/theme/1705739923 |
|
||||
| `thumb` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /library/metadata/30072/thumb/1705739923 |
|
||||
| `title1` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | TV Shows |
|
||||
| `title2` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Reacher |
|
||||
| `viewGroup` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | season |
|
||||
| `viewMode` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 65593 |
|
||||
| `directory` | List<[lukehagar.plexapi.plexapi.models.operations.GetMetadataChildrenDirectory](../../models/operations/GetMetadataChildrenDirectory.md)> | :heavy_minus_sign: | N/A | [<br/>{<br/>"leafCount": 16,<br/>"thumb": "/library/metadata/30072/thumb/1705739923",<br/>"viewedLeafCount": 16,<br/>"key": "/library/metadata/30072/allLeaves",<br/>"title": "All episodes"<br/>}<br/>] |
|
||||
| `metadata` | List<[lukehagar.plexapi.plexapi.models.operations.GetMetadataChildrenMetadata](../../models/operations/GetMetadataChildrenMetadata.md)> | :heavy_minus_sign: | N/A | |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user