mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 12:37:47 +00:00
Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
025b6c4640 | ||
|
|
2e4350c8c4 | ||
|
|
fa542f04e1 |
File diff suppressed because one or more lines are too long
@@ -12,7 +12,7 @@ generation:
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
java:
|
||||
version: 0.6.2
|
||||
version: 0.9.0
|
||||
additionalDependencies: []
|
||||
additionalPlugins: []
|
||||
artifactID: plexapi
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.404.5
|
||||
speakeasyVersion: 1.406.0
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
@@ -8,8 +8,8 @@ sources:
|
||||
- latest
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:a9bd67eaa35b8311162ae769209f725cc5da16e57976b4928c54594c02cd451c
|
||||
sourceBlobDigest: sha256:43ddffba137c37d2f64f8db185179a273bcc5ca7242594c932da99d1eb7f3e98
|
||||
sourceRevisionDigest: sha256:790c7c67b0edef8c35ed69943d43e9c5bda385414c06f9c90410f93f546e5e4f
|
||||
sourceBlobDigest: sha256:3e48471b7e058840fc598ccd75b2cbf8187961c7e625fe7b606555ce9a9bf109
|
||||
tags:
|
||||
- latest
|
||||
- main
|
||||
@@ -17,10 +17,10 @@ targets:
|
||||
plexjava:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:a9bd67eaa35b8311162ae769209f725cc5da16e57976b4928c54594c02cd451c
|
||||
sourceBlobDigest: sha256:43ddffba137c37d2f64f8db185179a273bcc5ca7242594c932da99d1eb7f3e98
|
||||
sourceRevisionDigest: sha256:790c7c67b0edef8c35ed69943d43e9c5bda385414c06f9c90410f93f546e5e4f
|
||||
sourceBlobDigest: sha256:3e48471b7e058840fc598ccd75b2cbf8187961c7e625fe7b606555ce9a9bf109
|
||||
codeSamplesNamespace: code-samples-java-plexjava
|
||||
codeSamplesRevisionDigest: sha256:40bad00663958b34b9255a105a42474263029fd25e58660da79a50057fc50f7a
|
||||
codeSamplesRevisionDigest: sha256:1be6f3e64a42e2f5a878957fcaa19df7ee718649f6503954dad2c4a934e4eed3
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
|
||||
140
README.md
140
README.md
@@ -45,7 +45,6 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
|
||||
* [SDK Installation](#sdk-installation)
|
||||
* [SDK Example Usage](#sdk-example-usage)
|
||||
* [Available Resources and Operations](#available-resources-and-operations)
|
||||
* [Global Parameters](#global-parameters)
|
||||
* [Error Handling](#error-handling)
|
||||
* [Server Selection](#server-selection)
|
||||
* [Authentication](#authentication)
|
||||
@@ -62,7 +61,7 @@ The samples below show how a published SDK artifact is used:
|
||||
|
||||
Gradle:
|
||||
```groovy
|
||||
implementation 'dev.plexapi:plexapi:0.6.2'
|
||||
implementation 'dev.plexapi:plexapi:0.9.0'
|
||||
```
|
||||
|
||||
Maven:
|
||||
@@ -70,7 +69,7 @@ Maven:
|
||||
<dependency>
|
||||
<groupId>dev.plexapi</groupId>
|
||||
<artifactId>plexapi</artifactId>
|
||||
<version>0.6.2</version>
|
||||
<version>0.9.0</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
@@ -109,11 +108,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||
@@ -169,6 +168,7 @@ public class Application {
|
||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||
@@ -260,82 +260,18 @@ public class Application {
|
||||
</details>
|
||||
<!-- End Available Resources and Operations [operations] -->
|
||||
|
||||
<!-- Start Global Parameters [global-parameters] -->
|
||||
## Global Parameters
|
||||
|
||||
Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed.
|
||||
|
||||
For example, you can set `ClientID` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getServerResources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
||||
|
||||
|
||||
### Available Globals
|
||||
|
||||
The following global parameters are available.
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
| ---- | ---- |:--------:| ----------- |
|
||||
| clientID | java.lang.String | | The unique identifier for the client application
|
||||
This is used to track the client application and its usage
|
||||
(UUID, serial number, or other number unique per device)
|
||||
|
|
||||
| clientName | java.lang.String | | The clientName parameter. |
|
||||
| clientVersion | java.lang.String | | The clientVersion parameter. |
|
||||
| clientPlatform | java.lang.String | | The clientPlatform parameter. |
|
||||
| deviceName | java.lang.String | | The deviceName parameter. |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```java
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetServerResourcesBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetServerResourcesUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetServerResourcesResponse;
|
||||
import dev.plexapi.sdk.models.operations.IncludeHttps;
|
||||
import dev.plexapi.sdk.models.operations.IncludeIPv6;
|
||||
import dev.plexapi.sdk.models.operations.IncludeRelay;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) throws GetServerResourcesBadRequest, GetServerResourcesUnauthorized, Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.build();
|
||||
|
||||
GetServerResourcesResponse res = sdk.plex().getServerResources()
|
||||
.includeHttps(IncludeHttps.Enable)
|
||||
.includeRelay(IncludeRelay.Enable)
|
||||
.includeIPv6(IncludeIPv6.Enable)
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.call();
|
||||
|
||||
if (res.plexDevices().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
<!-- End Global Parameters [global-parameters] -->
|
||||
|
||||
<!-- Start Error Handling [errors] -->
|
||||
## Error Handling
|
||||
|
||||
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Exception type.
|
||||
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
By default, an API error will throw a `models/errors/SDKError` exception. When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `getServerCapabilities` method throws the following exceptions:
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
|
||||
| models/errors/GetServerCapabilitiesBadRequest | 400 | application/json |
|
||||
| models/errors/GetServerCapabilitiesUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -354,11 +290,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||
@@ -401,11 +337,11 @@ public class Application {
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.serverIndex(0)
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||
@@ -444,11 +380,11 @@ public class Application {
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.serverURL("{protocol}://{ip}:{port}")
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||
@@ -479,11 +415,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetCompanionsDataResponse res = sdk.plex().getCompanionsData()
|
||||
@@ -525,11 +461,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||
|
||||
30
RELEASES.md
30
RELEASES.md
@@ -129,3 +129,33 @@ Based on:
|
||||
- [java v0.6.2] .
|
||||
### Releases
|
||||
- [Maven Central v0.6.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.6.2 - .
|
||||
|
||||
## 2024-10-01 00:28:45
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.7.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.7.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.7.0 - .
|
||||
|
||||
## 2024-10-03 00:26:50
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.8.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.8.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.8.0 - .
|
||||
|
||||
## 2024-10-04 00:25:27
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.9.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.9.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.9.0 - .
|
||||
10
USAGE.md
10
USAGE.md
@@ -14,11 +14,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||
|
||||
@@ -63,7 +63,7 @@ tasks.withType(Javadoc) {
|
||||
}
|
||||
|
||||
group = "dev.plexapi"
|
||||
version = "0.6.2"
|
||||
version = "0.9.0"
|
||||
|
||||
sourcesJar {
|
||||
archiveBaseName = "plexapi"
|
||||
@@ -101,7 +101,7 @@ publishing {
|
||||
maven(MavenPublication) {
|
||||
groupId = 'dev.plexapi'
|
||||
artifactId = 'plexapi'
|
||||
version = '0.6.2'
|
||||
version = '0.9.0'
|
||||
|
||||
from components.java
|
||||
|
||||
@@ -152,9 +152,6 @@ dependencies {
|
||||
implementation 'org.apache.httpcomponents:httpclient:4.5.14'
|
||||
implementation 'org.apache.httpcomponents:httpmime:4.5.14'
|
||||
implementation 'commons-io:commons-io:2.15.1'
|
||||
testImplementation 'org.junit.jupiter:junit-jupiter:5.10.2'
|
||||
testImplementation 'org.mockito:mockito-core:5.12.0'
|
||||
testRuntimeOnly 'org.junit.platform:junit-platform-launcher:1.10.2'
|
||||
}
|
||||
|
||||
|
||||
|
||||
809
codeSamples.yaml
809
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
11
docs/models/errors/GetSearchAllLibrariesBadRequest.md
Normal file
11
docs/models/errors/GetSearchAllLibrariesBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetSearchAllLibrariesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[GetSearchAllLibrariesErrors](../../models/errors/GetSearchAllLibrariesErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
10
docs/models/errors/GetSearchAllLibrariesErrors.md
Normal file
10
docs/models/errors/GetSearchAllLibrariesErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetSearchAllLibrariesErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
10
docs/models/errors/GetSearchAllLibrariesLibraryErrors.md
Normal file
10
docs/models/errors/GetSearchAllLibrariesLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetSearchAllLibrariesLibraryErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional<String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/GetSearchAllLibrariesUnauthorized.md
Normal file
11
docs/models/errors/GetSearchAllLibrariesUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetSearchAllLibrariesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[GetSearchAllLibrariesLibraryErrors](../../models/errors/GetSearchAllLibrariesLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,102 +0,0 @@
|
||||
# Features
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------------------------------- | ----------------------------------------- |
|
||||
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
|
||||
| `ANDROID_PI_P` | Android - PiP |
|
||||
| `CU_SUNSET` | CU Sunset |
|
||||
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
|
||||
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
|
||||
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
|
||||
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
|
||||
| `ALBUM_TYPES` | album-types |
|
||||
| `ALLOW_DVR` | allow_dvr |
|
||||
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
|
||||
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
|
||||
| `AVOD_NEW_MEDIA` | avod-new-media |
|
||||
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
|
||||
| `BOOST_VOICES` | boost-voices |
|
||||
| `CAMERA_UPLOAD` | camera_upload |
|
||||
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
|
||||
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
|
||||
| `CLOUDSYNC` | cloudsync |
|
||||
| `COLLECTIONS` | collections |
|
||||
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
|
||||
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
|
||||
| `COMPANIONS_SONOS` | companions_sonos |
|
||||
| `CONTENT_FILTER` | content_filter |
|
||||
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
|
||||
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
|
||||
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
|
||||
| `DOWNLOADS_GATING` | downloads-gating |
|
||||
| `DRM_SUPPORT` | drm_support |
|
||||
| `DVR` | dvr |
|
||||
| `DVR_BLOCK_UNSUPPORTED_COUNTRIES` | dvr-block-unsupported-countries |
|
||||
| `EPG_RECENT_CHANNELS` | epg-recent-channels |
|
||||
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
|
||||
| `FEDERATED_AUTH` | federated-auth |
|
||||
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
|
||||
| `GRANDFATHER_SYNC` | grandfather-sync |
|
||||
| `GUIDED_UPGRADE` | guided-upgrade |
|
||||
| `HARDWARE_TRANSCODING` | hardware_transcoding |
|
||||
| `HOME` | home |
|
||||
| `HWTRANSCODE` | hwtranscode |
|
||||
| `IMAGGA_V2` | imagga-v2 |
|
||||
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
|
||||
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
|
||||
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
|
||||
| `ITEM_CLUSTERS` | item_clusters |
|
||||
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
|
||||
| `KEVIN_BACON` | kevin-bacon |
|
||||
| `KOREA_CONSENT` | korea-consent |
|
||||
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
|
||||
| `LETS_ENCRYPT` | lets_encrypt |
|
||||
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
|
||||
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
|
||||
| `LIVETV` | livetv |
|
||||
| `LYRICS` | lyrics |
|
||||
| `METADATA_SEARCH` | metadata_search |
|
||||
| `MUSIC_ANALYSIS` | music-analysis |
|
||||
| `MUSIC_VIDEOS` | music_videos |
|
||||
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
|
||||
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
|
||||
| `NOMINATIM` | nominatim |
|
||||
| `PASS` | pass |
|
||||
| `PHOTOS_FAVORITES` | photos-favorites |
|
||||
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
|
||||
| `PHOTOS_V6_EDIT` | photosV6-edit |
|
||||
| `PHOTOS_V6_TV_ALBUMS` | photosV6-tv-albums |
|
||||
| `PMS_HEALTH` | pms_health |
|
||||
| `PREMIUM_DASHBOARD` | premium-dashboard |
|
||||
| `PREMIUM_MUSIC_METADATA` | premium_music_metadata |
|
||||
| `RADIO` | radio |
|
||||
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
|
||||
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
|
||||
| `SESSION_BANDWIDTH_RESTRICTIONS` | session_bandwidth_restrictions |
|
||||
| `SESSION_KICK` | session_kick |
|
||||
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
|
||||
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
|
||||
| `SIGNIN_NOTIFICATION` | signin_notification |
|
||||
| `SIGNIN_WITH_APPLE` | signin_with_apple |
|
||||
| `SILENCE_REMOVAL` | silence-removal |
|
||||
| `SLEEP_TIMER` | sleep-timer |
|
||||
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
|
||||
| `SYNC` | sync |
|
||||
| `SWEET_FADES` | sweet-fades |
|
||||
| `TRANSCODER_CACHE` | transcoder_cache |
|
||||
| `TRAILERS` | trailers |
|
||||
| `TUNER_SHARING` | tuner-sharing |
|
||||
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
|
||||
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
|
||||
| `UPGRADE3DS2` | upgrade-3ds2 |
|
||||
| `VISUALIZERS` | visualizers |
|
||||
| `VOD_SCHEMA` | vod-schema |
|
||||
| `VOD_CLOUDFLARE` | vod_cloudflare |
|
||||
| `VOLUME_LEVELING` | volume-leveling |
|
||||
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
|
||||
| `WATCHLIST_RSS` | watchlist-rss |
|
||||
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |
|
||||
| `WEBHOOKS` | webhooks |
|
||||
@@ -4,7 +4,7 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `art` | *String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `composite` | *String* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
|
||||
@@ -25,4 +25,4 @@
|
||||
| `directory` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `contentChangedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `hidden` | *int* | :heavy_check_mark: | N/A | 0 |
|
||||
| `location` | List<[Location](../../models/operations/Location.md)> | :heavy_check_mark: | N/A | |
|
||||
| `location` | List<[GetAllLibrariesLocation](../../models/operations/GetAllLibrariesLocation.md)> | :heavy_check_mark: | N/A | |
|
||||
9
docs/models/operations/GetAllLibrariesLocation.md
Normal file
9
docs/models/operations/GetAllLibrariesLocation.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetAllLibrariesLocation
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 1 |
|
||||
| `path` | *String* | :heavy_check_mark: | N/A | /movies |
|
||||
@@ -10,4 +10,4 @@
|
||||
| `height` | *long* | :heavy_check_mark: | N/A | 396 |
|
||||
| `minSize` | *long* | :heavy_check_mark: | N/A | 1 |
|
||||
| `upscale` | *long* | :heavy_check_mark: | N/A | 1 |
|
||||
| `xPlexToken` | *String* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
|
||||
| `xPlexToken` | *String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
|
||||
@@ -5,5 +5,5 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `includeDetails` | [Optional<IncludeDetails>](../../models/operations/IncludeDetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
8
docs/models/operations/GetLibraryItemsLocation.md
Normal file
8
docs/models/operations/GetLibraryItemsLocation.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetLibraryItemsLocation
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `path` | *Optional<String>* | :heavy_minus_sign: | N/A | /TV Shows/House |
|
||||
@@ -6,19 +6,19 @@
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
|
||||
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `bitrate` | *int* | :heavy_check_mark: | N/A | 25025 |
|
||||
| `width` | *int* | :heavy_check_mark: | N/A | 3840 |
|
||||
| `height` | *int* | :heavy_check_mark: | N/A | 2072 |
|
||||
| `aspectRatio` | *double* | :heavy_check_mark: | N/A | 1.85 |
|
||||
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `bitrate` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 25025 |
|
||||
| `width` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 3840 |
|
||||
| `height` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2072 |
|
||||
| `aspectRatio` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1.85 |
|
||||
| `audioProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | dts |
|
||||
| `audioChannels` | *int* | :heavy_check_mark: | N/A | 6 |
|
||||
| `audioCodec` | *String* | :heavy_check_mark: | N/A | eac3 |
|
||||
| `videoCodec` | *String* | :heavy_check_mark: | N/A | hevc |
|
||||
| `videoResolution` | *String* | :heavy_check_mark: | N/A | 4k |
|
||||
| `audioChannels` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `audioCodec` | *Optional<String>* | :heavy_minus_sign: | N/A | eac3 |
|
||||
| `videoCodec` | *Optional<String>* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `videoResolution` | *Optional<String>* | :heavy_minus_sign: | N/A | 4k |
|
||||
| `container` | *String* | :heavy_check_mark: | N/A | mkv |
|
||||
| `videoFrameRate` | *String* | :heavy_check_mark: | N/A | 24p |
|
||||
| `videoProfile` | *String* | :heavy_check_mark: | N/A | main 10 |
|
||||
| `videoFrameRate` | *Optional<String>* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `videoProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `hasVoiceActivity` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | [Optional<GetLibraryItemsOptimizedForStreaming>](../../models/operations/GetLibraryItemsOptimizedForStreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `has64bitOffsets` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
|
||||
@@ -29,5 +29,5 @@ The Meta object is only included in the response if the `includeMeta` parameter
|
||||
| `viewGroup` | *String* | :heavy_check_mark: | N/A | movie |
|
||||
| `viewMode` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 65592 |
|
||||
| `mixedParents` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||
| `metadata` | List<[GetLibraryItemsMetadata](../../models/operations/GetLibraryItemsMetadata.md)> | :heavy_check_mark: | N/A | |
|
||||
| `metadata` | List<[GetLibraryItemsMetadata](../../models/operations/GetLibraryItemsMetadata.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `meta` | [Optional<GetLibraryItemsMeta>](../../models/operations/GetLibraryItemsMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||
@@ -52,6 +52,7 @@
|
||||
| `writer` | List<[GetLibraryItemsWriter](../../models/operations/GetLibraryItemsWriter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | List<[GetLibraryItemsCollection](../../models/operations/GetLibraryItemsCollection.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | List<[GetLibraryItemsRole](../../models/operations/GetLibraryItemsRole.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `location` | List<[GetLibraryItemsLocation](../../models/operations/GetLibraryItemsLocation.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `mediaGuid` | List<[GetLibraryItemsMediaGuid](../../models/operations/GetLibraryItemsMediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||
| `ultraBlurColors` | [Optional<GetLibraryItemsUltraBlurColors>](../../models/operations/GetLibraryItemsUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `metaDataRating` | List<[GetLibraryItemsMetaDataRating](../../models/operations/GetLibraryItemsMetaDataRating.md)> | :heavy_minus_sign: | N/A | |
|
||||
|
||||
@@ -7,14 +7,14 @@
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 119542 |
|
||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `file` | *String* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `size` | *long* | :heavy_check_mark: | N/A | 36158371307 |
|
||||
| `container` | *String* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
||||
| `audioProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | dts |
|
||||
| `has64bitOffsets` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `videoProfile` | *String* | :heavy_check_mark: | N/A | main 10 |
|
||||
| `videoProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `indexes` | *Optional<String>* | :heavy_minus_sign: | N/A | sd |
|
||||
| `hasThumbnail` | [Optional<GetLibraryItemsHasThumbnail>](../../models/operations/GetLibraryItemsHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `stream` | List<[GetLibraryItemsStream](../../models/operations/GetLibraryItemsStream.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -5,10 +5,10 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `tag` | [Tag](../../models/operations/Tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||
| `includeGuids` | [Optional<IncludeGuids>](../../models/operations/IncludeGuids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
| `type` | [Optional<GetLibraryItemsQueryParamType>](../../models/operations/GetLibraryItemsQueryParamType.md) | :heavy_minus_sign: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `includeMeta` | [Optional<GetLibraryItemsQueryParamIncludeMeta>](../../models/operations/GetLibraryItemsQueryParamIncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||
| `xPlexContainerStart` | *Optional<Integer>* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
||||
| `xPlexContainerSize` | *Optional<Integer>* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
||||
@@ -4,5 +4,5 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `xPlexToken` | *String* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| `xPlexToken` | *String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
|
||||
@@ -15,7 +15,7 @@
|
||||
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Season 2 |
|
||||
| `parentKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/30072 |
|
||||
| `parentTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | Reacher |
|
||||
| `summary` | *Optional<String>* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge. |
|
||||
| `summary` | *Optional<String>* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge. |
|
||||
| `index` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `parentIndex` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `viewCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 11 |
|
||||
|
||||
@@ -4,10 +4,10 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `strong` | *Optional<Boolean>* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
|
||||
| `clientID` | *Optional<String>* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
|
||||
| `clientName` | *Optional<String>* | :heavy_minus_sign: | N/A | Plex Web |
|
||||
| `deviceName` | *Optional<String>* | :heavy_minus_sign: | N/A | Linux |
|
||||
| `clientVersion` | *Optional<String>* | :heavy_minus_sign: | N/A | 4.133.0 |
|
||||
| `clientPlatform` | *Optional<String>* | :heavy_minus_sign: | N/A | Chrome |
|
||||
| `clientID` | *Optional<String>* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||
| `clientName` | *Optional<String>* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
|
||||
| `deviceNickname` | *Optional<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `clientVersion` | *Optional<String>* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
|
||||
| `platform` | *Optional<String>* | :heavy_minus_sign: | The platform of the client application. | Roku |
|
||||
@@ -52,6 +52,7 @@
|
||||
| `writer` | List<[Writer](../../models/operations/Writer.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | List<[Collection](../../models/operations/Collection.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | List<[Role](../../models/operations/Role.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `location` | List<[Location](../../models/operations/Location.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `mediaGuid` | List<[MediaGuid](../../models/operations/MediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||
| `ultraBlurColors` | [Optional<UltraBlurColors>](../../models/operations/UltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `metaDataRating` | List<[MetaDataRating](../../models/operations/MetaDataRating.md)> | :heavy_minus_sign: | N/A | |
|
||||
|
||||
@@ -5,5 +5,5 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `force` | [Optional<Force>](../../models/operations/Force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |
|
||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
@@ -0,0 +1,8 @@
|
||||
# GetSearchAllLibrariesCollection
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||
8
docs/models/operations/GetSearchAllLibrariesCountry.md
Normal file
8
docs/models/operations/GetSearchAllLibrariesCountry.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetSearchAllLibrariesCountry
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | United States of America |
|
||||
8
docs/models/operations/GetSearchAllLibrariesDirector.md
Normal file
8
docs/models/operations/GetSearchAllLibrariesDirector.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetSearchAllLibrariesDirector
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetSearchAllLibrariesFlattenSeasons
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `False` | 0 |
|
||||
| `True` | 1 |
|
||||
8
docs/models/operations/GetSearchAllLibrariesGenre.md
Normal file
8
docs/models/operations/GetSearchAllLibrariesGenre.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetSearchAllLibrariesGenre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Adventure |
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetSearchAllLibrariesHasThumbnail
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `False` | 0 |
|
||||
| `True` | 1 |
|
||||
10
docs/models/operations/GetSearchAllLibrariesImage.md
Normal file
10
docs/models/operations/GetSearchAllLibrariesImage.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetSearchAllLibrariesImage
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `alt` | *String* | :heavy_check_mark: | N/A | Episode 1 |
|
||||
| `type` | [GetSearchAllLibrariesLibraryType](../../models/operations/GetSearchAllLibrariesLibraryType.md) | :heavy_check_mark: | N/A | background |
|
||||
| `url` | *String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||
11
docs/models/operations/GetSearchAllLibrariesLibraryType.md
Normal file
11
docs/models/operations/GetSearchAllLibrariesLibraryType.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetSearchAllLibrariesLibraryType
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------- | -------------- |
|
||||
| `COVER_POSTER` | coverPoster |
|
||||
| `BACKGROUND` | background |
|
||||
| `SNAPSHOT` | snapshot |
|
||||
| `CLEAR_LOGO` | clearLogo |
|
||||
8
docs/models/operations/GetSearchAllLibrariesLocation.md
Normal file
8
docs/models/operations/GetSearchAllLibrariesLocation.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetSearchAllLibrariesLocation
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `path` | *Optional<String>* | :heavy_minus_sign: | N/A | /TV Shows/House |
|
||||
25
docs/models/operations/GetSearchAllLibrariesMedia.md
Normal file
25
docs/models/operations/GetSearchAllLibrariesMedia.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# GetSearchAllLibrariesMedia
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
|
||||
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `bitrate` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 25025 |
|
||||
| `width` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 3840 |
|
||||
| `height` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2072 |
|
||||
| `aspectRatio` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1.85 |
|
||||
| `audioProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | dts |
|
||||
| `audioChannels` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `audioCodec` | *Optional<String>* | :heavy_minus_sign: | N/A | eac3 |
|
||||
| `videoCodec` | *Optional<String>* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `videoResolution` | *Optional<String>* | :heavy_minus_sign: | N/A | 4k |
|
||||
| `container` | *String* | :heavy_check_mark: | N/A | mkv |
|
||||
| `videoFrameRate` | *Optional<String>* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `videoProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `hasVoiceActivity` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | [Optional<GetSearchAllLibrariesOptimizedForStreaming>](../../models/operations/GetSearchAllLibrariesOptimizedForStreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `has64bitOffsets` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `part` | List<[GetSearchAllLibrariesPart](../../models/operations/GetSearchAllLibrariesPart.md)> | :heavy_check_mark: | N/A | |
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetSearchAllLibrariesMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| `size` | *double* | :heavy_check_mark: | N/A |
|
||||
| `searchResult` | List<[SearchResult](../../models/operations/SearchResult.md)> | :heavy_check_mark: | N/A |
|
||||
8
docs/models/operations/GetSearchAllLibrariesMediaGuid.md
Normal file
8
docs/models/operations/GetSearchAllLibrariesMediaGuid.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetSearchAllLibrariesMediaGuid
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `id` | *String* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |
|
||||
@@ -0,0 +1,10 @@
|
||||
# GetSearchAllLibrariesMetaDataRating
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `image` | *String* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
|
||||
| `value` | *float* | :heavy_check_mark: | The value of the rating. | 3 |
|
||||
| `type` | *String* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
||||
81
docs/models/operations/GetSearchAllLibrariesMetadata.md
Normal file
81
docs/models/operations/GetSearchAllLibrariesMetadata.md
Normal file
@@ -0,0 +1,81 @@
|
||||
# GetSearchAllLibrariesMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ratingKey` | *String* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
|
||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/metadata/58683 |
|
||||
| `guid` | *String* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `studio` | *Optional<String>* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||
| `skipChildren` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `librarySectionID` | *Optional<Long>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `librarySectionTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `librarySectionKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||
| `type` | [GetSearchAllLibrariesType](../../models/operations/GetSearchAllLibrariesType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
||||
| `title` | *String* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||
| `slug` | *Optional<String>* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||
| `contentRating` | *Optional<String>* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *String* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
||||
| `rating` | *Optional<Double>* | :heavy_minus_sign: | N/A | 7.6 |
|
||||
| `audienceRating` | *Optional<Double>* | :heavy_minus_sign: | N/A | 9.2 |
|
||||
| `year` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `seasonCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `tagline` | *Optional<String>* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||
| `flattenSeasons` | [Optional<GetSearchAllLibrariesFlattenSeasons>](../../models/operations/GetSearchAllLibrariesFlattenSeasons.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `showOrdering` | [Optional<GetSearchAllLibrariesShowOrdering>](../../models/operations/GetSearchAllLibrariesShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
|
||||
| `thumb` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `banner` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
||||
| `addedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `updatedAt` | *Optional<Long>* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `audienceRatingImage` | *Optional<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `chapterSource` | *Optional<String>* | :heavy_minus_sign: | N/A | media |
|
||||
| `primaryExtraKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||
| `ratingImage` | *Optional<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `grandparentRatingKey` | *Optional<String>* | :heavy_minus_sign: | N/A | 66 |
|
||||
| `grandparentGuid` | *Optional<String>* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `grandparentTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `grandparentThumb` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `parentSlug` | *Optional<String>* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `grandparentSlug` | *Optional<String>* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `grandparentArt` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||
| `grandparentTheme` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| `media` | List<[GetSearchAllLibrariesMedia](../../models/operations/GetSearchAllLibrariesMedia.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
||||
| `genre` | List<[GetSearchAllLibrariesGenre](../../models/operations/GetSearchAllLibrariesGenre.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `country` | List<[GetSearchAllLibrariesCountry](../../models/operations/GetSearchAllLibrariesCountry.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `director` | List<[GetSearchAllLibrariesDirector](../../models/operations/GetSearchAllLibrariesDirector.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | List<[GetSearchAllLibrariesWriter](../../models/operations/GetSearchAllLibrariesWriter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | List<[GetSearchAllLibrariesCollection](../../models/operations/GetSearchAllLibrariesCollection.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | List<[GetSearchAllLibrariesRole](../../models/operations/GetSearchAllLibrariesRole.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `location` | List<[GetSearchAllLibrariesLocation](../../models/operations/GetSearchAllLibrariesLocation.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `mediaGuid` | List<[GetSearchAllLibrariesMediaGuid](../../models/operations/GetSearchAllLibrariesMediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||
| `ultraBlurColors` | [Optional<GetSearchAllLibrariesUltraBlurColors>](../../models/operations/GetSearchAllLibrariesUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `metaDataRating` | List<[GetSearchAllLibrariesMetaDataRating](../../models/operations/GetSearchAllLibrariesMetaDataRating.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `image` | List<[GetSearchAllLibrariesImage](../../models/operations/GetSearchAllLibrariesImage.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `titleSort` | *Optional<String>* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `viewCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `lastViewedAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||
| `originalTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `viewOffset` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 5222500 |
|
||||
| `skipCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `index` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `theme` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
||||
| `leafCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 14 |
|
||||
| `viewedLeafCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `childCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `hasPremiumExtras` | *Optional<String>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `hasPremiumPrimaryExtra` | *Optional<String>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parentRatingKey` | *Optional<String>* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
||||
| `parentGuid` | *Optional<String>* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `parentStudio` | *Optional<String>* | :heavy_minus_sign: | N/A | UCP |
|
||||
| `parentKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `parentTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `parentIndex` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parentYear` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2010 |
|
||||
| `parentThumb` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `parentTheme` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetSearchAllLibrariesOptimizedForStreaming
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
20
docs/models/operations/GetSearchAllLibrariesPart.md
Normal file
20
docs/models/operations/GetSearchAllLibrariesPart.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# GetSearchAllLibrariesPart
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 119542 |
|
||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `file` | *String* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `size` | *long* | :heavy_check_mark: | N/A | 36158371307 |
|
||||
| `container` | *String* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
||||
| `audioProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | dts |
|
||||
| `has64bitOffsets` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `videoProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `indexes` | *Optional<String>* | :heavy_minus_sign: | N/A | sd |
|
||||
| `hasThumbnail` | [Optional<GetSearchAllLibrariesHasThumbnail>](../../models/operations/GetSearchAllLibrariesHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `stream` | List<[GetSearchAllLibrariesStream](../../models/operations/GetSearchAllLibrariesStream.md)> | :heavy_minus_sign: | N/A | |
|
||||
13
docs/models/operations/GetSearchAllLibrariesRequest.md
Normal file
13
docs/models/operations/GetSearchAllLibrariesRequest.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetSearchAllLibrariesRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `query` | *String* | :heavy_check_mark: | The search query term. | |
|
||||
| `clientID` | *Optional<String>* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||
| `limit` | *Optional<Long>* | :heavy_minus_sign: | Limit the number of results returned. | |
|
||||
| `searchTypes` | List<[SearchTypes](../../models/operations/SearchTypes.md)> | :heavy_minus_sign: | A comma-separated list of search types to include. Valid values are: movies, music, otherVideos, people, tv.<br/> | movies,music,otherVideos,people,tv |
|
||||
| `includeCollections` | [Optional<QueryParamIncludeCollections>](../../models/operations/QueryParamIncludeCollections.md) | :heavy_minus_sign: | Whether to include collections in the search results. | 1 |
|
||||
| `includeExternalMedia` | [Optional<QueryParamIncludeExternalMedia>](../../models/operations/QueryParamIncludeExternalMedia.md) | :heavy_minus_sign: | Whether to include external media in the search results. | 1 |
|
||||
11
docs/models/operations/GetSearchAllLibrariesResponse.md
Normal file
11
docs/models/operations/GetSearchAllLibrariesResponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetSearchAllLibrariesResponse
|
||||
|
||||
|
||||
## 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<GetSearchAllLibrariesResponseBody>](../../models/operations/GetSearchAllLibrariesResponseBody.md) | :heavy_minus_sign: | The libraries available on the Server |
|
||||
10
docs/models/operations/GetSearchAllLibrariesResponseBody.md
Normal file
10
docs/models/operations/GetSearchAllLibrariesResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetSearchAllLibrariesResponseBody
|
||||
|
||||
The libraries available on the Server
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [GetSearchAllLibrariesMediaContainer](../../models/operations/GetSearchAllLibrariesMediaContainer.md) | :heavy_check_mark: | N/A |
|
||||
13
docs/models/operations/GetSearchAllLibrariesRole.md
Normal file
13
docs/models/operations/GetSearchAllLibrariesRole.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetSearchAllLibrariesRole
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *Optional<Long>* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 |
|
||||
| `filter` | *Optional<String>* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 |
|
||||
| `thumb` | *Optional<String>* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
|
||||
| `tag` | *Optional<String>* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
|
||||
| `tagKey` | *Optional<String>* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
|
||||
| `role` | *Optional<String>* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |
|
||||
20
docs/models/operations/GetSearchAllLibrariesShowOrdering.md
Normal file
20
docs/models/operations/GetSearchAllLibrariesShowOrdering.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# GetSearchAllLibrariesShowOrdering
|
||||
|
||||
Setting that indicates the episode ordering for the show
|
||||
None = Library default,
|
||||
tmdbAiring = The Movie Database (Aired),
|
||||
aired = TheTVDB (Aired),
|
||||
dvd = TheTVDB (DVD),
|
||||
absolute = TheTVDB (Absolute)).
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `None` | None |
|
||||
| `TmdbAiring` | tmdbAiring |
|
||||
| `Aired` | aired |
|
||||
| `Dvd` | dvd |
|
||||
| `Absolute` | absolute |
|
||||
45
docs/models/operations/GetSearchAllLibrariesStream.md
Normal file
45
docs/models/operations/GetSearchAllLibrariesStream.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# GetSearchAllLibrariesStream
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `id` | *long* | :heavy_check_mark: | N/A | 272796 |
|
||||
| `streamType` | *long* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
|
||||
| `default_` | *Optional<Boolean>* | :heavy_minus_sign: | Indicates if this is the default stream | true |
|
||||
| `selected` | *Optional<Boolean>* | :heavy_minus_sign: | Indicates if the stream is selected | true |
|
||||
| `codec` | *String* | :heavy_check_mark: | Codec used by the stream | h264 |
|
||||
| `index` | *long* | :heavy_check_mark: | The index of the stream | 0 |
|
||||
| `bitrate` | *Optional<Long>* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
|
||||
| `colorPrimaries` | *Optional<String>* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
|
||||
| `colorRange` | *Optional<String>* | :heavy_minus_sign: | The color range of the video stream | tv |
|
||||
| `colorSpace` | *Optional<String>* | :heavy_minus_sign: | The color space of the video stream | bt709 |
|
||||
| `colorTrc` | *Optional<String>* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
|
||||
| `bitDepth` | *Optional<Long>* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
|
||||
| `chromaLocation` | *Optional<String>* | :heavy_minus_sign: | The chroma location of the video stream | left |
|
||||
| `streamIdentifier` | *Optional<String>* | :heavy_minus_sign: | The identifier of the video stream | 2 |
|
||||
| `chromaSubsampling` | *Optional<String>* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
|
||||
| `codedHeight` | *Optional<Long>* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
|
||||
| `codedWidth` | *Optional<Long>* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
|
||||
| `frameRate` | *Optional<Double>* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
|
||||
| `hasScalingMatrix` | *Optional<Boolean>* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
|
||||
| `hearingImpaired` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `closedCaptions` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `embeddedInVideo` | *Optional<String>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `height` | *Optional<Long>* | :heavy_minus_sign: | The height of the video stream | 1080 |
|
||||
| `level` | *Optional<Long>* | :heavy_minus_sign: | The level of the video codec | 40 |
|
||||
| `profile` | *Optional<String>* | :heavy_minus_sign: | The profile of the video codec | main |
|
||||
| `refFrames` | *Optional<Long>* | :heavy_minus_sign: | Number of reference frames | 4 |
|
||||
| `scanType` | *Optional<String>* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
|
||||
| `width` | *Optional<Long>* | :heavy_minus_sign: | The width of the video stream | 1920 |
|
||||
| `displayTitle` | *Optional<String>* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
|
||||
| `extendedDisplayTitle` | *Optional<String>* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
|
||||
| `channels` | *Optional<Long>* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
|
||||
| `language` | *Optional<String>* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
|
||||
| `languageTag` | *Optional<String>* | :heavy_minus_sign: | Language tag of the stream | en |
|
||||
| `languageCode` | *Optional<String>* | :heavy_minus_sign: | Language code of the stream | eng |
|
||||
| `audioChannelLayout` | *Optional<String>* | :heavy_minus_sign: | The audio channel layout | stereo |
|
||||
| `samplingRate` | *Optional<Long>* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
|
||||
| `title` | *Optional<String>* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
|
||||
| `canAutoSync` | *Optional<Boolean>* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |
|
||||
14
docs/models/operations/GetSearchAllLibrariesType.md
Normal file
14
docs/models/operations/GetSearchAllLibrariesType.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# GetSearchAllLibrariesType
|
||||
|
||||
The type of media content
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
@@ -0,0 +1,11 @@
|
||||
# GetSearchAllLibrariesUltraBlurColors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `topLeft` | *String* | :heavy_check_mark: | N/A | 11333b |
|
||||
| `topRight` | *String* | :heavy_check_mark: | N/A | 0a232d |
|
||||
| `bottomRight` | *String* | :heavy_check_mark: | N/A | 73958 |
|
||||
| `bottomLeft` | *String* | :heavy_check_mark: | N/A | 1f5066 |
|
||||
8
docs/models/operations/GetSearchAllLibrariesWriter.md
Normal file
8
docs/models/operations/GetSearchAllLibrariesWriter.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetSearchAllLibrariesWriter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
@@ -4,8 +4,8 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
||||
| `includeHttps` | [Optional<IncludeHttps>](../../models/operations/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
|
||||
| `includeRelay` | [Optional<IncludeRelay>](../../models/operations/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
|
||||
| `includeIPv6` | [Optional<IncludeIPv6>](../../models/operations/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
|
||||
| `clientID` | *Optional<String>* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
|
||||
| `clientID` | *Optional<String>* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||
@@ -10,4 +10,4 @@
|
||||
| `height` | *long* | :heavy_check_mark: | N/A | 396 |
|
||||
| `minSize` | *long* | :heavy_check_mark: | N/A | 1 |
|
||||
| `upscale` | *long* | :heavy_check_mark: | N/A | 1 |
|
||||
| `xPlexToken` | *String* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
|
||||
| `xPlexToken` | *String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
|
||||
@@ -4,10 +4,10 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `pinID` | *long* | :heavy_check_mark: | The PinID to retrieve an access token for | |
|
||||
| `clientID` | *Optional<String>* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
|
||||
| `clientName` | *Optional<String>* | :heavy_minus_sign: | N/A | Plex Web |
|
||||
| `deviceName` | *Optional<String>* | :heavy_minus_sign: | N/A | Linux |
|
||||
| `clientVersion` | *Optional<String>* | :heavy_minus_sign: | N/A | 4.133.0 |
|
||||
| `clientPlatform` | *Optional<String>* | :heavy_minus_sign: | N/A | Chrome |
|
||||
| `clientID` | *Optional<String>* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||
| `clientName` | *Optional<String>* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
|
||||
| `deviceNickname` | *Optional<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `clientVersion` | *Optional<String>* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
|
||||
| `platform` | *Optional<String>* | :heavy_minus_sign: | The platform of the client application. | Roku |
|
||||
@@ -1,102 +0,0 @@
|
||||
# GetTokenDetailsFeatures
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------------------------------- | ----------------------------------------- |
|
||||
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
|
||||
| `ANDROID_PI_P` | Android - PiP |
|
||||
| `CU_SUNSET` | CU Sunset |
|
||||
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
|
||||
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
|
||||
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
|
||||
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
|
||||
| `ALBUM_TYPES` | album-types |
|
||||
| `ALLOW_DVR` | allow_dvr |
|
||||
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
|
||||
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
|
||||
| `AVOD_NEW_MEDIA` | avod-new-media |
|
||||
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
|
||||
| `BOOST_VOICES` | boost-voices |
|
||||
| `CAMERA_UPLOAD` | camera_upload |
|
||||
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
|
||||
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
|
||||
| `CLOUDSYNC` | cloudsync |
|
||||
| `COLLECTIONS` | collections |
|
||||
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
|
||||
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
|
||||
| `COMPANIONS_SONOS` | companions_sonos |
|
||||
| `CONTENT_FILTER` | content_filter |
|
||||
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
|
||||
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
|
||||
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
|
||||
| `DOWNLOADS_GATING` | downloads-gating |
|
||||
| `DRM_SUPPORT` | drm_support |
|
||||
| `DVR` | dvr |
|
||||
| `DVR_BLOCK_UNSUPPORTED_COUNTRIES` | dvr-block-unsupported-countries |
|
||||
| `EPG_RECENT_CHANNELS` | epg-recent-channels |
|
||||
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
|
||||
| `FEDERATED_AUTH` | federated-auth |
|
||||
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
|
||||
| `GRANDFATHER_SYNC` | grandfather-sync |
|
||||
| `GUIDED_UPGRADE` | guided-upgrade |
|
||||
| `HARDWARE_TRANSCODING` | hardware_transcoding |
|
||||
| `HOME` | home |
|
||||
| `HWTRANSCODE` | hwtranscode |
|
||||
| `IMAGGA_V2` | imagga-v2 |
|
||||
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
|
||||
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
|
||||
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
|
||||
| `ITEM_CLUSTERS` | item_clusters |
|
||||
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
|
||||
| `KEVIN_BACON` | kevin-bacon |
|
||||
| `KOREA_CONSENT` | korea-consent |
|
||||
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
|
||||
| `LETS_ENCRYPT` | lets_encrypt |
|
||||
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
|
||||
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
|
||||
| `LIVETV` | livetv |
|
||||
| `LYRICS` | lyrics |
|
||||
| `METADATA_SEARCH` | metadata_search |
|
||||
| `MUSIC_ANALYSIS` | music-analysis |
|
||||
| `MUSIC_VIDEOS` | music_videos |
|
||||
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
|
||||
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
|
||||
| `NOMINATIM` | nominatim |
|
||||
| `PASS` | pass |
|
||||
| `PHOTOS_FAVORITES` | photos-favorites |
|
||||
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
|
||||
| `PHOTOS_V6_EDIT` | photosV6-edit |
|
||||
| `PHOTOS_V6_TV_ALBUMS` | photosV6-tv-albums |
|
||||
| `PMS_HEALTH` | pms_health |
|
||||
| `PREMIUM_DASHBOARD` | premium-dashboard |
|
||||
| `PREMIUM_MUSIC_METADATA` | premium_music_metadata |
|
||||
| `RADIO` | radio |
|
||||
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
|
||||
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
|
||||
| `SESSION_BANDWIDTH_RESTRICTIONS` | session_bandwidth_restrictions |
|
||||
| `SESSION_KICK` | session_kick |
|
||||
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
|
||||
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
|
||||
| `SIGNIN_NOTIFICATION` | signin_notification |
|
||||
| `SIGNIN_WITH_APPLE` | signin_with_apple |
|
||||
| `SILENCE_REMOVAL` | silence-removal |
|
||||
| `SLEEP_TIMER` | sleep-timer |
|
||||
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
|
||||
| `SYNC` | sync |
|
||||
| `SWEET_FADES` | sweet-fades |
|
||||
| `TRANSCODER_CACHE` | transcoder_cache |
|
||||
| `TRAILERS` | trailers |
|
||||
| `TUNER_SHARING` | tuner-sharing |
|
||||
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
|
||||
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
|
||||
| `UPGRADE3DS2` | upgrade-3ds2 |
|
||||
| `VISUALIZERS` | visualizers |
|
||||
| `VOD_SCHEMA` | vod-schema |
|
||||
| `VOD_CLOUDFLARE` | vod_cloudflare |
|
||||
| `VOLUME_LEVELING` | volume-leveling |
|
||||
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
|
||||
| `WATCHLIST_RSS` | watchlist-rss |
|
||||
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |
|
||||
| `WEBHOOKS` | webhooks |
|
||||
File diff suppressed because one or more lines are too long
@@ -5,7 +5,7 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `features` | List<[GetTokenDetailsFeatures](../../models/operations/GetTokenDetailsFeatures.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
|
||||
| `features` | List<*String*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
|
||||
| `active` | *Optional<Boolean>* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
|
||||
| `subscribedAt` | *JsonNullable<String>* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
|
||||
| `status` | [Optional<GetTokenDetailsAuthenticationResponseStatus>](../../models/operations/GetTokenDetailsAuthenticationResponseStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
|
||||
|
||||
@@ -8,8 +8,8 @@ Logged in user details
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `adsConsent` | *Optional<Boolean>* | :heavy_check_mark: | Unknown | |
|
||||
| `adsConsentReminderAt` | [OffsetDateTime](https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html) | :heavy_check_mark: | Unknown | |
|
||||
| `adsConsentSetAt` | [OffsetDateTime](https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html) | :heavy_check_mark: | Unknown | |
|
||||
| `adsConsentReminderAt` | *Optional<Long>* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `adsConsentSetAt` | *Optional<Long>* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `anonymous` | *JsonNullable<Boolean>* | :heavy_minus_sign: | Unknown | |
|
||||
| `authToken` | *String* | :heavy_check_mark: | The account token | CxoUzBTSV5hsxjTpFKaf |
|
||||
| `backupCodesCreated` | *Optional<Boolean>* | :heavy_minus_sign: | If the two-factor authentication backup codes have been created | |
|
||||
|
||||
@@ -5,5 +5,5 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [GetTopWatchedContentQueryParamType](../../models/operations/GetTopWatchedContentQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `includeGuids` | *Optional<Long>* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
| `type` | [GetTopWatchedContentQueryParamType](../../models/operations/GetTopWatchedContentQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
@@ -13,4 +13,4 @@
|
||||
| `includeExternalMedia` | [Optional<IncludeExternalMedia>](../../models/operations/IncludeExternalMedia.md) | :heavy_minus_sign: | include external media in the results<br/> | |
|
||||
| `xPlexContainerStart` | *Optional<Integer>* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
||||
| `xPlexContainerSize` | *Optional<Integer>* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
||||
| `xPlexToken` | *String* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
|
||||
| `xPlexToken` | *String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
|
||||
@@ -5,5 +5,4 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 1 |
|
||||
| `path` | *String* | :heavy_check_mark: | N/A | /movies |
|
||||
| `path` | *Optional<String>* | :heavy_minus_sign: | N/A | /TV Shows/House |
|
||||
@@ -6,19 +6,19 @@
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
|
||||
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `bitrate` | *int* | :heavy_check_mark: | N/A | 25025 |
|
||||
| `width` | *int* | :heavy_check_mark: | N/A | 3840 |
|
||||
| `height` | *int* | :heavy_check_mark: | N/A | 2072 |
|
||||
| `aspectRatio` | *double* | :heavy_check_mark: | N/A | 1.85 |
|
||||
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `bitrate` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 25025 |
|
||||
| `width` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 3840 |
|
||||
| `height` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2072 |
|
||||
| `aspectRatio` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1.85 |
|
||||
| `audioProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | dts |
|
||||
| `audioChannels` | *int* | :heavy_check_mark: | N/A | 6 |
|
||||
| `audioCodec` | *String* | :heavy_check_mark: | N/A | eac3 |
|
||||
| `videoCodec` | *String* | :heavy_check_mark: | N/A | hevc |
|
||||
| `videoResolution` | *String* | :heavy_check_mark: | N/A | 4k |
|
||||
| `audioChannels` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `audioCodec` | *Optional<String>* | :heavy_minus_sign: | N/A | eac3 |
|
||||
| `videoCodec` | *Optional<String>* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `videoResolution` | *Optional<String>* | :heavy_minus_sign: | N/A | 4k |
|
||||
| `container` | *String* | :heavy_check_mark: | N/A | mkv |
|
||||
| `videoFrameRate` | *String* | :heavy_check_mark: | N/A | 24p |
|
||||
| `videoProfile` | *String* | :heavy_check_mark: | N/A | main 10 |
|
||||
| `videoFrameRate` | *Optional<String>* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `videoProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `hasVoiceActivity` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | [Optional<OptimizedForStreaming>](../../models/operations/OptimizedForStreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `has64bitOffsets` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
|
||||
@@ -7,14 +7,14 @@
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 119542 |
|
||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `file` | *String* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `size` | *long* | :heavy_check_mark: | N/A | 36158371307 |
|
||||
| `container` | *String* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
||||
| `audioProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | dts |
|
||||
| `has64bitOffsets` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `videoProfile` | *String* | :heavy_check_mark: | N/A | main 10 |
|
||||
| `videoProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `indexes` | *Optional<String>* | :heavy_minus_sign: | N/A | sd |
|
||||
| `hasThumbnail` | [Optional<HasThumbnail>](../../models/operations/HasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `stream` | List<[Stream](../../models/operations/Stream.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,102 +0,0 @@
|
||||
# PostUsersSignInDataAuthenticationFeatures
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------------------------------- | ----------------------------------------- |
|
||||
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
|
||||
| `ANDROID_PI_P` | Android - PiP |
|
||||
| `CU_SUNSET` | CU Sunset |
|
||||
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
|
||||
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
|
||||
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
|
||||
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
|
||||
| `ALBUM_TYPES` | album-types |
|
||||
| `ALLOW_DVR` | allow_dvr |
|
||||
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
|
||||
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
|
||||
| `AVOD_NEW_MEDIA` | avod-new-media |
|
||||
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
|
||||
| `BOOST_VOICES` | boost-voices |
|
||||
| `CAMERA_UPLOAD` | camera_upload |
|
||||
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
|
||||
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
|
||||
| `CLOUDSYNC` | cloudsync |
|
||||
| `COLLECTIONS` | collections |
|
||||
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
|
||||
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
|
||||
| `COMPANIONS_SONOS` | companions_sonos |
|
||||
| `CONTENT_FILTER` | content_filter |
|
||||
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
|
||||
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
|
||||
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
|
||||
| `DOWNLOADS_GATING` | downloads-gating |
|
||||
| `DRM_SUPPORT` | drm_support |
|
||||
| `DVR` | dvr |
|
||||
| `DVR_BLOCK_UNSUPPORTED_COUNTRIES` | dvr-block-unsupported-countries |
|
||||
| `EPG_RECENT_CHANNELS` | epg-recent-channels |
|
||||
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
|
||||
| `FEDERATED_AUTH` | federated-auth |
|
||||
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
|
||||
| `GRANDFATHER_SYNC` | grandfather-sync |
|
||||
| `GUIDED_UPGRADE` | guided-upgrade |
|
||||
| `HARDWARE_TRANSCODING` | hardware_transcoding |
|
||||
| `HOME` | home |
|
||||
| `HWTRANSCODE` | hwtranscode |
|
||||
| `IMAGGA_V2` | imagga-v2 |
|
||||
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
|
||||
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
|
||||
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
|
||||
| `ITEM_CLUSTERS` | item_clusters |
|
||||
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
|
||||
| `KEVIN_BACON` | kevin-bacon |
|
||||
| `KOREA_CONSENT` | korea-consent |
|
||||
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
|
||||
| `LETS_ENCRYPT` | lets_encrypt |
|
||||
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
|
||||
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
|
||||
| `LIVETV` | livetv |
|
||||
| `LYRICS` | lyrics |
|
||||
| `METADATA_SEARCH` | metadata_search |
|
||||
| `MUSIC_ANALYSIS` | music-analysis |
|
||||
| `MUSIC_VIDEOS` | music_videos |
|
||||
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
|
||||
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
|
||||
| `NOMINATIM` | nominatim |
|
||||
| `PASS` | pass |
|
||||
| `PHOTOS_FAVORITES` | photos-favorites |
|
||||
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
|
||||
| `PHOTOS_V6_EDIT` | photosV6-edit |
|
||||
| `PHOTOS_V6_TV_ALBUMS` | photosV6-tv-albums |
|
||||
| `PMS_HEALTH` | pms_health |
|
||||
| `PREMIUM_DASHBOARD` | premium-dashboard |
|
||||
| `PREMIUM_MUSIC_METADATA` | premium_music_metadata |
|
||||
| `RADIO` | radio |
|
||||
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
|
||||
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
|
||||
| `SESSION_BANDWIDTH_RESTRICTIONS` | session_bandwidth_restrictions |
|
||||
| `SESSION_KICK` | session_kick |
|
||||
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
|
||||
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
|
||||
| `SIGNIN_NOTIFICATION` | signin_notification |
|
||||
| `SIGNIN_WITH_APPLE` | signin_with_apple |
|
||||
| `SILENCE_REMOVAL` | silence-removal |
|
||||
| `SLEEP_TIMER` | sleep-timer |
|
||||
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
|
||||
| `SYNC` | sync |
|
||||
| `SWEET_FADES` | sweet-fades |
|
||||
| `TRANSCODER_CACHE` | transcoder_cache |
|
||||
| `TRAILERS` | trailers |
|
||||
| `TUNER_SHARING` | tuner-sharing |
|
||||
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
|
||||
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
|
||||
| `UPGRADE3DS2` | upgrade-3ds2 |
|
||||
| `VISUALIZERS` | visualizers |
|
||||
| `VOD_SCHEMA` | vod-schema |
|
||||
| `VOD_CLOUDFLARE` | vod_cloudflare |
|
||||
| `VOLUME_LEVELING` | volume-leveling |
|
||||
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
|
||||
| `WATCHLIST_RSS` | watchlist-rss |
|
||||
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |
|
||||
| `WEBHOOKS` | webhooks |
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `features` | List<[PostUsersSignInDataAuthenticationFeatures](../../models/operations/PostUsersSignInDataAuthenticationFeatures.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
|
||||
| `features` | List<*String*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
|
||||
| `active` | *Optional<Boolean>* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
|
||||
| `subscribedAt` | *JsonNullable<String>* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
|
||||
| `status` | [Optional<PostUsersSignInDataAuthenticationResponseStatus>](../../models/operations/PostUsersSignInDataAuthenticationResponseStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
|
||||
|
||||
@@ -1,102 +0,0 @@
|
||||
# PostUsersSignInDataFeatures
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------------------------------- | ----------------------------------------- |
|
||||
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
|
||||
| `ANDROID_PI_P` | Android - PiP |
|
||||
| `CU_SUNSET` | CU Sunset |
|
||||
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
|
||||
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
|
||||
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
|
||||
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
|
||||
| `ALBUM_TYPES` | album-types |
|
||||
| `ALLOW_DVR` | allow_dvr |
|
||||
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
|
||||
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
|
||||
| `AVOD_NEW_MEDIA` | avod-new-media |
|
||||
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
|
||||
| `BOOST_VOICES` | boost-voices |
|
||||
| `CAMERA_UPLOAD` | camera_upload |
|
||||
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
|
||||
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
|
||||
| `CLOUDSYNC` | cloudsync |
|
||||
| `COLLECTIONS` | collections |
|
||||
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
|
||||
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
|
||||
| `COMPANIONS_SONOS` | companions_sonos |
|
||||
| `CONTENT_FILTER` | content_filter |
|
||||
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
|
||||
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
|
||||
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
|
||||
| `DOWNLOADS_GATING` | downloads-gating |
|
||||
| `DRM_SUPPORT` | drm_support |
|
||||
| `DVR` | dvr |
|
||||
| `DVR_BLOCK_UNSUPPORTED_COUNTRIES` | dvr-block-unsupported-countries |
|
||||
| `EPG_RECENT_CHANNELS` | epg-recent-channels |
|
||||
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
|
||||
| `FEDERATED_AUTH` | federated-auth |
|
||||
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
|
||||
| `GRANDFATHER_SYNC` | grandfather-sync |
|
||||
| `GUIDED_UPGRADE` | guided-upgrade |
|
||||
| `HARDWARE_TRANSCODING` | hardware_transcoding |
|
||||
| `HOME` | home |
|
||||
| `HWTRANSCODE` | hwtranscode |
|
||||
| `IMAGGA_V2` | imagga-v2 |
|
||||
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
|
||||
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
|
||||
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
|
||||
| `ITEM_CLUSTERS` | item_clusters |
|
||||
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
|
||||
| `KEVIN_BACON` | kevin-bacon |
|
||||
| `KOREA_CONSENT` | korea-consent |
|
||||
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
|
||||
| `LETS_ENCRYPT` | lets_encrypt |
|
||||
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
|
||||
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
|
||||
| `LIVETV` | livetv |
|
||||
| `LYRICS` | lyrics |
|
||||
| `METADATA_SEARCH` | metadata_search |
|
||||
| `MUSIC_ANALYSIS` | music-analysis |
|
||||
| `MUSIC_VIDEOS` | music_videos |
|
||||
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
|
||||
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
|
||||
| `NOMINATIM` | nominatim |
|
||||
| `PASS` | pass |
|
||||
| `PHOTOS_FAVORITES` | photos-favorites |
|
||||
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
|
||||
| `PHOTOS_V6_EDIT` | photosV6-edit |
|
||||
| `PHOTOS_V6_TV_ALBUMS` | photosV6-tv-albums |
|
||||
| `PMS_HEALTH` | pms_health |
|
||||
| `PREMIUM_DASHBOARD` | premium-dashboard |
|
||||
| `PREMIUM_MUSIC_METADATA` | premium_music_metadata |
|
||||
| `RADIO` | radio |
|
||||
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
|
||||
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
|
||||
| `SESSION_BANDWIDTH_RESTRICTIONS` | session_bandwidth_restrictions |
|
||||
| `SESSION_KICK` | session_kick |
|
||||
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
|
||||
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
|
||||
| `SIGNIN_NOTIFICATION` | signin_notification |
|
||||
| `SIGNIN_WITH_APPLE` | signin_with_apple |
|
||||
| `SILENCE_REMOVAL` | silence-removal |
|
||||
| `SLEEP_TIMER` | sleep-timer |
|
||||
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
|
||||
| `SYNC` | sync |
|
||||
| `SWEET_FADES` | sweet-fades |
|
||||
| `TRANSCODER_CACHE` | transcoder_cache |
|
||||
| `TRAILERS` | trailers |
|
||||
| `TUNER_SHARING` | tuner-sharing |
|
||||
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
|
||||
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
|
||||
| `UPGRADE3DS2` | upgrade-3ds2 |
|
||||
| `VISUALIZERS` | visualizers |
|
||||
| `VOD_SCHEMA` | vod-schema |
|
||||
| `VOD_CLOUDFLARE` | vod_cloudflare |
|
||||
| `VOLUME_LEVELING` | volume-leveling |
|
||||
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
|
||||
| `WATCHLIST_RSS` | watchlist-rss |
|
||||
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |
|
||||
| `WEBHOOKS` | webhooks |
|
||||
@@ -4,10 +4,10 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `clientID` | *Optional<String>* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
|
||||
| `clientName` | *Optional<String>* | :heavy_minus_sign: | N/A | Plex Web |
|
||||
| `deviceName` | *Optional<String>* | :heavy_minus_sign: | N/A | Linux |
|
||||
| `clientVersion` | *Optional<String>* | :heavy_minus_sign: | N/A | 4.133.0 |
|
||||
| `clientPlatform` | *Optional<String>* | :heavy_minus_sign: | N/A | Chrome |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `clientID` | *Optional<String>* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||
| `clientName` | *Optional<String>* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
|
||||
| `deviceNickname` | *Optional<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `clientVersion` | *Optional<String>* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
|
||||
| `platform` | *Optional<String>* | :heavy_minus_sign: | The platform of the client application. | Roku |
|
||||
| `requestBody` | [Optional<PostUsersSignInDataRequestBody>](../../models/operations/PostUsersSignInDataRequestBody.md) | :heavy_minus_sign: | Login credentials | |
|
||||
File diff suppressed because one or more lines are too long
@@ -7,7 +7,7 @@ If the account’s Plex Pass subscription is active
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `features` | List<[PostUsersSignInDataFeatures](../../models/operations/PostUsersSignInDataFeatures.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
|
||||
| `features` | List<*String*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
|
||||
| `active` | *Optional<Boolean>* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
|
||||
| `subscribedAt` | *JsonNullable<String>* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
|
||||
| `status` | [Optional<PostUsersSignInDataAuthenticationStatus>](../../models/operations/PostUsersSignInDataAuthenticationStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
|
||||
|
||||
@@ -8,8 +8,8 @@ Returns the user account data with a valid auth token
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `adsConsent` | *Optional<Boolean>* | :heavy_check_mark: | Unknown | |
|
||||
| `adsConsentReminderAt` | [OffsetDateTime](https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html) | :heavy_check_mark: | Unknown | |
|
||||
| `adsConsentSetAt` | [OffsetDateTime](https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html) | :heavy_check_mark: | Unknown | |
|
||||
| `adsConsentReminderAt` | *Optional<Long>* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `adsConsentSetAt` | *Optional<Long>* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `anonymous` | *JsonNullable<Boolean>* | :heavy_minus_sign: | Unknown | |
|
||||
| `authToken` | *String* | :heavy_check_mark: | The account token | CxoUzBTSV5hsxjTpFKaf |
|
||||
| `backupCodesCreated` | *Optional<Boolean>* | :heavy_minus_sign: | If the two-factor authentication backup codes have been created | |
|
||||
|
||||
11
docs/models/operations/QueryParamIncludeCollections.md
Normal file
11
docs/models/operations/QueryParamIncludeCollections.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# QueryParamIncludeCollections
|
||||
|
||||
Whether to include collections in the search results.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
11
docs/models/operations/QueryParamIncludeExternalMedia.md
Normal file
11
docs/models/operations/QueryParamIncludeExternalMedia.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# QueryParamIncludeExternalMedia
|
||||
|
||||
Whether to include external media in the search results.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
9
docs/models/operations/SearchResult.md
Normal file
9
docs/models/operations/SearchResult.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# SearchResult
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `score` | *float* | :heavy_check_mark: | N/A |
|
||||
| `metadata` | [GetSearchAllLibrariesMetadata](../../models/operations/GetSearchAllLibrariesMetadata.md) | :heavy_check_mark: | N/A |
|
||||
12
docs/models/operations/SearchTypes.md
Normal file
12
docs/models/operations/SearchTypes.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# SearchTypes
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------- | -------------- |
|
||||
| `MOVIES` | movies |
|
||||
| `MUSIC` | music |
|
||||
| `OTHER_VIDEOS` | otherVideos |
|
||||
| `PEOPLE` | people |
|
||||
| `TV` | tv |
|
||||
@@ -7,7 +7,7 @@ If the account’s Plex Pass subscription is active
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||
| `features` | List<[Features](../../models/operations/Features.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
|
||||
| `features` | List<*String*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
|
||||
| `active` | *Optional<Boolean>* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
|
||||
| `subscribedAt` | *JsonNullable<String>* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
|
||||
| `status` | [Optional<GetTokenDetailsAuthenticationStatus>](../../models/operations/GetTokenDetailsAuthenticationStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
|
||||
|
||||
@@ -38,11 +38,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetServerActivitiesResponse res = sdk.activities().getServerActivities()
|
||||
@@ -61,12 +61,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
|
||||
| models/errors/GetServerActivitiesBadRequest | 400 | application/json |
|
||||
| models/errors/GetServerActivitiesUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## cancelServerActivities
|
||||
|
||||
@@ -89,11 +88,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
CancelServerActivitiesResponse res = sdk.activities().cancelServerActivities()
|
||||
@@ -117,8 +116,8 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
|
||||
| models/errors/CancelServerActivitiesBadRequest | 400 | application/json |
|
||||
| models/errors/CancelServerActivitiesUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
@@ -37,11 +37,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetTransientTokenResponse res = sdk.authentication().getTransientToken()
|
||||
@@ -67,12 +67,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
|
||||
| models/errors/GetTransientTokenBadRequest | 400 | application/json |
|
||||
| models/errors/GetTransientTokenUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getSourceConnectionInformation
|
||||
|
||||
@@ -97,11 +96,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetSourceConnectionInformationResponse res = sdk.authentication().getSourceConnectionInformation()
|
||||
@@ -125,12 +124,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| models/errors/GetSourceConnectionInformationBadRequest | 400 | application/json |
|
||||
| models/errors/GetSourceConnectionInformationUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getTokenDetails
|
||||
|
||||
@@ -153,11 +151,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetTokenDetailsResponse res = sdk.authentication().getTokenDetails()
|
||||
@@ -182,12 +180,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
|
||||
| models/errors/GetTokenDetailsBadRequest | 400 | application/json |
|
||||
| models/errors/GetTokenDetailsUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## postUsersSignInData
|
||||
|
||||
@@ -211,11 +208,11 @@ public class Application {
|
||||
public static void main(String[] args) throws PostUsersSignInDataBadRequest, PostUsersSignInDataUnauthorized, Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
PostUsersSignInDataRequest req = PostUsersSignInDataRequest.builder()
|
||||
@@ -250,8 +247,8 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
|
||||
| models/errors/PostUsersSignInDataBadRequest | 400 | application/json |
|
||||
| models/errors/PostUsersSignInDataUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
@@ -35,11 +35,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetButlerTasksResponse res = sdk.butler().getButlerTasks()
|
||||
@@ -58,12 +58,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| models/errors/GetButlerTasksBadRequest | 400 | application/json |
|
||||
| models/errors/GetButlerTasksUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## startAllTasks
|
||||
|
||||
@@ -91,11 +90,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
StartAllTasksResponse res = sdk.butler().startAllTasks()
|
||||
@@ -112,12 +111,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
|
||||
| models/errors/StartAllTasksBadRequest | 400 | application/json |
|
||||
| models/errors/StartAllTasksUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## stopAllTasks
|
||||
|
||||
@@ -141,11 +139,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
StopAllTasksResponse res = sdk.butler().stopAllTasks()
|
||||
@@ -162,12 +160,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
||||
| models/errors/StopAllTasksBadRequest | 400 | application/json |
|
||||
| models/errors/StopAllTasksUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## startTask
|
||||
|
||||
@@ -196,11 +193,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
StartTaskResponse res = sdk.butler().startTask()
|
||||
@@ -224,12 +221,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| models/errors/StartTaskBadRequest | 400 | application/json |
|
||||
| models/errors/StartTaskUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## stopTask
|
||||
|
||||
@@ -254,11 +250,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
StopTaskResponse res = sdk.butler().stopTask()
|
||||
@@ -282,8 +278,8 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| models/errors/StopTaskBadRequest | 400 | application/json |
|
||||
| models/errors/StopTaskUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
@@ -34,11 +34,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetGlobalHubsResponse res = sdk.hubs().getGlobalHubs()
|
||||
@@ -66,12 +66,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
|
||||
| models/errors/GetGlobalHubsBadRequest | 400 | application/json |
|
||||
| models/errors/GetGlobalHubsUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getRecentlyAdded
|
||||
|
||||
@@ -96,11 +95,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetRecentlyAddedRequest req = GetRecentlyAddedRequest.builder()
|
||||
@@ -135,10 +134,9 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------- | ---------------------- | ---------------------- |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getLibraryHubs
|
||||
|
||||
@@ -163,11 +161,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetLibraryHubsResponse res = sdk.hubs().getLibraryHubs()
|
||||
@@ -197,8 +195,8 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| models/errors/GetLibraryHubsBadRequest | 400 | application/json |
|
||||
| models/errors/GetLibraryHubsUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
@@ -16,6 +16,7 @@ API Calls interacting with Plex Media Server Libraries
|
||||
* [getLibraryItems](#getlibraryitems) - Get Library Items
|
||||
* [getRefreshLibraryMetadata](#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||
* [getSearchLibrary](#getsearchlibrary) - Search Library
|
||||
* [getSearchAllLibraries](#getsearchalllibraries) - Search All Libraries
|
||||
* [getMetaDataByRatingKey](#getmetadatabyratingkey) - Get Metadata by RatingKey
|
||||
* [getMetadataChildren](#getmetadatachildren) - Get Items Children
|
||||
* [getTopWatchedContent](#gettopwatchedcontent) - Get Top Watched Content
|
||||
@@ -42,11 +43,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetFileHashResponse res = sdk.library().getFileHash()
|
||||
@@ -72,12 +73,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
|
||||
| models/errors/GetFileHashBadRequest | 400 | application/json |
|
||||
| models/errors/GetFileHashUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getRecentlyAddedLibrary
|
||||
|
||||
@@ -105,11 +105,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetRecentlyAddedLibraryRequest req = GetRecentlyAddedLibraryRequest.builder()
|
||||
@@ -157,12 +157,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
|
||||
| models/errors/GetRecentlyAddedLibraryBadRequest | 400 | application/json |
|
||||
| models/errors/GetRecentlyAddedLibraryUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getAllLibraries
|
||||
|
||||
@@ -191,11 +190,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetAllLibrariesResponse res = sdk.library().getAllLibraries()
|
||||
@@ -214,12 +213,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
|
||||
| models/errors/GetAllLibrariesBadRequest | 400 | application/json |
|
||||
| models/errors/GetAllLibrariesUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getLibraryDetails
|
||||
|
||||
@@ -282,16 +280,16 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetLibraryDetailsResponse res = sdk.library().getLibraryDetails()
|
||||
.sectionKey(9518)
|
||||
.includeDetails(IncludeDetails.ZERO)
|
||||
.sectionKey(9518)
|
||||
.call();
|
||||
|
||||
if (res.object().isPresent()) {
|
||||
@@ -305,8 +303,8 @@ public class Application {
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `includeDetails` | [Optional<IncludeDetails>](../../models/operations/IncludeDetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
|
||||
### Response
|
||||
|
||||
@@ -314,12 +312,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
|
||||
| models/errors/GetLibraryDetailsBadRequest | 400 | application/json |
|
||||
| models/errors/GetLibraryDetailsUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## deleteLibrary
|
||||
|
||||
@@ -342,11 +339,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
DeleteLibraryResponse res = sdk.library().deleteLibrary()
|
||||
@@ -370,12 +367,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
|
||||
| models/errors/DeleteLibraryBadRequest | 400 | application/json |
|
||||
| models/errors/DeleteLibraryUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getLibraryItems
|
||||
|
||||
@@ -423,16 +419,16 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetLibraryItemsRequest req = GetLibraryItemsRequest.builder()
|
||||
.sectionKey(9518)
|
||||
.tag(Tag.EDITION)
|
||||
.sectionKey(9518)
|
||||
.includeGuids(IncludeGuids.Enable)
|
||||
.type(GetLibraryItemsQueryParamType.TvShow)
|
||||
.includeMeta(GetLibraryItemsQueryParamIncludeMeta.Enable)
|
||||
@@ -463,12 +459,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
|
||||
| models/errors/GetLibraryItemsBadRequest | 400 | application/json |
|
||||
| models/errors/GetLibraryItemsUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getRefreshLibraryMetadata
|
||||
|
||||
@@ -493,16 +488,16 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetRefreshLibraryMetadataResponse res = sdk.library().getRefreshLibraryMetadata()
|
||||
.sectionKey(9518)
|
||||
.force(Force.ONE)
|
||||
.sectionKey(9518)
|
||||
.call();
|
||||
|
||||
// handle response
|
||||
@@ -514,8 +509,8 @@ public class Application {
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `force` | [Optional<Force>](../../models/operations/Force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |
|
||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
|
||||
### Response
|
||||
|
||||
@@ -523,12 +518,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| models/errors/GetRefreshLibraryMetadataBadRequest | 400 | application/json |
|
||||
| models/errors/GetRefreshLibraryMetadataUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getSearchLibrary
|
||||
|
||||
@@ -570,11 +564,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetSearchLibraryResponse res = sdk.library().getSearchLibrary()
|
||||
@@ -602,12 +596,82 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
|
||||
| models/errors/GetSearchLibraryBadRequest | 400 | application/json |
|
||||
| models/errors/GetSearchLibraryUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getSearchAllLibraries
|
||||
|
||||
Search the provided query across all library sections, or a single section, and return matches as hubs, split up by type.
|
||||
|
||||
|
||||
### Example Usage
|
||||
|
||||
```java
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetSearchAllLibrariesBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetSearchAllLibrariesUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetSearchAllLibrariesRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetSearchAllLibrariesResponse;
|
||||
import dev.plexapi.sdk.models.operations.QueryParamIncludeCollections;
|
||||
import dev.plexapi.sdk.models.operations.QueryParamIncludeExternalMedia;
|
||||
import dev.plexapi.sdk.models.operations.SearchTypes;
|
||||
import java.lang.Exception;
|
||||
import java.util.List;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) throws GetSearchAllLibrariesBadRequest, GetSearchAllLibrariesUnauthorized, Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetSearchAllLibrariesRequest req = GetSearchAllLibrariesRequest.builder()
|
||||
.query("<value>")
|
||||
.searchTypes(List.of(
|
||||
SearchTypes.PEOPLE))
|
||||
.includeCollections(QueryParamIncludeCollections.Enable)
|
||||
.includeExternalMedia(QueryParamIncludeExternalMedia.Enable)
|
||||
.build();
|
||||
|
||||
GetSearchAllLibrariesResponse res = sdk.library().getSearchAllLibraries()
|
||||
.request(req)
|
||||
.call();
|
||||
|
||||
if (res.object().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `request` | [GetSearchAllLibrariesRequest](../../models/operations/GetSearchAllLibrariesRequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
|
||||
### Response
|
||||
|
||||
**[GetSearchAllLibrariesResponse](../../models/operations/GetSearchAllLibrariesResponse.md)**
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
|
||||
| models/errors/GetSearchAllLibrariesBadRequest | 400 | application/json |
|
||||
| models/errors/GetSearchAllLibrariesUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getMetaDataByRatingKey
|
||||
|
||||
@@ -631,11 +695,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetMetaDataByRatingKeyResponse res = sdk.library().getMetaDataByRatingKey()
|
||||
@@ -661,12 +725,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
|
||||
| models/errors/GetMetaDataByRatingKeyBadRequest | 400 | application/json |
|
||||
| models/errors/GetMetaDataByRatingKeyUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getMetadataChildren
|
||||
|
||||
@@ -690,11 +753,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetMetadataChildrenResponse res = sdk.library().getMetadataChildren()
|
||||
@@ -722,12 +785,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
|
||||
| models/errors/GetMetadataChildrenBadRequest | 400 | application/json |
|
||||
| models/errors/GetMetadataChildrenUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getTopWatchedContent
|
||||
|
||||
@@ -752,16 +814,16 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetTopWatchedContentResponse res = sdk.library().getTopWatchedContent()
|
||||
.type(GetTopWatchedContentQueryParamType.TvShow)
|
||||
.includeGuids(1L)
|
||||
.type(GetTopWatchedContentQueryParamType.TvShow)
|
||||
.call();
|
||||
|
||||
if (res.object().isPresent()) {
|
||||
@@ -775,8 +837,8 @@ public class Application {
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [GetTopWatchedContentQueryParamType](../../models/operations/GetTopWatchedContentQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `includeGuids` | *Optional<Long>* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
| `type` | [GetTopWatchedContentQueryParamType](../../models/operations/GetTopWatchedContentQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
|
||||
### Response
|
||||
|
||||
@@ -784,12 +846,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| models/errors/GetTopWatchedContentBadRequest | 400 | application/json |
|
||||
| models/errors/GetTopWatchedContentUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getOnDeck
|
||||
|
||||
@@ -813,11 +874,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetOnDeckResponse res = sdk.library().getOnDeck()
|
||||
@@ -836,8 +897,8 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| models/errors/GetOnDeckBadRequest | 400 | application/json |
|
||||
| models/errors/GetOnDeckUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
@@ -35,11 +35,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
LogLineResponse res = sdk.log().logLine()
|
||||
@@ -67,12 +67,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------- | --------------------------------- | --------------------------------- |
|
||||
| models/errors/LogLineBadRequest | 400 | application/json |
|
||||
| models/errors/LogLineUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## logMultiLine
|
||||
|
||||
@@ -117,11 +116,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
String req = "level=4&message=Test%20message%201&source=postman\nlevel=3&message=Test%20message%202&source=postman
|
||||
@@ -148,12 +147,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
||||
| models/errors/LogMultiLineBadRequest | 400 | application/json |
|
||||
| models/errors/LogMultiLineUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## enablePaperTrail
|
||||
|
||||
@@ -177,11 +175,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
EnablePaperTrailResponse res = sdk.log().enablePaperTrail()
|
||||
@@ -198,8 +196,8 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
|
||||
| models/errors/EnablePaperTrailBadRequest | 400 | application/json |
|
||||
| models/errors/EnablePaperTrailUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
@@ -35,11 +35,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
MarkPlayedResponse res = sdk.media().markPlayed()
|
||||
@@ -63,12 +63,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||
| models/errors/MarkPlayedBadRequest | 400 | application/json |
|
||||
| models/errors/MarkPlayedUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## markUnplayed
|
||||
|
||||
@@ -91,11 +90,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
MarkUnplayedResponse res = sdk.media().markUnplayed()
|
||||
@@ -119,12 +118,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
||||
| models/errors/MarkUnplayedBadRequest | 400 | application/json |
|
||||
| models/errors/MarkUnplayedUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## updatePlayProgress
|
||||
|
||||
@@ -148,11 +146,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
UpdatePlayProgressResponse res = sdk.media().updatePlayProgress()
|
||||
@@ -180,12 +178,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| models/errors/UpdatePlayProgressBadRequest | 400 | application/json |
|
||||
| models/errors/UpdatePlayProgressUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getBannerImage
|
||||
|
||||
@@ -209,11 +206,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetBannerImageRequest req = GetBannerImageRequest.builder()
|
||||
@@ -248,12 +245,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| models/errors/GetBannerImageBadRequest | 400 | application/json |
|
||||
| models/errors/GetBannerImageUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getThumbImage
|
||||
|
||||
@@ -277,11 +273,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetThumbImageRequest req = GetThumbImageRequest.builder()
|
||||
@@ -316,8 +312,8 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
|
||||
| models/errors/GetThumbImageBadRequest | 400 | application/json |
|
||||
| models/errors/GetThumbImageUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
@@ -48,11 +48,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
CreatePlaylistRequest req = CreatePlaylistRequest.builder()
|
||||
@@ -85,12 +85,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| models/errors/CreatePlaylistBadRequest | 400 | application/json |
|
||||
| models/errors/CreatePlaylistUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getPlaylists
|
||||
|
||||
@@ -115,11 +114,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetPlaylistsResponse res = sdk.playlists().getPlaylists()
|
||||
@@ -147,12 +146,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
||||
| models/errors/GetPlaylistsBadRequest | 400 | application/json |
|
||||
| models/errors/GetPlaylistsUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getPlaylist
|
||||
|
||||
@@ -177,11 +175,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetPlaylistResponse res = sdk.playlists().getPlaylist()
|
||||
@@ -207,12 +205,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
|
||||
| models/errors/GetPlaylistBadRequest | 400 | application/json |
|
||||
| models/errors/GetPlaylistUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## deletePlaylist
|
||||
|
||||
@@ -236,11 +233,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
DeletePlaylistResponse res = sdk.playlists().deletePlaylist()
|
||||
@@ -264,12 +261,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| models/errors/DeletePlaylistBadRequest | 400 | application/json |
|
||||
| models/errors/DeletePlaylistUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## updatePlaylist
|
||||
|
||||
@@ -293,11 +289,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
UpdatePlaylistResponse res = sdk.playlists().updatePlaylist()
|
||||
@@ -325,12 +321,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| models/errors/UpdatePlaylistBadRequest | 400 | application/json |
|
||||
| models/errors/UpdatePlaylistUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getPlaylistContents
|
||||
|
||||
@@ -358,11 +353,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetPlaylistContentsResponse res = sdk.playlists().getPlaylistContents()
|
||||
@@ -390,12 +385,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
|
||||
| models/errors/GetPlaylistContentsBadRequest | 400 | application/json |
|
||||
| models/errors/GetPlaylistContentsUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## clearPlaylistContents
|
||||
|
||||
@@ -419,11 +413,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
ClearPlaylistContentsResponse res = sdk.playlists().clearPlaylistContents()
|
||||
@@ -447,12 +441,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
|
||||
| models/errors/ClearPlaylistContentsBadRequest | 400 | application/json |
|
||||
| models/errors/ClearPlaylistContentsUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## addPlaylistContents
|
||||
|
||||
@@ -477,11 +470,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
AddPlaylistContentsResponse res = sdk.playlists().addPlaylistContents()
|
||||
@@ -511,12 +504,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
|
||||
| models/errors/AddPlaylistContentsBadRequest | 400 | application/json |
|
||||
| models/errors/AddPlaylistContentsUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## uploadPlaylist
|
||||
|
||||
@@ -541,11 +533,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
UploadPlaylistResponse res = sdk.playlists().uploadPlaylist()
|
||||
@@ -573,8 +565,8 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| models/errors/UploadPlaylistBadRequest | 400 | application/json |
|
||||
| models/errors/UploadPlaylistUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
@@ -37,11 +37,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetCompanionsDataResponse res = sdk.plex().getCompanionsData()
|
||||
@@ -66,12 +66,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
|
||||
| models/errors/GetCompanionsDataBadRequest | 400 | application/json |
|
||||
| models/errors/GetCompanionsDataUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getUserFriends
|
||||
|
||||
@@ -94,11 +93,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetUserFriendsResponse res = sdk.plex().getUserFriends()
|
||||
@@ -123,12 +122,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| models/errors/GetUserFriendsBadRequest | 400 | application/json |
|
||||
| models/errors/GetUserFriendsUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getGeoData
|
||||
|
||||
@@ -150,11 +148,11 @@ public class Application {
|
||||
public static void main(String[] args) throws GetGeoDataBadRequest, GetGeoDataUnauthorized, Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetGeoDataResponse res = sdk.plex().getGeoData()
|
||||
@@ -179,12 +177,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||
| models/errors/GetGeoDataBadRequest | 400 | application/json |
|
||||
| models/errors/GetGeoDataUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getHomeData
|
||||
|
||||
@@ -207,11 +204,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetHomeDataResponse res = sdk.plex().getHomeData()
|
||||
@@ -230,12 +227,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
|
||||
| models/errors/GetHomeDataBadRequest | 400 | application/json |
|
||||
| models/errors/GetHomeDataUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getServerResources
|
||||
|
||||
@@ -261,18 +257,18 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetServerResourcesResponse res = sdk.plex().getServerResources()
|
||||
.includeHttps(IncludeHttps.Enable)
|
||||
.includeRelay(IncludeRelay.Enable)
|
||||
.includeIPv6(IncludeIPv6.Enable)
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.call();
|
||||
|
||||
if (res.plexDevices().isPresent()) {
|
||||
@@ -285,11 +281,11 @@ public class Application {
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
||||
| `includeHttps` | [Optional<IncludeHttps>](../../models/operations/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
|
||||
| `includeRelay` | [Optional<IncludeRelay>](../../models/operations/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
|
||||
| `includeIPv6` | [Optional<IncludeIPv6>](../../models/operations/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
|
||||
| `clientID` | *Optional<String>* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
|
||||
| `clientID` | *Optional<String>* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||
| `serverURL` | *String* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
|
||||
|
||||
### Response
|
||||
@@ -298,12 +294,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| models/errors/GetServerResourcesBadRequest | 400 | application/json |
|
||||
| models/errors/GetServerResourcesUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getPin
|
||||
|
||||
@@ -325,11 +320,11 @@ public class Application {
|
||||
public static void main(String[] args) throws GetPinBadRequest, Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetPinRequest req = GetPinRequest.builder()
|
||||
@@ -359,11 +354,10 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------ | ------------------------------ | ------------------------------ |
|
||||
| models/errors/GetPinBadRequest | 400 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getTokenByPinId
|
||||
|
||||
@@ -386,11 +380,11 @@ public class Application {
|
||||
public static void main(String[] args) throws GetTokenByPinIdBadRequest, GetTokenByPinIdResponseBody, Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetTokenByPinIdRequest req = GetTokenByPinIdRequest.builder()
|
||||
@@ -421,8 +415,8 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
|
||||
| models/errors/GetTokenByPinIdBadRequest | 400 | application/json |
|
||||
| models/errors/GetTokenByPinIdResponseBody | 404 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
@@ -45,11 +45,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
PerformSearchResponse res = sdk.search().performSearch()
|
||||
@@ -77,12 +77,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
|
||||
| models/errors/PerformSearchBadRequest | 400 | application/json |
|
||||
| models/errors/PerformSearchUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## performVoiceSearch
|
||||
|
||||
@@ -109,11 +108,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
PerformVoiceSearchResponse res = sdk.search().performVoiceSearch()
|
||||
@@ -141,12 +140,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| models/errors/PerformVoiceSearchBadRequest | 400 | application/json |
|
||||
| models/errors/PerformVoiceSearchUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getSearchResults
|
||||
|
||||
@@ -169,11 +167,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetSearchResultsResponse res = sdk.search().getSearchResults()
|
||||
@@ -199,8 +197,8 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
|
||||
| models/errors/GetSearchResultsBadRequest | 400 | application/json |
|
||||
| models/errors/GetSearchResultsUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
@@ -39,11 +39,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||
@@ -62,12 +62,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
|
||||
| models/errors/GetServerCapabilitiesBadRequest | 400 | application/json |
|
||||
| models/errors/GetServerCapabilitiesUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getServerPreferences
|
||||
|
||||
@@ -90,11 +89,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetServerPreferencesResponse res = sdk.server().getServerPreferences()
|
||||
@@ -113,12 +112,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| models/errors/GetServerPreferencesBadRequest | 400 | application/json |
|
||||
| models/errors/GetServerPreferencesUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getAvailableClients
|
||||
|
||||
@@ -141,11 +139,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetAvailableClientsResponse res = sdk.server().getAvailableClients()
|
||||
@@ -164,12 +162,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
|
||||
| models/errors/GetAvailableClientsBadRequest | 400 | application/json |
|
||||
| models/errors/GetAvailableClientsUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getDevices
|
||||
|
||||
@@ -192,11 +189,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetDevicesResponse res = sdk.server().getDevices()
|
||||
@@ -215,12 +212,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||
| models/errors/GetDevicesBadRequest | 400 | application/json |
|
||||
| models/errors/GetDevicesUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getServerIdentity
|
||||
|
||||
@@ -241,11 +237,11 @@ public class Application {
|
||||
public static void main(String[] args) throws GetServerIdentityRequestTimeout, Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetServerIdentityResponse res = sdk.server().getServerIdentity()
|
||||
@@ -264,11 +260,10 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
|
||||
| models/errors/GetServerIdentityRequestTimeout | 408 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getMyPlexAccount
|
||||
|
||||
@@ -291,11 +286,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetMyPlexAccountResponse res = sdk.server().getMyPlexAccount()
|
||||
@@ -314,12 +309,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
|
||||
| models/errors/GetMyPlexAccountBadRequest | 400 | application/json |
|
||||
| models/errors/GetMyPlexAccountUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getResizedPhoto
|
||||
|
||||
@@ -346,11 +340,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetResizedPhotoRequest req = GetResizedPhotoRequest.builder()
|
||||
@@ -384,12 +378,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
|
||||
| models/errors/GetResizedPhotoBadRequest | 400 | application/json |
|
||||
| models/errors/GetResizedPhotoUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getMediaProviders
|
||||
|
||||
@@ -412,11 +405,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetMediaProvidersResponse res = sdk.server().getMediaProviders()
|
||||
@@ -433,8 +426,8 @@ public class Application {
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `xPlexToken` | *String* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| `xPlexToken` | *String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
|
||||
|
||||
### Response
|
||||
|
||||
@@ -442,12 +435,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
|
||||
| models/errors/GetMediaProvidersBadRequest | 400 | application/json |
|
||||
| models/errors/GetMediaProvidersUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getServerList
|
||||
|
||||
@@ -470,11 +462,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetServerListResponse res = sdk.server().getServerList()
|
||||
@@ -493,8 +485,8 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
|
||||
| models/errors/GetServerListBadRequest | 400 | application/json |
|
||||
| models/errors/GetServerListUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
@@ -34,11 +34,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetSessionsResponse res = sdk.sessions().getSessions()
|
||||
@@ -57,12 +57,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
|
||||
| models/errors/GetSessionsBadRequest | 400 | application/json |
|
||||
| models/errors/GetSessionsUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getSessionHistory
|
||||
|
||||
@@ -86,11 +85,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetSessionHistoryResponse res = sdk.sessions().getSessionHistory()
|
||||
@@ -123,12 +122,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
|
||||
| models/errors/GetSessionHistoryBadRequest | 400 | application/json |
|
||||
| models/errors/GetSessionHistoryUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getTranscodeSessions
|
||||
|
||||
@@ -151,11 +149,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetTranscodeSessionsResponse res = sdk.sessions().getTranscodeSessions()
|
||||
@@ -174,12 +172,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| models/errors/GetTranscodeSessionsBadRequest | 400 | application/json |
|
||||
| models/errors/GetTranscodeSessionsUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## stopTranscodeSession
|
||||
|
||||
@@ -202,11 +199,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
StopTranscodeSessionResponse res = sdk.sessions().stopTranscodeSession()
|
||||
@@ -230,8 +227,8 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| models/errors/StopTranscodeSessionBadRequest | 400 | application/json |
|
||||
| models/errors/StopTranscodeSessionUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
@@ -33,11 +33,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetStatisticsResponse res = sdk.statistics().getStatistics()
|
||||
@@ -63,12 +63,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
|
||||
| models/errors/GetStatisticsBadRequest | 400 | application/json |
|
||||
| models/errors/GetStatisticsUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getResourcesStatistics
|
||||
|
||||
@@ -91,11 +90,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetResourcesStatisticsResponse res = sdk.statistics().getResourcesStatistics()
|
||||
@@ -121,12 +120,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
|
||||
| models/errors/GetResourcesStatisticsBadRequest | 400 | application/json |
|
||||
| models/errors/GetResourcesStatisticsUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getBandwidthStatistics
|
||||
|
||||
@@ -149,11 +147,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetBandwidthStatisticsResponse res = sdk.statistics().getBandwidthStatistics()
|
||||
@@ -179,8 +177,8 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
|
||||
| models/errors/GetBandwidthStatisticsBadRequest | 400 | application/json |
|
||||
| models/errors/GetBandwidthStatisticsUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
@@ -34,11 +34,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetUpdateStatusResponse res = sdk.updater().getUpdateStatus()
|
||||
@@ -57,12 +57,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
|
||||
| models/errors/GetUpdateStatusBadRequest | 400 | application/json |
|
||||
| models/errors/GetUpdateStatusUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## checkForUpdates
|
||||
|
||||
@@ -86,11 +85,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
CheckForUpdatesResponse res = sdk.updater().checkForUpdates()
|
||||
@@ -114,12 +113,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
|
||||
| models/errors/CheckForUpdatesBadRequest | 400 | application/json |
|
||||
| models/errors/CheckForUpdatesUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## applyUpdates
|
||||
|
||||
@@ -145,11 +143,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
ApplyUpdatesResponse res = sdk.updater().applyUpdates()
|
||||
@@ -175,8 +173,8 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
||||
| models/errors/ApplyUpdatesBadRequest | 400 | application/json |
|
||||
| models/errors/ApplyUpdatesUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
@@ -34,11 +34,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetTimelineRequest req = GetTimelineRequest.builder()
|
||||
@@ -75,12 +75,11 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
|
||||
| models/errors/GetTimelineBadRequest | 400 | application/json |
|
||||
| models/errors/GetTimelineUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## startUniversalTranscode
|
||||
|
||||
@@ -104,11 +103,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
StartUniversalTranscodeRequest req = StartUniversalTranscodeRequest.builder()
|
||||
@@ -151,8 +150,8 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
|
||||
| models/errors/StartUniversalTranscodeBadRequest | 400 | application/json |
|
||||
| models/errors/StartUniversalTranscodeUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
@@ -33,11 +33,11 @@ public class Application {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.clientName("Plex for Roku")
|
||||
.clientVersion("2.4.1")
|
||||
.platform("Roku")
|
||||
.deviceNickname("Roku 3")
|
||||
.build();
|
||||
|
||||
GetWatchListRequest req = GetWatchListRequest.builder()
|
||||
@@ -71,8 +71,8 @@ public class Application {
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
||||
| models/errors/GetWatchListBadRequest | 400 | application/json |
|
||||
| models/errors/GetWatchListUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
@@ -601,11 +601,7 @@ public class Authentication implements
|
||||
_req.addHeader("Accept", "application/json")
|
||||
.addHeader("user-agent",
|
||||
SDKConfiguration.USER_AGENT);
|
||||
|
||||
_req.addQueryParams(Utils.getQueryParams(
|
||||
PostUsersSignInDataRequest.class,
|
||||
request,
|
||||
this.sdkConfiguration.globals));
|
||||
_req.addHeaders(Utils.getHeadersFromMetadata(request, this.sdkConfiguration.globals));
|
||||
|
||||
HTTPClient _client = this.sdkConfiguration.defaultClient;
|
||||
HttpRequest _r =
|
||||
|
||||
@@ -25,6 +25,8 @@ import dev.plexapi.sdk.models.errors.GetRecentlyAddedLibraryBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetRecentlyAddedLibraryUnauthorized;
|
||||
import dev.plexapi.sdk.models.errors.GetRefreshLibraryMetadataBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetRefreshLibraryMetadataUnauthorized;
|
||||
import dev.plexapi.sdk.models.errors.GetSearchAllLibrariesBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetSearchAllLibrariesUnauthorized;
|
||||
import dev.plexapi.sdk.models.errors.GetSearchLibraryBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetSearchLibraryUnauthorized;
|
||||
import dev.plexapi.sdk.models.errors.GetTopWatchedContentBadRequest;
|
||||
@@ -66,6 +68,10 @@ import dev.plexapi.sdk.models.operations.GetRecentlyAddedLibraryResponseBody;
|
||||
import dev.plexapi.sdk.models.operations.GetRefreshLibraryMetadataRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetRefreshLibraryMetadataRequestBuilder;
|
||||
import dev.plexapi.sdk.models.operations.GetRefreshLibraryMetadataResponse;
|
||||
import dev.plexapi.sdk.models.operations.GetSearchAllLibrariesRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetSearchAllLibrariesRequestBuilder;
|
||||
import dev.plexapi.sdk.models.operations.GetSearchAllLibrariesResponse;
|
||||
import dev.plexapi.sdk.models.operations.GetSearchAllLibrariesResponseBody;
|
||||
import dev.plexapi.sdk.models.operations.GetSearchLibraryQueryParamType;
|
||||
import dev.plexapi.sdk.models.operations.GetSearchLibraryRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetSearchLibraryRequestBuilder;
|
||||
@@ -107,6 +113,7 @@ public class Library implements
|
||||
MethodCallGetLibraryItems,
|
||||
MethodCallGetRefreshLibraryMetadata,
|
||||
MethodCallGetSearchLibrary,
|
||||
MethodCallGetSearchAllLibraries,
|
||||
MethodCallGetMetaDataByRatingKey,
|
||||
MethodCallGetMetadataChildren,
|
||||
MethodCallGetTopWatchedContent,
|
||||
@@ -696,7 +703,7 @@ public class Library implements
|
||||
*/
|
||||
public GetLibraryDetailsResponse getLibraryDetails(
|
||||
int sectionKey) throws Exception {
|
||||
return getLibraryDetails(sectionKey, Optional.empty());
|
||||
return getLibraryDetails(Optional.empty(), sectionKey);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -741,23 +748,23 @@ public class Library implements
|
||||
*
|
||||
* > **Note**: Filters and sorts are optional; without them, no filtering controls are rendered.
|
||||
*
|
||||
* @param sectionKey The unique key of the Plex library.
|
||||
Note: This is unique in the context of the Plex server.
|
||||
|
||||
* @param includeDetails Whether or not to include details for a section (types, filters, and sorts).
|
||||
Only exists for backwards compatibility, media providers other than the server libraries have it on always.
|
||||
|
||||
* @param sectionKey The unique key of the Plex library.
|
||||
Note: This is unique in the context of the Plex server.
|
||||
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
*/
|
||||
public GetLibraryDetailsResponse getLibraryDetails(
|
||||
int sectionKey,
|
||||
Optional<? extends IncludeDetails> includeDetails) throws Exception {
|
||||
Optional<? extends IncludeDetails> includeDetails,
|
||||
int sectionKey) throws Exception {
|
||||
GetLibraryDetailsRequest request =
|
||||
GetLibraryDetailsRequest
|
||||
.builder()
|
||||
.sectionKey(sectionKey)
|
||||
.includeDetails(includeDetails)
|
||||
.sectionKey(sectionKey)
|
||||
.build();
|
||||
|
||||
String _baseUrl = Utils.templateUrl(
|
||||
@@ -1264,28 +1271,28 @@ public class Library implements
|
||||
*/
|
||||
public GetRefreshLibraryMetadataResponse getRefreshLibraryMetadata(
|
||||
int sectionKey) throws Exception {
|
||||
return getRefreshLibraryMetadata(sectionKey, Optional.empty());
|
||||
return getRefreshLibraryMetadata(Optional.empty(), sectionKey);
|
||||
}
|
||||
|
||||
/**
|
||||
* Refresh Metadata Of The Library
|
||||
* This endpoint Refreshes all the Metadata of the library.
|
||||
*
|
||||
* @param force Force the refresh even if the library is already being refreshed.
|
||||
* @param sectionKey The unique key of the Plex library.
|
||||
Note: This is unique in the context of the Plex server.
|
||||
|
||||
* @param force Force the refresh even if the library is already being refreshed.
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
*/
|
||||
public GetRefreshLibraryMetadataResponse getRefreshLibraryMetadata(
|
||||
int sectionKey,
|
||||
Optional<? extends Force> force) throws Exception {
|
||||
Optional<? extends Force> force,
|
||||
int sectionKey) throws Exception {
|
||||
GetRefreshLibraryMetadataRequest request =
|
||||
GetRefreshLibraryMetadataRequest
|
||||
.builder()
|
||||
.sectionKey(sectionKey)
|
||||
.force(force)
|
||||
.sectionKey(sectionKey)
|
||||
.build();
|
||||
|
||||
String _baseUrl = Utils.templateUrl(
|
||||
@@ -1624,6 +1631,163 @@ public class Library implements
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Search All Libraries
|
||||
* Search the provided query across all library sections, or a single section, and return matches as hubs, split up by type.
|
||||
*
|
||||
* @return The call builder
|
||||
*/
|
||||
public GetSearchAllLibrariesRequestBuilder getSearchAllLibraries() {
|
||||
return new GetSearchAllLibrariesRequestBuilder(this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Search All Libraries
|
||||
* Search the provided query across all library sections, or a single section, and return matches as hubs, split up by type.
|
||||
*
|
||||
* @param request The request object containing all of the parameters for the API call.
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
*/
|
||||
public GetSearchAllLibrariesResponse getSearchAllLibraries(
|
||||
GetSearchAllLibrariesRequest request) throws Exception {
|
||||
String _baseUrl = Utils.templateUrl(
|
||||
this.sdkConfiguration.serverUrl, this.sdkConfiguration.getServerVariableDefaults());
|
||||
String _url = Utils.generateURL(
|
||||
_baseUrl,
|
||||
"/library/search");
|
||||
|
||||
HTTPRequest _req = new HTTPRequest(_url, "GET");
|
||||
_req.addHeader("Accept", "application/json")
|
||||
.addHeader("user-agent",
|
||||
SDKConfiguration.USER_AGENT);
|
||||
|
||||
_req.addQueryParams(Utils.getQueryParams(
|
||||
GetSearchAllLibrariesRequest.class,
|
||||
request,
|
||||
this.sdkConfiguration.globals));
|
||||
_req.addHeaders(Utils.getHeadersFromMetadata(request, this.sdkConfiguration.globals));
|
||||
|
||||
Utils.configureSecurity(_req,
|
||||
this.sdkConfiguration.securitySource.getSecurity());
|
||||
|
||||
HTTPClient _client = this.sdkConfiguration.defaultClient;
|
||||
HttpRequest _r =
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
"get-search-all-libraries",
|
||||
Optional.of(List.of()),
|
||||
sdkConfiguration.securitySource()),
|
||||
_req.build());
|
||||
HttpResponse<InputStream> _httpRes;
|
||||
try {
|
||||
_httpRes = _client.send(_r);
|
||||
if (Utils.statusCodeMatches(_httpRes.statusCode(), "400", "401", "4XX", "5XX")) {
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
"get-search-all-libraries",
|
||||
Optional.of(List.of()),
|
||||
sdkConfiguration.securitySource()),
|
||||
Optional.of(_httpRes),
|
||||
Optional.empty());
|
||||
} else {
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
"get-search-all-libraries",
|
||||
Optional.of(List.of()),
|
||||
sdkConfiguration.securitySource()),
|
||||
_httpRes);
|
||||
}
|
||||
} catch (Exception _e) {
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
"get-search-all-libraries",
|
||||
Optional.of(List.of()),
|
||||
sdkConfiguration.securitySource()),
|
||||
Optional.empty(),
|
||||
Optional.of(_e));
|
||||
}
|
||||
String _contentType = _httpRes
|
||||
.headers()
|
||||
.firstValue("Content-Type")
|
||||
.orElse("application/octet-stream");
|
||||
GetSearchAllLibrariesResponse.Builder _resBuilder =
|
||||
GetSearchAllLibrariesResponse
|
||||
.builder()
|
||||
.contentType(_contentType)
|
||||
.statusCode(_httpRes.statusCode())
|
||||
.rawResponse(_httpRes);
|
||||
|
||||
GetSearchAllLibrariesResponse _res = _resBuilder.build();
|
||||
|
||||
if (Utils.statusCodeMatches(_httpRes.statusCode(), "200")) {
|
||||
if (Utils.contentTypeMatches(_contentType, "application/json")) {
|
||||
GetSearchAllLibrariesResponseBody _out = Utils.mapper().readValue(
|
||||
Utils.toUtf8AndClose(_httpRes.body()),
|
||||
new TypeReference<GetSearchAllLibrariesResponseBody>() {});
|
||||
_res.withObject(Optional.ofNullable(_out));
|
||||
return _res;
|
||||
} else {
|
||||
throw new SDKError(
|
||||
_httpRes,
|
||||
_httpRes.statusCode(),
|
||||
"Unexpected content-type received: " + _contentType,
|
||||
Utils.extractByteArrayFromBody(_httpRes));
|
||||
}
|
||||
}
|
||||
if (Utils.statusCodeMatches(_httpRes.statusCode(), "400")) {
|
||||
if (Utils.contentTypeMatches(_contentType, "application/json")) {
|
||||
GetSearchAllLibrariesBadRequest _out = Utils.mapper().readValue(
|
||||
Utils.toUtf8AndClose(_httpRes.body()),
|
||||
new TypeReference<GetSearchAllLibrariesBadRequest>() {});
|
||||
_out.withRawResponse(Optional.ofNullable(_httpRes));
|
||||
|
||||
throw _out;
|
||||
} else {
|
||||
throw new SDKError(
|
||||
_httpRes,
|
||||
_httpRes.statusCode(),
|
||||
"Unexpected content-type received: " + _contentType,
|
||||
Utils.extractByteArrayFromBody(_httpRes));
|
||||
}
|
||||
}
|
||||
if (Utils.statusCodeMatches(_httpRes.statusCode(), "401")) {
|
||||
if (Utils.contentTypeMatches(_contentType, "application/json")) {
|
||||
GetSearchAllLibrariesUnauthorized _out = Utils.mapper().readValue(
|
||||
Utils.toUtf8AndClose(_httpRes.body()),
|
||||
new TypeReference<GetSearchAllLibrariesUnauthorized>() {});
|
||||
_out.withRawResponse(Optional.ofNullable(_httpRes));
|
||||
|
||||
throw _out;
|
||||
} else {
|
||||
throw new SDKError(
|
||||
_httpRes,
|
||||
_httpRes.statusCode(),
|
||||
"Unexpected content-type received: " + _contentType,
|
||||
Utils.extractByteArrayFromBody(_httpRes));
|
||||
}
|
||||
}
|
||||
if (Utils.statusCodeMatches(_httpRes.statusCode(), "4XX", "5XX")) {
|
||||
// no content
|
||||
throw new SDKError(
|
||||
_httpRes,
|
||||
_httpRes.statusCode(),
|
||||
"API error occurred",
|
||||
Utils.extractByteArrayFromBody(_httpRes));
|
||||
}
|
||||
throw new SDKError(
|
||||
_httpRes,
|
||||
_httpRes.statusCode(),
|
||||
"Unexpected status code received: " + _httpRes.statusCode(),
|
||||
Utils.extractByteArrayFromBody(_httpRes));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Get Metadata by RatingKey
|
||||
* This endpoint will return the metadata of a library item specified with the ratingKey.
|
||||
@@ -1990,13 +2154,15 @@ public class Library implements
|
||||
*/
|
||||
public GetTopWatchedContentResponse getTopWatchedContent(
|
||||
GetTopWatchedContentQueryParamType type) throws Exception {
|
||||
return getTopWatchedContent(type, Optional.empty());
|
||||
return getTopWatchedContent(Optional.empty(), type);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Top Watched Content
|
||||
* This endpoint will return the top watched content from libraries of a certain type
|
||||
*
|
||||
* @param includeGuids Adds the Guids object to the response
|
||||
|
||||
* @param type The type of media to retrieve.
|
||||
1 = movie
|
||||
2 = show
|
||||
@@ -2004,19 +2170,17 @@ public class Library implements
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
* @param includeGuids Adds the Guids object to the response
|
||||
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
*/
|
||||
public GetTopWatchedContentResponse getTopWatchedContent(
|
||||
GetTopWatchedContentQueryParamType type,
|
||||
Optional<Long> includeGuids) throws Exception {
|
||||
Optional<Long> includeGuids,
|
||||
GetTopWatchedContentQueryParamType type) throws Exception {
|
||||
GetTopWatchedContentRequest request =
|
||||
GetTopWatchedContentRequest
|
||||
.builder()
|
||||
.type(type)
|
||||
.includeGuids(includeGuids)
|
||||
.type(type)
|
||||
.build();
|
||||
|
||||
String _baseUrl = Utils.templateUrl(
|
||||
|
||||
@@ -554,6 +554,7 @@ public class Media implements
|
||||
GetBannerImageRequest.class,
|
||||
request,
|
||||
this.sdkConfiguration.globals));
|
||||
_req.addHeaders(Utils.getHeadersFromMetadata(request, this.sdkConfiguration.globals));
|
||||
|
||||
Utils.configureSecurity(_req,
|
||||
this.sdkConfiguration.securitySource.getSecurity());
|
||||
@@ -710,6 +711,7 @@ public class Media implements
|
||||
GetThumbImageRequest.class,
|
||||
request,
|
||||
this.sdkConfiguration.globals));
|
||||
_req.addHeaders(Utils.getHeadersFromMetadata(request, this.sdkConfiguration.globals));
|
||||
|
||||
Utils.configureSecurity(_req,
|
||||
this.sdkConfiguration.securitySource.getSecurity());
|
||||
|
||||
@@ -778,10 +778,7 @@ public class Plex implements
|
||||
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
|
||||
|
||||
* @param includeIPv6 Include IPv6 entries in the results
|
||||
* @param clientID The unique identifier for the client application
|
||||
This is used to track the client application and its usage
|
||||
(UUID, serial number, or other number unique per device)
|
||||
|
||||
* @param clientID An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
|
||||
* @param serverURL Overrides the server URL.
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
@@ -818,6 +815,7 @@ public class Plex implements
|
||||
GetServerResourcesRequest.class,
|
||||
request,
|
||||
this.sdkConfiguration.globals));
|
||||
_req.addHeaders(Utils.getHeadersFromMetadata(request, this.sdkConfiguration.globals));
|
||||
|
||||
Utils.configureSecurity(_req,
|
||||
this.sdkConfiguration.securitySource.getSecurity());
|
||||
@@ -988,6 +986,7 @@ public class Plex implements
|
||||
GetPinRequest.class,
|
||||
request,
|
||||
this.sdkConfiguration.globals));
|
||||
_req.addHeaders(Utils.getHeadersFromMetadata(request, this.sdkConfiguration.globals));
|
||||
|
||||
HTTPClient _client = this.sdkConfiguration.defaultClient;
|
||||
HttpRequest _r =
|
||||
@@ -1136,11 +1135,7 @@ public class Plex implements
|
||||
_req.addHeader("Accept", "application/json")
|
||||
.addHeader("user-agent",
|
||||
SDKConfiguration.USER_AGENT);
|
||||
|
||||
_req.addQueryParams(Utils.getQueryParams(
|
||||
GetTokenByPinIdRequest.class,
|
||||
request,
|
||||
this.sdkConfiguration.globals));
|
||||
_req.addHeaders(Utils.getHeadersFromMetadata(request, this.sdkConfiguration.globals));
|
||||
|
||||
HTTPClient _client = this.sdkConfiguration.defaultClient;
|
||||
HttpRequest _r =
|
||||
|
||||
@@ -465,11 +465,11 @@ public class PlexAPI {
|
||||
* @return The builder instance.
|
||||
*/
|
||||
public Builder clientID(String clientID) {
|
||||
if (!this.sdkConfiguration.globals.get("parameters").containsKey("queryParam")) {
|
||||
this.sdkConfiguration.globals.get("parameters").put("queryParam", new java.util.HashMap<>());
|
||||
if (!this.sdkConfiguration.globals.get("parameters").containsKey("header")) {
|
||||
this.sdkConfiguration.globals.get("parameters").put("header", new java.util.HashMap<>());
|
||||
}
|
||||
|
||||
this.sdkConfiguration.globals.get("parameters").get("queryParam").put("clientID", clientID);
|
||||
this.sdkConfiguration.globals.get("parameters").get("header").put("clientID", clientID);
|
||||
|
||||
return this;
|
||||
}
|
||||
@@ -481,11 +481,11 @@ public class PlexAPI {
|
||||
* @return The builder instance.
|
||||
*/
|
||||
public Builder clientName(String clientName) {
|
||||
if (!this.sdkConfiguration.globals.get("parameters").containsKey("queryParam")) {
|
||||
this.sdkConfiguration.globals.get("parameters").put("queryParam", new java.util.HashMap<>());
|
||||
if (!this.sdkConfiguration.globals.get("parameters").containsKey("header")) {
|
||||
this.sdkConfiguration.globals.get("parameters").put("header", new java.util.HashMap<>());
|
||||
}
|
||||
|
||||
this.sdkConfiguration.globals.get("parameters").get("queryParam").put("clientName", clientName);
|
||||
this.sdkConfiguration.globals.get("parameters").get("header").put("clientName", clientName);
|
||||
|
||||
return this;
|
||||
}
|
||||
@@ -497,43 +497,43 @@ public class PlexAPI {
|
||||
* @return The builder instance.
|
||||
*/
|
||||
public Builder clientVersion(String clientVersion) {
|
||||
if (!this.sdkConfiguration.globals.get("parameters").containsKey("queryParam")) {
|
||||
this.sdkConfiguration.globals.get("parameters").put("queryParam", new java.util.HashMap<>());
|
||||
if (!this.sdkConfiguration.globals.get("parameters").containsKey("header")) {
|
||||
this.sdkConfiguration.globals.get("parameters").put("header", new java.util.HashMap<>());
|
||||
}
|
||||
|
||||
this.sdkConfiguration.globals.get("parameters").get("queryParam").put("clientVersion", clientVersion);
|
||||
this.sdkConfiguration.globals.get("parameters").get("header").put("clientVersion", clientVersion);
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Allows setting the clientPlatform parameter for all supported operations.
|
||||
* Allows setting the platform parameter for all supported operations.
|
||||
*
|
||||
* @param clientPlatform The value to set.
|
||||
* @param platform The value to set.
|
||||
* @return The builder instance.
|
||||
*/
|
||||
public Builder clientPlatform(String clientPlatform) {
|
||||
if (!this.sdkConfiguration.globals.get("parameters").containsKey("queryParam")) {
|
||||
this.sdkConfiguration.globals.get("parameters").put("queryParam", new java.util.HashMap<>());
|
||||
public Builder platform(String platform) {
|
||||
if (!this.sdkConfiguration.globals.get("parameters").containsKey("header")) {
|
||||
this.sdkConfiguration.globals.get("parameters").put("header", new java.util.HashMap<>());
|
||||
}
|
||||
|
||||
this.sdkConfiguration.globals.get("parameters").get("queryParam").put("clientPlatform", clientPlatform);
|
||||
this.sdkConfiguration.globals.get("parameters").get("header").put("platform", platform);
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Allows setting the deviceName parameter for all supported operations.
|
||||
* Allows setting the deviceNickname parameter for all supported operations.
|
||||
*
|
||||
* @param deviceName The value to set.
|
||||
* @param deviceNickname The value to set.
|
||||
* @return The builder instance.
|
||||
*/
|
||||
public Builder deviceName(String deviceName) {
|
||||
if (!this.sdkConfiguration.globals.get("parameters").containsKey("queryParam")) {
|
||||
this.sdkConfiguration.globals.get("parameters").put("queryParam", new java.util.HashMap<>());
|
||||
public Builder deviceNickname(String deviceNickname) {
|
||||
if (!this.sdkConfiguration.globals.get("parameters").containsKey("header")) {
|
||||
this.sdkConfiguration.globals.get("parameters").put("header", new java.util.HashMap<>());
|
||||
}
|
||||
|
||||
this.sdkConfiguration.globals.get("parameters").get("queryParam").put("deviceName", deviceName);
|
||||
this.sdkConfiguration.globals.get("parameters").get("header").put("deviceNickname", deviceNickname);
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
@@ -36,8 +36,8 @@ class SDKConfiguration {
|
||||
} };
|
||||
private static final String LANGUAGE = "java";
|
||||
public static final String OPENAPI_DOC_VERSION = "0.0.3";
|
||||
public static final String SDK_VERSION = "0.6.2";
|
||||
public static final String GEN_VERSION = "2.426.2";
|
||||
public static final String SDK_VERSION = "0.9.0";
|
||||
public static final String GEN_VERSION = "2.429.0";
|
||||
private static final String BASE_PACKAGE = "dev.plexapi.sdk";
|
||||
public static final String USER_AGENT =
|
||||
String.format("speakeasy-sdk/%s %s %s %s %s",
|
||||
|
||||
@@ -1108,7 +1108,7 @@ public class Server implements
|
||||
/**
|
||||
* Get Media Providers
|
||||
* Retrieves media providers and their features from the Plex server.
|
||||
* @param xPlexToken Plex Authentication Token
|
||||
* @param xPlexToken An authentication token, obtained from plex.tv
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
*/
|
||||
@@ -1130,11 +1130,7 @@ public class Server implements
|
||||
_req.addHeader("Accept", "application/json")
|
||||
.addHeader("user-agent",
|
||||
SDKConfiguration.USER_AGENT);
|
||||
|
||||
_req.addQueryParams(Utils.getQueryParams(
|
||||
GetMediaProvidersRequest.class,
|
||||
request,
|
||||
this.sdkConfiguration.globals));
|
||||
_req.addHeaders(Utils.getHeadersFromMetadata(request, this.sdkConfiguration.globals));
|
||||
|
||||
Utils.configureSecurity(_req,
|
||||
this.sdkConfiguration.securitySource.getSecurity());
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user