mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 12:37:47 +00:00
Generating SDK locally, migrated action to v15
This commit is contained in:
15
docs/models/operations/Account.md
Normal file
15
docs/models/operations/Account.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# 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 |
|
||||
15
docs/models/operations/Activity.md
Normal file
15
docs/models/operations/Activity.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# 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 |
|
||||
10
docs/models/operations/AddPlaylistContentsErrors.md
Normal file
10
docs/models/operations/AddPlaylistContentsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# AddPlaylistContentsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/operations/AddPlaylistContentsMediaContainer.md
Normal file
11
docs/models/operations/AddPlaylistContentsMediaContainer.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 | [<br/>{<br/>"ratingKey": "94",<br/>"key": "/playlists/94/items",<br/>"guid": "com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2",<br/>"type": "playlist",<br/>"title": "A great playlist",<br/>"summary": "One of my great playlists",<br/>"smart": false,<br/>"playlistType": "video",<br/>"composite": "/playlists/94/composite/1705800070",<br/>"duration": 423000,<br/>"leafCount": 3,<br/>"addedAt": 1705716458,<br/>"updatedAt": 1705800070<br/>}<br/>] |
|
||||
20
docs/models/operations/AddPlaylistContentsMetadata.md
Normal file
20
docs/models/operations/AddPlaylistContentsMetadata.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# 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 |
|
||||
@@ -0,0 +1,10 @@
|
||||
# AddPlaylistContentsPlaylistsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[lukehagar.plexapi.plexapi.models.operations.AddPlaylistContentsErrors](../../models/operations/AddPlaylistContentsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/AddPlaylistContentsRequest.md
Normal file
10
docs/models/operations/AddPlaylistContentsRequest.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
12
docs/models/operations/AddPlaylistContentsResponse.md
Normal file
12
docs/models/operations/AddPlaylistContentsResponse.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# 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 |
|
||||
| `twoHundredApplicationJsonObject` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.AddPlaylistContentsResponseBody>](../../models/operations/AddPlaylistContentsResponseBody.md) | :heavy_minus_sign: | Playlist Updated |
|
||||
| `fourHundredAndOneApplicationJsonObject` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.AddPlaylistContentsPlaylistsResponseBody>](../../models/operations/AddPlaylistContentsPlaylistsResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/AddPlaylistContentsResponseBody.md
Normal file
10
docs/models/operations/AddPlaylistContentsResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
10
docs/models/operations/ApplyUpdatesErrors.md
Normal file
10
docs/models/operations/ApplyUpdatesErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# ApplyUpdatesErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 401 |
|
||||
9
docs/models/operations/ApplyUpdatesRequest.md
Normal file
9
docs/models/operations/ApplyUpdatesRequest.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# ApplyUpdatesRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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 |
|
||||
| `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`. |
|
||||
11
docs/models/operations/ApplyUpdatesResponse.md
Normal file
11
docs/models/operations/ApplyUpdatesResponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
| `object` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.ApplyUpdatesResponseBody>](../../models/operations/ApplyUpdatesResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/ApplyUpdatesResponseBody.md
Normal file
10
docs/models/operations/ApplyUpdatesResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# ApplyUpdatesResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[lukehagar.plexapi.plexapi.models.operations.ApplyUpdatesErrors](../../models/operations/ApplyUpdatesErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
13
docs/models/operations/ButlerTask.md
Normal file
13
docs/models/operations/ButlerTask.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# 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 |
|
||||
8
docs/models/operations/ButlerTasks.md
Normal file
8
docs/models/operations/ButlerTasks.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# ButlerTasks
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `butlerTask` | List<[lukehagar.plexapi.plexapi.models.operations.ButlerTask](../../models/operations/ButlerTask.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/CancelServerActivitiesErrors.md
Normal file
10
docs/models/operations/CancelServerActivitiesErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CancelServerActivitiesErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 401 |
|
||||
8
docs/models/operations/CancelServerActivitiesRequest.md
Normal file
8
docs/models/operations/CancelServerActivitiesRequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# CancelServerActivitiesRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `activityUUID` | *String* | :heavy_check_mark: | The UUID of the activity to cancel. |
|
||||
11
docs/models/operations/CancelServerActivitiesResponse.md
Normal file
11
docs/models/operations/CancelServerActivitiesResponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
| `object` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.CancelServerActivitiesResponseBody>](../../models/operations/CancelServerActivitiesResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/CancelServerActivitiesResponseBody.md
Normal file
10
docs/models/operations/CancelServerActivitiesResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CancelServerActivitiesResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[lukehagar.plexapi.plexapi.models.operations.CancelServerActivitiesErrors](../../models/operations/CancelServerActivitiesErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/CheckForUpdatesErrors.md
Normal file
10
docs/models/operations/CheckForUpdatesErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CheckForUpdatesErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 401 |
|
||||
8
docs/models/operations/CheckForUpdatesRequest.md
Normal file
8
docs/models/operations/CheckForUpdatesRequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# CheckForUpdatesRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||
| `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. |
|
||||
11
docs/models/operations/CheckForUpdatesResponse.md
Normal file
11
docs/models/operations/CheckForUpdatesResponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
| `object` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.CheckForUpdatesResponseBody>](../../models/operations/CheckForUpdatesResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/CheckForUpdatesResponseBody.md
Normal file
10
docs/models/operations/CheckForUpdatesResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CheckForUpdatesResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[lukehagar.plexapi.plexapi.models.operations.CheckForUpdatesErrors](../../models/operations/CheckForUpdatesErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/ClearPlaylistContentsErrors.md
Normal file
10
docs/models/operations/ClearPlaylistContentsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# ClearPlaylistContentsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 401 |
|
||||
8
docs/models/operations/ClearPlaylistContentsRequest.md
Normal file
8
docs/models/operations/ClearPlaylistContentsRequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# ClearPlaylistContentsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||
| `playlistID` | *double* | :heavy_check_mark: | the ID of the playlist |
|
||||
11
docs/models/operations/ClearPlaylistContentsResponse.md
Normal file
11
docs/models/operations/ClearPlaylistContentsResponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
| `object` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.ClearPlaylistContentsResponseBody>](../../models/operations/ClearPlaylistContentsResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/ClearPlaylistContentsResponseBody.md
Normal file
10
docs/models/operations/ClearPlaylistContentsResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# ClearPlaylistContentsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[lukehagar.plexapi.plexapi.models.operations.ClearPlaylistContentsErrors](../../models/operations/ClearPlaylistContentsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
8
docs/models/operations/Context.md
Normal file
8
docs/models/operations/Context.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Context
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `librarySectionID` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
|
||||
8
docs/models/operations/Country.md
Normal file
8
docs/models/operations/Country.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Country
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | United States of America |
|
||||
10
docs/models/operations/CreatePlaylistErrors.md
Normal file
10
docs/models/operations/CreatePlaylistErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CreatePlaylistErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 401 |
|
||||
9
docs/models/operations/CreatePlaylistMediaContainer.md
Normal file
9
docs/models/operations/CreatePlaylistMediaContainer.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# 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 | [<br/>{<br/>"ratingKey": "96",<br/>"key": "/playlists/96/items",<br/>"guid": "com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55",<br/>"type": "playlist",<br/>"title": "A Great Playlist",<br/>"summary": "What a great playlist",<br/>"smart": false,<br/>"playlistType": "video",<br/>"icon": "playlist://image.smart",<br/>"viewCount": 1,<br/>"lastViewedAt": 1705719589,<br/>"leafCount": 1,<br/>"addedAt": 1705719589,<br/>"updatedAt": 1705724593,<br/>"composite": "/playlists/96/composite/1705724593",<br/>"duration": 141000<br/>}<br/>] |
|
||||
23
docs/models/operations/CreatePlaylistMetadata.md
Normal file
23
docs/models/operations/CreatePlaylistMetadata.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# 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 |
|
||||
@@ -0,0 +1,10 @@
|
||||
# CreatePlaylistPlaylistsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[lukehagar.plexapi.plexapi.models.operations.CreatePlaylistErrors](../../models/operations/CreatePlaylistErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
12
docs/models/operations/CreatePlaylistRequest.md
Normal file
12
docs/models/operations/CreatePlaylistRequest.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# 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 |
|
||||
12
docs/models/operations/CreatePlaylistResponse.md
Normal file
12
docs/models/operations/CreatePlaylistResponse.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# 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 |
|
||||
| `twoHundredApplicationJsonObject` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.CreatePlaylistResponseBody>](../../models/operations/CreatePlaylistResponseBody.md) | :heavy_minus_sign: | returns all playlists |
|
||||
| `fourHundredAndOneApplicationJsonObject` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.CreatePlaylistPlaylistsResponseBody>](../../models/operations/CreatePlaylistPlaylistsResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/CreatePlaylistResponseBody.md
Normal file
10
docs/models/operations/CreatePlaylistResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
10
docs/models/operations/DeleteLibraryErrors.md
Normal file
10
docs/models/operations/DeleteLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# DeleteLibraryErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 401 |
|
||||
8
docs/models/operations/DeleteLibraryRequest.md
Normal file
8
docs/models/operations/DeleteLibraryRequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# DeleteLibraryRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||
| `sectionId` | *double* | :heavy_check_mark: | the Id of the library to query | 1000 |
|
||||
11
docs/models/operations/DeleteLibraryResponse.md
Normal file
11
docs/models/operations/DeleteLibraryResponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
| `object` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.DeleteLibraryResponseBody>](../../models/operations/DeleteLibraryResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/DeleteLibraryResponseBody.md
Normal file
10
docs/models/operations/DeleteLibraryResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# DeleteLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[lukehagar.plexapi.plexapi.models.operations.DeleteLibraryErrors](../../models/operations/DeleteLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/DeletePlaylistErrors.md
Normal file
10
docs/models/operations/DeletePlaylistErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# DeletePlaylistErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 401 |
|
||||
8
docs/models/operations/DeletePlaylistRequest.md
Normal file
8
docs/models/operations/DeletePlaylistRequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# DeletePlaylistRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||
| `playlistID` | *double* | :heavy_check_mark: | the ID of the playlist |
|
||||
11
docs/models/operations/DeletePlaylistResponse.md
Normal file
11
docs/models/operations/DeletePlaylistResponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
| `object` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.DeletePlaylistResponseBody>](../../models/operations/DeletePlaylistResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/DeletePlaylistResponseBody.md
Normal file
10
docs/models/operations/DeletePlaylistResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# DeletePlaylistResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[lukehagar.plexapi.plexapi.models.operations.DeletePlaylistErrors](../../models/operations/DeletePlaylistErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
12
docs/models/operations/Device.md
Normal file
12
docs/models/operations/Device.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# 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 |
|
||||
8
docs/models/operations/Director.md
Normal file
8
docs/models/operations/Director.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Director
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Peyton Reed |
|
||||
10
docs/models/operations/Directory.md
Normal file
10
docs/models/operations/Directory.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
11
docs/models/operations/Download.md
Normal file
11
docs/models/operations/Download.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Download
|
||||
|
||||
Indicate that you want to start download any updates found.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `ZERO` | 0 |
|
||||
| `ONE` | 1 |
|
||||
10
docs/models/operations/EnablePaperTrailErrors.md
Normal file
10
docs/models/operations/EnablePaperTrailErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# EnablePaperTrailErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/operations/EnablePaperTrailResponse.md
Normal file
11
docs/models/operations/EnablePaperTrailResponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
| `object` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.EnablePaperTrailResponseBody>](../../models/operations/EnablePaperTrailResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/EnablePaperTrailResponseBody.md
Normal file
10
docs/models/operations/EnablePaperTrailResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# EnablePaperTrailResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[lukehagar.plexapi.plexapi.models.operations.EnablePaperTrailErrors](../../models/operations/EnablePaperTrailErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/Errors.md
Normal file
10
docs/models/operations/Errors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Errors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/operations/Field.md
Normal file
11
docs/models/operations/Field.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
9
docs/models/operations/FieldType.md
Normal file
9
docs/models/operations/FieldType.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# 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 | [<br/>{<br/>"key": "=",<br/>"title": "is"<br/>}<br/>] |
|
||||
12
docs/models/operations/Filter.md
Normal file
12
docs/models/operations/Filter.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# Filter
|
||||
|
||||
|
||||
## 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 |
|
||||
15
docs/models/operations/Force.md
Normal file
15
docs/models/operations/Force.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# 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 |
|
||||
8
docs/models/operations/Genre.md
Normal file
8
docs/models/operations/Genre.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Genre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Comedy |
|
||||
10
docs/models/operations/GetAvailableClientsErrors.md
Normal file
10
docs/models/operations/GetAvailableClientsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetAvailableClientsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 401 |
|
||||
@@ -0,0 +1,9 @@
|
||||
# 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 | |
|
||||
12
docs/models/operations/GetAvailableClientsResponse.md
Normal file
12
docs/models/operations/GetAvailableClientsResponse.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# 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 |
|
||||
| `twoHundredApplicationJsonObject` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetAvailableClientsResponseBody>](../../models/operations/GetAvailableClientsResponseBody.md) | :heavy_minus_sign: | Available Clients |
|
||||
| `fourHundredAndOneApplicationJsonObject` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetAvailableClientsServerResponseBody>](../../models/operations/GetAvailableClientsServerResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/GetAvailableClientsResponseBody.md
Normal file
10
docs/models/operations/GetAvailableClientsResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
@@ -0,0 +1,10 @@
|
||||
# GetAvailableClientsServerResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[lukehagar.plexapi.plexapi.models.operations.GetAvailableClientsErrors](../../models/operations/GetAvailableClientsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/GetButlerTasksButlerResponseBody.md
Normal file
10
docs/models/operations/GetButlerTasksButlerResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetButlerTasksButlerResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[lukehagar.plexapi.plexapi.models.operations.GetButlerTasksErrors](../../models/operations/GetButlerTasksErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/GetButlerTasksErrors.md
Normal file
10
docs/models/operations/GetButlerTasksErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetButlerTasksErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 401 |
|
||||
12
docs/models/operations/GetButlerTasksResponse.md
Normal file
12
docs/models/operations/GetButlerTasksResponse.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# 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 |
|
||||
| `twoHundredApplicationJsonObject` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetButlerTasksResponseBody>](../../models/operations/GetButlerTasksResponseBody.md) | :heavy_minus_sign: | All butler tasks |
|
||||
| `fourHundredAndOneApplicationJsonObject` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetButlerTasksButlerResponseBody>](../../models/operations/GetButlerTasksButlerResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/GetButlerTasksResponseBody.md
Normal file
10
docs/models/operations/GetButlerTasksResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
10
docs/models/operations/GetDevicesErrors.md
Normal file
10
docs/models/operations/GetDevicesErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetDevicesErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 401 |
|
||||
10
docs/models/operations/GetDevicesMediaContainer.md
Normal file
10
docs/models/operations/GetDevicesMediaContainer.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 | |
|
||||
12
docs/models/operations/GetDevicesResponse.md
Normal file
12
docs/models/operations/GetDevicesResponse.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# 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 |
|
||||
| `twoHundredApplicationJsonObject` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetDevicesResponseBody>](../../models/operations/GetDevicesResponseBody.md) | :heavy_minus_sign: | Devices |
|
||||
| `fourHundredAndOneApplicationJsonObject` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetDevicesServerResponseBody>](../../models/operations/GetDevicesServerResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/GetDevicesResponseBody.md
Normal file
10
docs/models/operations/GetDevicesResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
10
docs/models/operations/GetDevicesServerResponseBody.md
Normal file
10
docs/models/operations/GetDevicesServerResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetDevicesServerResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[lukehagar.plexapi.plexapi.models.operations.GetDevicesErrors](../../models/operations/GetDevicesErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/GetFileHashErrors.md
Normal file
10
docs/models/operations/GetFileHashErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetFileHashErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 401 |
|
||||
9
docs/models/operations/GetFileHashRequest.md
Normal file
9
docs/models/operations/GetFileHashRequest.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# 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 | |
|
||||
11
docs/models/operations/GetFileHashResponse.md
Normal file
11
docs/models/operations/GetFileHashResponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 |
|
||||
| `object` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetFileHashResponseBody>](../../models/operations/GetFileHashResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/GetFileHashResponseBody.md
Normal file
10
docs/models/operations/GetFileHashResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetFileHashResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[lukehagar.plexapi.plexapi.models.operations.GetFileHashErrors](../../models/operations/GetFileHashErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/GetGlobalHubsErrors.md
Normal file
10
docs/models/operations/GetGlobalHubsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetGlobalHubsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 401 |
|
||||
10
docs/models/operations/GetGlobalHubsHubsResponseBody.md
Normal file
10
docs/models/operations/GetGlobalHubsHubsResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetGlobalHubsHubsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[lukehagar.plexapi.plexapi.models.operations.GetGlobalHubsErrors](../../models/operations/GetGlobalHubsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
11
docs/models/operations/GetGlobalHubsMediaContainer.md
Normal file
11
docs/models/operations/GetGlobalHubsMediaContainer.md
Normal file
File diff suppressed because one or more lines are too long
24
docs/models/operations/GetGlobalHubsMetadata.md
Normal file
24
docs/models/operations/GetGlobalHubsMetadata.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# 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 |
|
||||
9
docs/models/operations/GetGlobalHubsRequest.md
Normal file
9
docs/models/operations/GetGlobalHubsRequest.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# 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). |
|
||||
12
docs/models/operations/GetGlobalHubsResponse.md
Normal file
12
docs/models/operations/GetGlobalHubsResponse.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# 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 |
|
||||
| `twoHundredApplicationJsonObject` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetGlobalHubsResponseBody>](../../models/operations/GetGlobalHubsResponseBody.md) | :heavy_minus_sign: | returns global hubs |
|
||||
| `fourHundredAndOneApplicationJsonObject` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetGlobalHubsHubsResponseBody>](../../models/operations/GetGlobalHubsHubsResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/GetGlobalHubsResponseBody.md
Normal file
10
docs/models/operations/GetGlobalHubsResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
28
docs/models/operations/GetLibrariesDirectory.md
Normal file
28
docs/models/operations/GetLibrariesDirectory.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# 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 | [<br/>{<br/>"id": 1,<br/>"path": "/movies"<br/>}<br/>] |
|
||||
10
docs/models/operations/GetLibrariesErrors.md
Normal file
10
docs/models/operations/GetLibrariesErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibrariesErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 401 |
|
||||
10
docs/models/operations/GetLibrariesLibraryResponseBody.md
Normal file
10
docs/models/operations/GetLibrariesLibraryResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibrariesLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibrariesErrors](../../models/operations/GetLibrariesErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
9
docs/models/operations/GetLibrariesLocation.md
Normal file
9
docs/models/operations/GetLibrariesLocation.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetLibrariesLocation
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
|
||||
| `id` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `path` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | /movies |
|
||||
11
docs/models/operations/GetLibrariesMediaContainer.md
Normal file
11
docs/models/operations/GetLibrariesMediaContainer.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 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 | [<br/>{<br/>"allowSync": true,<br/>"art": "/:/resources/movie-fanart.jpg",<br/>"composite": "/library/sections/1/composite/1705615584",<br/>"filters": true,<br/>"refreshing": false,<br/>"thumb": "/:/resources/movie.png",<br/>"key": "1",<br/>"type": "movie",<br/>"title": "Movies",<br/>"agent": "tv.plex.agents.movie",<br/>"scanner": "Plex Movie",<br/>"language": "en-US",<br/>"uuid": "322a231a-b7f7-49f5-920f-14c61199cd30",<br/>"updatedAt": 1705615634,<br/>"createdAt": 1654131312,<br/>"scannedAt": 1705615584,<br/>"content": true,<br/>"directory": true,<br/>"contentChangedAt": 3192854,<br/>"hidden": 0,<br/>"Location": [<br/>{<br/>"id": 1,<br/>"path": "/movies"<br/>}<br/>]<br/>}<br/>] |
|
||||
12
docs/models/operations/GetLibrariesResponse.md
Normal file
12
docs/models/operations/GetLibrariesResponse.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# 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 |
|
||||
| `twoHundredApplicationJsonObject` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetLibrariesResponseBody>](../../models/operations/GetLibrariesResponseBody.md) | :heavy_minus_sign: | The libraries available on the Server |
|
||||
| `fourHundredAndOneApplicationJsonObject` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetLibrariesLibraryResponseBody>](../../models/operations/GetLibrariesLibraryResponseBody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/GetLibrariesResponseBody.md
Normal file
10
docs/models/operations/GetLibrariesResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibrariesResponseBody
|
||||
|
||||
The libraries available on the Server
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [Optional<? extends lukehagar.plexapi.plexapi.models.operations.GetLibrariesMediaContainer>](../../models/operations/GetLibrariesMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
12
docs/models/operations/GetLibraryDirectory.md
Normal file
12
docs/models/operations/GetLibraryDirectory.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# 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 |
|
||||
10
docs/models/operations/GetLibraryErrors.md
Normal file
10
docs/models/operations/GetLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 401 |
|
||||
8
docs/models/operations/GetLibraryHubsCountry.md
Normal file
8
docs/models/operations/GetLibraryHubsCountry.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetLibraryHubsCountry
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | United States of America |
|
||||
8
docs/models/operations/GetLibraryHubsDirector.md
Normal file
8
docs/models/operations/GetLibraryHubsDirector.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetLibraryHubsDirector
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Nathan Greno |
|
||||
10
docs/models/operations/GetLibraryHubsErrors.md
Normal file
10
docs/models/operations/GetLibraryHubsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryHubsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<? extends Double>* | :heavy_minus_sign: | N/A | 401 |
|
||||
8
docs/models/operations/GetLibraryHubsGenre.md
Normal file
8
docs/models/operations/GetLibraryHubsGenre.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetLibraryHubsGenre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `tag` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | Animation |
|
||||
19
docs/models/operations/GetLibraryHubsHub.md
Normal file
19
docs/models/operations/GetLibraryHubsHub.md
Normal file
File diff suppressed because one or more lines are too long
10
docs/models/operations/GetLibraryHubsHubsResponseBody.md
Normal file
10
docs/models/operations/GetLibraryHubsHubsResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryHubsHubsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryHubsErrors](../../models/operations/GetLibraryHubsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
24
docs/models/operations/GetLibraryHubsMedia.md
Normal file
24
docs/models/operations/GetLibraryHubsMedia.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# 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 | [<br/>{<br/>"id": 38247,<br/>"key": "/library/parts/38247/1589412494/file.mp4",<br/>"duration": 6017237,<br/>"file": "/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4",<br/>"size": 1545647447,<br/>"audioProfile": "lc",<br/>"container": "mp4",<br/>"has64bitOffsets": false,<br/>"optimizedForStreaming": true,<br/>"videoProfile": "high"<br/>}<br/>] |
|
||||
14
docs/models/operations/GetLibraryHubsMediaContainer.md
Normal file
14
docs/models/operations/GetLibraryHubsMediaContainer.md
Normal file
File diff suppressed because one or more lines are too long
41
docs/models/operations/GetLibraryHubsMetadata.md
Normal file
41
docs/models/operations/GetLibraryHubsMetadata.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# 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 | [<br/>{<br/>"id": 38247,<br/>"duration": 6017237,<br/>"bitrate": 2051,<br/>"width": 1920,<br/>"height": 1080,<br/>"aspectRatio": 1.78,<br/>"audioChannels": 2,<br/>"audioCodec": "aac",<br/>"videoCodec": "h264",<br/>"videoResolution": "1080",<br/>"container": "mp4",<br/>"videoFrameRate": "24p",<br/>"optimizedForStreaming": 1,<br/>"audioProfile": "lc",<br/>"has64bitOffsets": false,<br/>"videoProfile": "high",<br/>"Part": [<br/>{<br/>"id": 38247,<br/>"key": "/library/parts/38247/1589412494/file.mp4",<br/>"duration": 6017237,<br/>"file": "/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4",<br/>"size": 1545647447,<br/>"audioProfile": "lc",<br/>"container": "mp4",<br/>"has64bitOffsets": false,<br/>"optimizedForStreaming": true,<br/>"videoProfile": "high"<br/>}<br/>]<br/>}<br/>] |
|
||||
| `genre` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryHubsGenre](../../models/operations/GetLibraryHubsGenre.md)> | :heavy_minus_sign: | N/A | [<br/>{<br/>"tag": "Animation"<br/>}<br/>] |
|
||||
| `country` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryHubsCountry](../../models/operations/GetLibraryHubsCountry.md)> | :heavy_minus_sign: | N/A | [<br/>{<br/>"tag": "United States of America"<br/>}<br/>] |
|
||||
| `director` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryHubsDirector](../../models/operations/GetLibraryHubsDirector.md)> | :heavy_minus_sign: | N/A | [<br/>{<br/>"tag": "Nathan Greno"<br/>}<br/>] |
|
||||
| `role` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryHubsRole](../../models/operations/GetLibraryHubsRole.md)> | :heavy_minus_sign: | N/A | [<br/>{<br/>"tag": "Donna Murphy"<br/>}<br/>] |
|
||||
| `writer` | List<[lukehagar.plexapi.plexapi.models.operations.GetLibraryHubsWriter](../../models/operations/GetLibraryHubsWriter.md)> | :heavy_minus_sign: | N/A | [<br/>{<br/>"tag": "Wilhelm Grimm"<br/>}<br/>] |
|
||||
| `skipCount` | *Optional<? extends Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `chapterSource` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | media |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user