mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 12:37:47 +00:00
Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
1e29008284 | ||
|
|
66d8250cb0 |
File diff suppressed because one or more lines are too long
@@ -21,8 +21,11 @@ generation:
|
||||
generateTests: true
|
||||
generateNewTests: false
|
||||
skipResponseBodyAssertions: false
|
||||
requestBodyFieldName: ""
|
||||
schemas:
|
||||
allOfMergeStrategy: shallowMerge
|
||||
java:
|
||||
version: 0.20.1
|
||||
version: 0.22.1
|
||||
additionalDependencies: []
|
||||
additionalPlugins: []
|
||||
artifactID: plexapi
|
||||
@@ -34,8 +37,10 @@ java:
|
||||
companyURL: plexapi.dev
|
||||
defaultErrorName: SDKError
|
||||
enableCustomCodeRegions: false
|
||||
enableSlf4jLogging: false
|
||||
enableStreamingUploads: false
|
||||
flattenGlobalSecurity: true
|
||||
generateOptionalUnionAccessors: false
|
||||
generateSpringBootStarter: true
|
||||
githubURL: github.com/LukeHagar/plexjava
|
||||
groupID: dev.plexapi
|
||||
@@ -47,6 +52,7 @@ java:
|
||||
operations: models/operations
|
||||
shared: models/shared
|
||||
webhooks: models/webhooks
|
||||
inferUnionDiscriminators: false
|
||||
inputModelSuffix: input
|
||||
languageVersion: 11
|
||||
license:
|
||||
@@ -54,8 +60,12 @@ java:
|
||||
shortName: MIT
|
||||
url: https://mit-license.org/
|
||||
maxMethodParams: 4
|
||||
multipartArrayFormat: legacy
|
||||
nullFriendlyParameters: false
|
||||
openUnions: true
|
||||
operationScopedParams: true
|
||||
outputModelSuffix: output
|
||||
packageName: dev.plexapi.sdk
|
||||
projectName: plexapi
|
||||
templateVersion: v2
|
||||
unionStrategy: populated-fields
|
||||
|
||||
@@ -8,20 +8,20 @@ sources:
|
||||
- latest
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:0e9f7ca03e6a970d7b77654ab41d0a1605f0105871db2630a7afc85d4362b624
|
||||
sourceBlobDigest: sha256:c0a6079f21e9d8cf8b3a205d2da333b78b2cb7e0db9dd895a41c68c2580e2d64
|
||||
sourceRevisionDigest: sha256:ace004a3b232e8ab9ca3d89f2da8e40470236e6d997073a16c3f8872d67a7383
|
||||
sourceBlobDigest: sha256:993bfb796a3833b0a3b813ad12469ca34db94f23c2d15ae988a26b4d1ed80fbe
|
||||
tags:
|
||||
- latest
|
||||
- speakeasy-sdk-regen-1760315484
|
||||
- speakeasy-sdk-regen-1764549498
|
||||
- 1.1.1
|
||||
targets:
|
||||
plexjava:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:0e9f7ca03e6a970d7b77654ab41d0a1605f0105871db2630a7afc85d4362b624
|
||||
sourceBlobDigest: sha256:c0a6079f21e9d8cf8b3a205d2da333b78b2cb7e0db9dd895a41c68c2580e2d64
|
||||
sourceRevisionDigest: sha256:ace004a3b232e8ab9ca3d89f2da8e40470236e6d997073a16c3f8872d67a7383
|
||||
sourceBlobDigest: sha256:993bfb796a3833b0a3b813ad12469ca34db94f23c2d15ae988a26b4d1ed80fbe
|
||||
codeSamplesNamespace: code-samples-java-plexjava
|
||||
codeSamplesRevisionDigest: sha256:e076772184b6e43037b79abcef938bd0dd86905117a8634a7ed733736455b55e
|
||||
codeSamplesRevisionDigest: sha256:52ac94e7425f56352fc8c1cd029b144b79fa5a60027f1960b2d1ce83fa27701b
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
|
||||
260
README.md
260
README.md
@@ -25,6 +25,7 @@
|
||||
* [Server Selection](#server-selection)
|
||||
* [Asynchronous Support](#asynchronous-support)
|
||||
* [Authentication](#authentication)
|
||||
* [Custom HTTP Client](#custom-http-client)
|
||||
* [Debugging](#debugging)
|
||||
* [Development](#development)
|
||||
* [Maturity](#maturity)
|
||||
@@ -43,7 +44,7 @@ The samples below show how a published SDK artifact is used:
|
||||
|
||||
Gradle:
|
||||
```groovy
|
||||
implementation 'dev.plexapi:plexapi:0.20.1'
|
||||
implementation 'dev.plexapi:plexapi:0.22.1'
|
||||
```
|
||||
|
||||
Maven:
|
||||
@@ -51,7 +52,7 @@ Maven:
|
||||
<dependency>
|
||||
<groupId>dev.plexapi</groupId>
|
||||
<artifactId>plexapi</artifactId>
|
||||
<version>0.20.1</version>
|
||||
<version>0.22.1</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
@@ -108,13 +109,13 @@ public class Application {
|
||||
.advancedSubtitles(AdvancedSubtitles.BURN)
|
||||
.audioBoost(50L)
|
||||
.audioChannelCount(5L)
|
||||
.autoAdjustQuality(BoolInt.ONE)
|
||||
.autoAdjustSubtitle(BoolInt.ONE)
|
||||
.directPlay(BoolInt.ONE)
|
||||
.directStream(BoolInt.ONE)
|
||||
.directStreamAudio(BoolInt.ONE)
|
||||
.disableResolutionRotation(BoolInt.ONE)
|
||||
.hasMDE(BoolInt.ONE)
|
||||
.autoAdjustQuality(BoolInt.True)
|
||||
.autoAdjustSubtitle(BoolInt.True)
|
||||
.directPlay(BoolInt.True)
|
||||
.directStream(BoolInt.True)
|
||||
.directStreamAudio(BoolInt.True)
|
||||
.disableResolutionRotation(BoolInt.True)
|
||||
.hasMDE(BoolInt.True)
|
||||
.location(StartTranscodeSessionQueryParamLocation.WAN)
|
||||
.mediaBufferSize(102400L)
|
||||
.mediaIndex(0L)
|
||||
@@ -206,6 +207,11 @@ public class Application {
|
||||
* [listActivities](docs/sdks/activities/README.md#listactivities) - Get all activities
|
||||
* [cancelActivity](docs/sdks/activities/README.md#cancelactivity) - Cancel a running activity
|
||||
|
||||
### [authentication()](docs/sdks/authentication/README.md)
|
||||
|
||||
* [getTokenDetails](docs/sdks/authentication/README.md#gettokendetails) - Get Token Details
|
||||
* [postUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata) - Get User Sign In Data
|
||||
|
||||
### [butler()](docs/sdks/butler/README.md)
|
||||
|
||||
* [stopTasks](docs/sdks/butler/README.md#stoptasks) - Stop all Butler tasks
|
||||
@@ -452,6 +458,10 @@ public class Application {
|
||||
* [deletePlayQueueItem](docs/sdks/playqueue/README.md#deleteplayqueueitem) - Delete an item from a play queue
|
||||
* [movePlayQueueItem](docs/sdks/playqueue/README.md#moveplayqueueitem) - Move an item in a play queue
|
||||
|
||||
### [plex()](docs/sdks/plex/README.md)
|
||||
|
||||
* [getServerResources](docs/sdks/plex/README.md#getserverresources) - Get Server Resources
|
||||
|
||||
|
||||
### [preferences()](docs/sdks/preferences/README.md)
|
||||
|
||||
@@ -522,6 +532,10 @@ public class Application {
|
||||
* [checkUpdates](docs/sdks/updater/README.md#checkupdates) - Checking for updates
|
||||
* [getUpdatesStatus](docs/sdks/updater/README.md#getupdatesstatus) - Querying status of updates
|
||||
|
||||
### [users()](docs/sdks/users/README.md)
|
||||
|
||||
* [getUsers](docs/sdks/users/README.md#getusers) - Get list of all connected users
|
||||
|
||||
</details>
|
||||
<!-- End Available Resources and Operations [operations] -->
|
||||
|
||||
@@ -530,11 +544,13 @@ public class Application {
|
||||
|
||||
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
|
||||
|
||||
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 `getServerInfo` method throws the following exceptions:
|
||||
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 `getTokenDetails` method throws the following exceptions:
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------- | ----------- | ------------ |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------- | ----------- | ---------------- |
|
||||
| models/errors/GetTokenDetailsBadRequest | 400 | application/json |
|
||||
| models/errors/GetTokenDetailsUnauthorized | 401 | application/json |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -542,14 +558,16 @@ By default, an API error will throw a `models/errors/SDKError` exception. When c
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.operations.GetServerInfoRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetServerInfoResponse;
|
||||
import dev.plexapi.sdk.models.errors.GetTokenDetailsBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetTokenDetailsUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetTokenDetailsRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetTokenDetailsResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) throws Exception {
|
||||
public static void main(String[] args) throws GetTokenDetailsBadRequest, GetTokenDetailsUnauthorized, Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accepts(Accepts.APPLICATION_XML)
|
||||
@@ -566,14 +584,14 @@ public class Application {
|
||||
.token(System.getenv().getOrDefault("TOKEN", ""))
|
||||
.build();
|
||||
|
||||
GetServerInfoRequest req = GetServerInfoRequest.builder()
|
||||
GetTokenDetailsRequest req = GetTokenDetailsRequest.builder()
|
||||
.build();
|
||||
|
||||
GetServerInfoResponse res = sdk.general().getServerInfo()
|
||||
GetTokenDetailsResponse res = sdk.authentication().getTokenDetails()
|
||||
.request(req)
|
||||
.call();
|
||||
|
||||
if (res.mediaContainerWithDirectory().isPresent()) {
|
||||
if (res.userPlexAccount().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
@@ -592,18 +610,18 @@ You can override the default server globally using the `.serverIndex(int serverI
|
||||
| --- | ---------------------------------------------------------- | -------------------------------------------- | ----------- |
|
||||
| 0 | `https://{IP-description}.{identifier}.plex.direct:{port}` | `identifier`<br/>`IP-description`<br/>`port` | |
|
||||
| 1 | `{protocol}://{host}:{port}` | `protocol`<br/>`host`<br/>`port` | |
|
||||
| 2 | `https://{full_server_url}` | `server_url` | |
|
||||
| 2 | `https://{full_server_url}` | `full_server_url` | |
|
||||
|
||||
If the selected server has variables, you may override its default values using the associated builder method(s):
|
||||
|
||||
| Variable | BuilderMethod | Default | Description |
|
||||
| ---------------- | ------------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `identifier` | `identifier(String identifier)` | `"0123456789abcdef0123456789abcdef"` | The unique identifier of this particular PMS |
|
||||
| `IP-description` | `ipDescription(String ipDescription)` | `"1-2-3-4"` | A `-` separated string of the IPv4 or IPv6 address components |
|
||||
| `port` | `port(String port)` | `"32400"` | The Port number configured on the PMS. Typically (`32400`). <br/>If using a reverse proxy, this would be the port number configured on the proxy.<br/> |
|
||||
| `protocol` | `protocol(String protocol)` | `"http"` | The network protocol to use. Typically (`http` or `https`) |
|
||||
| `host` | `host(String host)` | `"localhost"` | The Host of the PMS.<br/>If using on a local network, this is the internal IP address of the server hosting the PMS.<br/>If using on an external network, this is the external IP address for your network, and requires port forwarding.<br/>If using a reverse proxy, this would be the external DNS domain for your network, and requires the proxy handle port forwarding. <br/> |
|
||||
| `server_url` | `serverUrl(String serverUrl)` | `"http://localhost:32400"` | The full manual URL to access the PMS |
|
||||
| Variable | BuilderMethod | Default | Description |
|
||||
| ----------------- | ------------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `identifier` | `identifier(String identifier)` | `"0123456789abcdef0123456789abcdef"` | The unique identifier of this particular PMS |
|
||||
| `IP-description` | `ipDescription(String ipDescription)` | `"1-2-3-4"` | A `-` separated string of the IPv4 or IPv6 address components |
|
||||
| `port` | `port(String port)` | `"32400"` | The Port number configured on the PMS. Typically (`32400`). <br/>If using a reverse proxy, this would be the port number configured on the proxy.<br/> |
|
||||
| `protocol` | `protocol(String protocol)` | `"http"` | The network protocol to use. Typically (`http` or `https`) |
|
||||
| `host` | `host(String host)` | `"localhost"` | The Host of the PMS.<br/>If using on a local network, this is the internal IP address of the server hosting the PMS.<br/>If using on an external network, this is the external IP address for your network, and requires port forwarding.<br/>If using a reverse proxy, this would be the external DNS domain for your network, and requires the proxy handle port forwarding. <br/> |
|
||||
| `full_server_url` | `fullServerUrl(String fullServerUrl)` | `"http://localhost:32400"` | The full manual URL to access the PMS |
|
||||
|
||||
#### Example
|
||||
|
||||
@@ -670,7 +688,7 @@ public class Application {
|
||||
public static void main(String[] args) throws Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.serverURL("https://{full_server_url}")
|
||||
.serverURL("https://http://localhost:32400")
|
||||
.accepts(Accepts.APPLICATION_XML)
|
||||
.clientIdentifier("abc123")
|
||||
.product("Plex for Roku")
|
||||
@@ -698,6 +716,54 @@ public class Application {
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Override Server URL Per-Operation
|
||||
|
||||
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
|
||||
```java
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetTokenDetailsBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetTokenDetailsUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetTokenDetailsRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetTokenDetailsResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) throws GetTokenDetailsBadRequest, GetTokenDetailsUnauthorized, Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accepts(Accepts.APPLICATION_XML)
|
||||
.clientIdentifier("abc123")
|
||||
.product("Plex for Roku")
|
||||
.version("2.4.1")
|
||||
.platform("Roku")
|
||||
.platformVersion("4.3 build 1057")
|
||||
.device("Roku 3")
|
||||
.model("4200X")
|
||||
.deviceVendor("Roku")
|
||||
.deviceName("Living Room TV")
|
||||
.marketplace("googlePlay")
|
||||
.token(System.getenv().getOrDefault("TOKEN", ""))
|
||||
.build();
|
||||
|
||||
GetTokenDetailsRequest req = GetTokenDetailsRequest.builder()
|
||||
.build();
|
||||
|
||||
GetTokenDetailsResponse res = sdk.authentication().getTokenDetails()
|
||||
.request(req)
|
||||
.serverURL("https://plex.tv/api/v2")
|
||||
.call();
|
||||
|
||||
if (res.userPlexAccount().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
<!-- End Server Selection [server] -->
|
||||
|
||||
<!-- Start Asynchronous Support [async-support] -->
|
||||
@@ -821,6 +887,142 @@ public class Application {
|
||||
```
|
||||
<!-- End Authentication [security] -->
|
||||
|
||||
<!-- Start Custom HTTP Client [http-client] -->
|
||||
## Custom HTTP Client
|
||||
|
||||
The Java SDK makes API calls using an `HTTPClient` that wraps the native
|
||||
[HttpClient](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpClient.html). This
|
||||
client provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle
|
||||
errors and response.
|
||||
|
||||
The `HTTPClient` interface allows you to either use the default `SpeakeasyHTTPClient` that comes with the SDK,
|
||||
or provide your own custom implementation with customized configuration such as custom executors, SSL context,
|
||||
connection pools, and other HTTP client settings.
|
||||
|
||||
The interface provides synchronous (`send`) methods and asynchronous (`sendAsync`) methods. The `sendAsync` method
|
||||
is used to power the async SDK methods and returns a `CompletableFuture<HttpResponse<Blob>>` for non-blocking operations.
|
||||
|
||||
The following example shows how to add a custom header and handle errors:
|
||||
|
||||
```java
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.utils.HTTPClient;
|
||||
import dev.plexapi.sdk.utils.SpeakeasyHTTPClient;
|
||||
import dev.plexapi.sdk.utils.Utils;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.net.URISyntaxException;
|
||||
import java.net.http.HttpRequest;
|
||||
import java.net.http.HttpResponse;
|
||||
import java.io.InputStream;
|
||||
import java.time.Duration;
|
||||
|
||||
public class Application {
|
||||
public static void main(String[] args) {
|
||||
// Create a custom HTTP client with hooks
|
||||
HTTPClient httpClient = new HTTPClient() {
|
||||
private final HTTPClient defaultClient = new SpeakeasyHTTPClient();
|
||||
|
||||
@Override
|
||||
public HttpResponse<InputStream> send(HttpRequest request) throws IOException, URISyntaxException, InterruptedException {
|
||||
// Add custom header and timeout using Utils.copy()
|
||||
HttpRequest modifiedRequest = Utils.copy(request)
|
||||
.header("x-custom-header", "custom value")
|
||||
.timeout(Duration.ofSeconds(30))
|
||||
.build();
|
||||
|
||||
try {
|
||||
HttpResponse<InputStream> response = defaultClient.send(modifiedRequest);
|
||||
// Log successful response
|
||||
System.out.println("Request successful: " + response.statusCode());
|
||||
return response;
|
||||
} catch (Exception error) {
|
||||
// Log error
|
||||
System.err.println("Request failed: " + error.getMessage());
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.client(httpClient)
|
||||
.build();
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>Custom HTTP Client Configuration</summary>
|
||||
|
||||
You can also provide a completely custom HTTP client with your own configuration:
|
||||
|
||||
```java
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.utils.HTTPClient;
|
||||
import dev.plexapi.sdk.utils.Blob;
|
||||
import dev.plexapi.sdk.utils.ResponseWithBody;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.net.URISyntaxException;
|
||||
import java.net.http.HttpClient;
|
||||
import java.net.http.HttpRequest;
|
||||
import java.net.http.HttpResponse;
|
||||
import java.io.InputStream;
|
||||
import java.time.Duration;
|
||||
import java.util.concurrent.Executors;
|
||||
import java.util.concurrent.CompletableFuture;
|
||||
|
||||
public class Application {
|
||||
public static void main(String[] args) {
|
||||
// Custom HTTP client with custom configuration
|
||||
HTTPClient customHttpClient = new HTTPClient() {
|
||||
private final HttpClient client = HttpClient.newBuilder()
|
||||
.executor(Executors.newFixedThreadPool(10))
|
||||
.connectTimeout(Duration.ofSeconds(30))
|
||||
// .sslContext(customSslContext) // Add custom SSL context if needed
|
||||
.build();
|
||||
|
||||
@Override
|
||||
public HttpResponse<InputStream> send(HttpRequest request) throws IOException, URISyntaxException, InterruptedException {
|
||||
return client.send(request, HttpResponse.BodyHandlers.ofInputStream());
|
||||
}
|
||||
|
||||
@Override
|
||||
public CompletableFuture<HttpResponse<Blob>> sendAsync(HttpRequest request) {
|
||||
// Convert response to HttpResponse<Blob> for async operations
|
||||
return client.sendAsync(request, HttpResponse.BodyHandlers.ofPublisher())
|
||||
.thenApply(resp -> new ResponseWithBody<>(resp, Blob::from));
|
||||
}
|
||||
};
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.client(customHttpClient)
|
||||
.build();
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
You can also enable debug logging on the default `SpeakeasyHTTPClient`:
|
||||
|
||||
```java
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.utils.SpeakeasyHTTPClient;
|
||||
|
||||
public class Application {
|
||||
public static void main(String[] args) {
|
||||
SpeakeasyHTTPClient httpClient = new SpeakeasyHTTPClient();
|
||||
httpClient.enableDebugLogging(true);
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.client(httpClient)
|
||||
.build();
|
||||
}
|
||||
}
|
||||
```
|
||||
<!-- End Custom HTTP Client [http-client] -->
|
||||
|
||||
<!-- Start Debugging [debug] -->
|
||||
## Debugging
|
||||
|
||||
|
||||
22
RELEASES.md
22
RELEASES.md
@@ -398,4 +398,24 @@ Based on:
|
||||
### Generated
|
||||
- [java v0.20.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.20.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.20.1 - .
|
||||
- [Maven Central v0.20.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.20.1 - .
|
||||
|
||||
## 2025-11-13 00:30:34
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.615.2 (2.698.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.21.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.21.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.21.1 - .
|
||||
|
||||
## 2025-12-01 00:37:57
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.615.2 (2.698.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.22.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.22.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.22.1 - .
|
||||
14
USAGE.md
14
USAGE.md
@@ -32,13 +32,13 @@ public class Application {
|
||||
.advancedSubtitles(AdvancedSubtitles.BURN)
|
||||
.audioBoost(50L)
|
||||
.audioChannelCount(5L)
|
||||
.autoAdjustQuality(BoolInt.ONE)
|
||||
.autoAdjustSubtitle(BoolInt.ONE)
|
||||
.directPlay(BoolInt.ONE)
|
||||
.directStream(BoolInt.ONE)
|
||||
.directStreamAudio(BoolInt.ONE)
|
||||
.disableResolutionRotation(BoolInt.ONE)
|
||||
.hasMDE(BoolInt.ONE)
|
||||
.autoAdjustQuality(BoolInt.True)
|
||||
.autoAdjustSubtitle(BoolInt.True)
|
||||
.directPlay(BoolInt.True)
|
||||
.directStream(BoolInt.True)
|
||||
.directStreamAudio(BoolInt.True)
|
||||
.disableResolutionRotation(BoolInt.True)
|
||||
.hasMDE(BoolInt.True)
|
||||
.location(StartTranscodeSessionQueryParamLocation.WAN)
|
||||
.mediaBufferSize(102400L)
|
||||
.mediaIndex(0L)
|
||||
|
||||
@@ -105,7 +105,7 @@ publishing {
|
||||
// https://github.com/gradle/gradle/issues/18619
|
||||
groupId = "dev.plexapi"
|
||||
artifactId = "plexapi"
|
||||
version = "0.20.1"
|
||||
version = "0.22.1"
|
||||
|
||||
from components.java
|
||||
|
||||
|
||||
458
codeSamples.yaml
458
codeSamples.yaml
@@ -340,9 +340,9 @@ actions:
|
||||
.playQueueItemID("123")
|
||||
.time(0L)
|
||||
.duration(10000L)
|
||||
.continuing(BoolInt.ONE)
|
||||
.continuing(BoolInt.True)
|
||||
.updated(14200000L)
|
||||
.offline(BoolInt.ONE)
|
||||
.offline(BoolInt.True)
|
||||
.timeToFirstFrame(1000L)
|
||||
.timeStalled(1000L)
|
||||
.bandwidth(100L)
|
||||
@@ -600,7 +600,7 @@ actions:
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
- target: $["paths"]["/butler/{task}"]["delete"]
|
||||
- target: $["paths"]["/butler/{butlerTask}"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: java
|
||||
@@ -633,7 +633,7 @@ actions:
|
||||
.build();
|
||||
|
||||
StopTaskRequest req = StopTaskRequest.builder()
|
||||
.task(Task.CLEAN_OLD_BUNDLES)
|
||||
.butlerTask(ButlerTask.CLEAN_OLD_BUNDLES)
|
||||
.build();
|
||||
|
||||
StopTaskResponse res = sdk.butler().stopTask()
|
||||
@@ -643,7 +643,7 @@ actions:
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
- target: $["paths"]["/butler/{task}"]["post"]
|
||||
- target: $["paths"]["/butler/{butlerTask}"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: java
|
||||
@@ -676,7 +676,7 @@ actions:
|
||||
.build();
|
||||
|
||||
StartTaskRequest req = StartTaskRequest.builder()
|
||||
.task(PathParamTask.REFRESH_LOCAL_MEDIA)
|
||||
.butlerTask(PathParamButlerTask.REFRESH_LOCAL_MEDIA)
|
||||
.build();
|
||||
|
||||
StartTaskResponse res = sdk.butler().startTask()
|
||||
@@ -802,13 +802,13 @@ actions:
|
||||
.advancedSubtitles(AdvancedSubtitles.BURN)
|
||||
.audioBoost(50L)
|
||||
.audioChannelCount(5L)
|
||||
.autoAdjustQuality(BoolInt.ONE)
|
||||
.autoAdjustSubtitle(BoolInt.ONE)
|
||||
.directPlay(BoolInt.ONE)
|
||||
.directStream(BoolInt.ONE)
|
||||
.directStreamAudio(BoolInt.ONE)
|
||||
.disableResolutionRotation(BoolInt.ONE)
|
||||
.hasMDE(BoolInt.ONE)
|
||||
.autoAdjustQuality(BoolInt.True)
|
||||
.autoAdjustSubtitle(BoolInt.True)
|
||||
.directPlay(BoolInt.True)
|
||||
.directStream(BoolInt.True)
|
||||
.directStreamAudio(BoolInt.True)
|
||||
.disableResolutionRotation(BoolInt.True)
|
||||
.hasMDE(BoolInt.True)
|
||||
.location(Location.WAN)
|
||||
.mediaBufferSize(102400L)
|
||||
.mediaIndex(0L)
|
||||
@@ -1157,7 +1157,7 @@ actions:
|
||||
.build();
|
||||
|
||||
GetAllHubsRequest req = GetAllHubsRequest.builder()
|
||||
.onlyTransient(BoolInt.ONE)
|
||||
.onlyTransient(BoolInt.True)
|
||||
.build();
|
||||
|
||||
GetAllHubsResponse res = sdk.hubs().getAllHubs()
|
||||
@@ -1300,7 +1300,7 @@ actions:
|
||||
|
||||
GetMetadataHubsRequest req = GetMetadataHubsRequest.builder()
|
||||
.metadataId(605482L)
|
||||
.onlyTransient(BoolInt.ONE)
|
||||
.onlyTransient(BoolInt.True)
|
||||
.build();
|
||||
|
||||
GetMetadataHubsResponse res = sdk.hubs().getMetadataHubs()
|
||||
@@ -1348,7 +1348,7 @@ actions:
|
||||
|
||||
GetPostplayHubsRequest req = GetPostplayHubsRequest.builder()
|
||||
.metadataId(441419L)
|
||||
.onlyTransient(BoolInt.ONE)
|
||||
.onlyTransient(BoolInt.True)
|
||||
.build();
|
||||
|
||||
GetPostplayHubsResponse res = sdk.hubs().getPostplayHubs()
|
||||
@@ -1396,7 +1396,7 @@ actions:
|
||||
|
||||
GetRelatedHubsRequest req = GetRelatedHubsRequest.builder()
|
||||
.metadataId(8858L)
|
||||
.onlyTransient(BoolInt.ONE)
|
||||
.onlyTransient(BoolInt.True)
|
||||
.build();
|
||||
|
||||
GetRelatedHubsResponse res = sdk.hubs().getRelatedHubs()
|
||||
@@ -1512,6 +1512,7 @@ actions:
|
||||
import dev.plexapi.sdk.models.operations.VoiceSearchHubsRequest;
|
||||
import dev.plexapi.sdk.models.operations.VoiceSearchHubsResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import dev.plexapi.sdk.models.shared.MediaType;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -1535,6 +1536,7 @@ actions:
|
||||
|
||||
VoiceSearchHubsRequest req = VoiceSearchHubsRequest.builder()
|
||||
.query("<value>")
|
||||
.type(MediaType.TvShow)
|
||||
.build();
|
||||
|
||||
VoiceSearchHubsResponse res = sdk.search().voiceSearchHubs()
|
||||
@@ -1582,7 +1584,7 @@ actions:
|
||||
|
||||
GetSectionHubsRequest req = GetSectionHubsRequest.builder()
|
||||
.sectionId(336924L)
|
||||
.onlyTransient(BoolInt.ONE)
|
||||
.onlyTransient(BoolInt.True)
|
||||
.build();
|
||||
|
||||
GetSectionHubsResponse res = sdk.hubs().getSectionHubs()
|
||||
@@ -1721,9 +1723,9 @@ actions:
|
||||
CreateCustomHubRequest req = CreateCustomHubRequest.builder()
|
||||
.sectionId(869922L)
|
||||
.metadataItemId(703843L)
|
||||
.promotedToRecommended(BoolInt.ONE)
|
||||
.promotedToOwnHome(BoolInt.ONE)
|
||||
.promotedToSharedHome(BoolInt.ONE)
|
||||
.promotedToRecommended(BoolInt.True)
|
||||
.promotedToOwnHome(BoolInt.True)
|
||||
.promotedToSharedHome(BoolInt.True)
|
||||
.build();
|
||||
|
||||
CreateCustomHubResponse res = sdk.hubs().createCustomHub()
|
||||
@@ -1862,9 +1864,9 @@ actions:
|
||||
UpdateHubVisibilityRequest req = UpdateHubVisibilityRequest.builder()
|
||||
.sectionId(341650L)
|
||||
.identifier("<value>")
|
||||
.promotedToRecommended(BoolInt.ONE)
|
||||
.promotedToOwnHome(BoolInt.ONE)
|
||||
.promotedToSharedHome(BoolInt.ONE)
|
||||
.promotedToRecommended(BoolInt.True)
|
||||
.promotedToOwnHome(BoolInt.True)
|
||||
.promotedToSharedHome(BoolInt.True)
|
||||
.build();
|
||||
|
||||
UpdateHubVisibilityResponse res = sdk.hubs().updateHubVisibility()
|
||||
@@ -1912,7 +1914,7 @@ actions:
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.operations.GetLibraryItemsRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetLibraryItemsResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import dev.plexapi.sdk.models.shared.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -1935,6 +1937,11 @@ actions:
|
||||
.build();
|
||||
|
||||
GetLibraryItemsRequest req = GetLibraryItemsRequest.builder()
|
||||
.mediaQuery(MediaQuery.builder()
|
||||
.type(MediaType.Episode)
|
||||
.sourceType(2L)
|
||||
.sort("duration:desc,index")
|
||||
.build())
|
||||
.build();
|
||||
|
||||
GetLibraryItemsResponse res = sdk.library().getLibraryItems()
|
||||
@@ -2010,6 +2017,7 @@ actions:
|
||||
import dev.plexapi.sdk.models.operations.CreateCollectionRequest;
|
||||
import dev.plexapi.sdk.models.operations.CreateCollectionResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import dev.plexapi.sdk.models.shared.MediaType;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -2033,6 +2041,7 @@ actions:
|
||||
|
||||
CreateCollectionRequest req = CreateCollectionRequest.builder()
|
||||
.sectionId("<id>")
|
||||
.type(MediaType.TvShow)
|
||||
.build();
|
||||
|
||||
CreateCollectionResponse res = sdk.collections().createCollection()
|
||||
@@ -2315,8 +2324,8 @@ actions:
|
||||
IngestTransientItemRequest req = IngestTransientItemRequest.builder()
|
||||
.url("file:///storage%2Femulated%2F0%2FArcher-S01E01.mkv")
|
||||
.virtualFilePath("/Avatar.mkv")
|
||||
.computeHashes(BoolInt.ONE)
|
||||
.ingestNonMatches(BoolInt.ONE)
|
||||
.computeHashes(BoolInt.True)
|
||||
.ingestNonMatches(BoolInt.True)
|
||||
.build();
|
||||
|
||||
IngestTransientItemResponse res = sdk.library().ingestTransientItem()
|
||||
@@ -2339,8 +2348,7 @@ actions:
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.operations.GetLibraryMatchesRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetLibraryMatchesResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import dev.plexapi.sdk.models.shared.BoolInt;
|
||||
import dev.plexapi.sdk.models.shared.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -2363,9 +2371,10 @@ actions:
|
||||
.build();
|
||||
|
||||
GetLibraryMatchesRequest req = GetLibraryMatchesRequest.builder()
|
||||
.includeFullMetadata(BoolInt.ONE)
|
||||
.includeAncestorMetadata(BoolInt.ONE)
|
||||
.includeAlternateMetadataSources(BoolInt.ONE)
|
||||
.type(MediaType.TvShow)
|
||||
.includeFullMetadata(BoolInt.True)
|
||||
.includeAncestorMetadata(BoolInt.True)
|
||||
.includeAlternateMetadataSources(BoolInt.True)
|
||||
.build();
|
||||
|
||||
GetLibraryMatchesResponse res = sdk.library().getLibraryMatches()
|
||||
@@ -2460,7 +2469,7 @@ actions:
|
||||
|
||||
GetAugmentationStatusRequest req = GetAugmentationStatusRequest.builder()
|
||||
.augmentationId("<id>")
|
||||
.wait_(BoolInt.ONE)
|
||||
.wait_(BoolInt.True)
|
||||
.build();
|
||||
|
||||
GetAugmentationStatusResponse res = sdk.library().getAugmentationStatus()
|
||||
@@ -2506,7 +2515,7 @@ actions:
|
||||
|
||||
DeleteMetadataItemRequest req = DeleteMetadataItemRequest.builder()
|
||||
.ids("<value>")
|
||||
.proxy(BoolInt.ONE)
|
||||
.proxy(BoolInt.True)
|
||||
.build();
|
||||
|
||||
DeleteMetadataItemResponse res = sdk.library().deleteMetadataItem()
|
||||
@@ -2553,14 +2562,14 @@ actions:
|
||||
|
||||
GetMetadataItemRequest req = GetMetadataItemRequest.builder()
|
||||
.ids(List.of())
|
||||
.asyncCheckFiles(BoolInt.ONE)
|
||||
.asyncRefreshLocalMediaAgent(BoolInt.ONE)
|
||||
.asyncRefreshAnalysis(BoolInt.ONE)
|
||||
.checkFiles(BoolInt.ONE)
|
||||
.skipRefresh(BoolInt.ONE)
|
||||
.checkFileAvailability(BoolInt.ONE)
|
||||
.asyncAugmentMetadata(BoolInt.ONE)
|
||||
.augmentCount(BoolInt.ONE)
|
||||
.asyncCheckFiles(BoolInt.True)
|
||||
.asyncRefreshLocalMediaAgent(BoolInt.True)
|
||||
.asyncRefreshAnalysis(BoolInt.True)
|
||||
.checkFiles(BoolInt.True)
|
||||
.skipRefresh(BoolInt.True)
|
||||
.checkFileAvailability(BoolInt.True)
|
||||
.asyncAugmentMetadata(BoolInt.True)
|
||||
.augmentCount(BoolInt.True)
|
||||
.build();
|
||||
|
||||
GetMetadataItemResponse res = sdk.content().getMetadataItem()
|
||||
@@ -2789,7 +2798,7 @@ actions:
|
||||
|
||||
GenerateThumbsRequest req = GenerateThumbsRequest.builder()
|
||||
.ids("<value>")
|
||||
.force(BoolInt.ONE)
|
||||
.force(BoolInt.True)
|
||||
.build();
|
||||
|
||||
GenerateThumbsResponse res = sdk.library().generateThumbs()
|
||||
@@ -2835,8 +2844,8 @@ actions:
|
||||
|
||||
DetectCreditsRequest req = DetectCreditsRequest.builder()
|
||||
.ids("<value>")
|
||||
.force(BoolInt.ONE)
|
||||
.manual(BoolInt.ONE)
|
||||
.force(BoolInt.True)
|
||||
.manual(BoolInt.True)
|
||||
.build();
|
||||
|
||||
DetectCreditsResponse res = sdk.library().detectCredits()
|
||||
@@ -3019,7 +3028,7 @@ actions:
|
||||
|
||||
StartBifGenerationRequest req = StartBifGenerationRequest.builder()
|
||||
.ids("<value>")
|
||||
.force(BoolInt.ONE)
|
||||
.force(BoolInt.True)
|
||||
.build();
|
||||
|
||||
StartBifGenerationResponse res = sdk.library().startBifGeneration()
|
||||
@@ -3065,7 +3074,7 @@ actions:
|
||||
|
||||
DetectIntrosRequest req = DetectIntrosRequest.builder()
|
||||
.ids("<value>")
|
||||
.force(BoolInt.ONE)
|
||||
.force(BoolInt.True)
|
||||
.build();
|
||||
|
||||
DetectIntrosResponse res = sdk.library().detectIntros()
|
||||
@@ -3299,7 +3308,7 @@ actions:
|
||||
|
||||
ListMatchesRequest req = ListMatchesRequest.builder()
|
||||
.ids("<value>")
|
||||
.manual(BoolInt.ONE)
|
||||
.manual(BoolInt.True)
|
||||
.build();
|
||||
|
||||
ListMatchesResponse res = sdk.library().listMatches()
|
||||
@@ -3348,7 +3357,7 @@ actions:
|
||||
DeleteMediaItemRequest req = DeleteMediaItemRequest.builder()
|
||||
.ids("<value>")
|
||||
.mediaItem("<value>")
|
||||
.proxy(BoolInt.ONE)
|
||||
.proxy(BoolInt.True)
|
||||
.build();
|
||||
|
||||
DeleteMediaItemResponse res = sdk.library().deleteMediaItem()
|
||||
@@ -3537,7 +3546,7 @@ actions:
|
||||
|
||||
RefreshItemsMetadataRequest req = RefreshItemsMetadataRequest.builder()
|
||||
.ids("<value>")
|
||||
.markUpdated(BoolInt.ONE)
|
||||
.markUpdated(BoolInt.True)
|
||||
.build();
|
||||
|
||||
RefreshItemsMetadataResponse res = sdk.library().refreshItemsMetadata()
|
||||
@@ -3719,8 +3728,8 @@ actions:
|
||||
|
||||
AddSubtitlesRequest req = AddSubtitlesRequest.builder()
|
||||
.ids("<value>")
|
||||
.forced(BoolInt.ONE)
|
||||
.hearingImpaired(BoolInt.ONE)
|
||||
.forced(BoolInt.True)
|
||||
.hearingImpaired(BoolInt.True)
|
||||
.build();
|
||||
|
||||
AddSubtitlesResponse res = sdk.library().addSubtitles()
|
||||
@@ -3902,8 +3911,8 @@ actions:
|
||||
|
||||
DetectVoiceActivityRequest req = DetectVoiceActivityRequest.builder()
|
||||
.ids("<value>")
|
||||
.force(BoolInt.ONE)
|
||||
.manual(BoolInt.ONE)
|
||||
.force(BoolInt.True)
|
||||
.manual(BoolInt.True)
|
||||
.build();
|
||||
|
||||
DetectVoiceActivityResponse res = sdk.library().detectVoiceActivity()
|
||||
@@ -4083,7 +4092,7 @@ actions:
|
||||
.build();
|
||||
|
||||
OptimizeDatabaseRequest req = OptimizeDatabaseRequest.builder()
|
||||
.async(BoolInt.ONE)
|
||||
.async(BoolInt.True)
|
||||
.build();
|
||||
|
||||
OptimizeDatabaseResponse res = sdk.library().optimizeDatabase()
|
||||
@@ -4129,7 +4138,7 @@ actions:
|
||||
|
||||
SetStreamSelectionRequest req = SetStreamSelectionRequest.builder()
|
||||
.partId(360489L)
|
||||
.allParts(BoolInt.ONE)
|
||||
.allParts(BoolInt.True)
|
||||
.build();
|
||||
|
||||
SetStreamSelectionResponse res = sdk.library().setStreamSelection()
|
||||
@@ -4270,7 +4279,7 @@ actions:
|
||||
.partId(877105L)
|
||||
.changestamp(970622L)
|
||||
.filename("example.file")
|
||||
.download(BoolInt.ONE)
|
||||
.download(BoolInt.True)
|
||||
.build();
|
||||
|
||||
GetMediaPartResponse res = sdk.library().getMediaPart()
|
||||
@@ -4493,8 +4502,8 @@ actions:
|
||||
"O:\fatboy\\Media\\My Music"))
|
||||
.prefs(QueryParamPrefs.builder()
|
||||
.build())
|
||||
.relative(BoolInt.ONE)
|
||||
.importFromiTunes(BoolInt.ONE)
|
||||
.relative(BoolInt.True)
|
||||
.importFromiTunes(BoolInt.True)
|
||||
.build();
|
||||
|
||||
AddSectionResponse res = sdk.library().addSection()
|
||||
@@ -4529,7 +4538,7 @@ actions:
|
||||
StopAllRefreshesResponse res = sdk.library().stopAllRefreshes()
|
||||
.call();
|
||||
|
||||
if (res.requestHandlerSlashGetResponses200().isPresent()) {
|
||||
if (res.librarySections().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
@@ -4575,7 +4584,7 @@ actions:
|
||||
.request(req)
|
||||
.call();
|
||||
|
||||
if (res.requestHandlerSlashGetResponses200().isPresent()) {
|
||||
if (res.librarySections().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
@@ -4659,7 +4668,7 @@ actions:
|
||||
|
||||
DeleteLibrarySectionRequest req = DeleteLibrarySectionRequest.builder()
|
||||
.sectionId("<id>")
|
||||
.async(BoolInt.ONE)
|
||||
.async(BoolInt.True)
|
||||
.build();
|
||||
|
||||
DeleteLibrarySectionResponse res = sdk.library().deleteLibrarySection()
|
||||
@@ -4705,7 +4714,7 @@ actions:
|
||||
|
||||
GetLibraryDetailsRequest req = GetLibraryDetailsRequest.builder()
|
||||
.sectionId("<id>")
|
||||
.includeDetails(BoolInt.ONE)
|
||||
.includeDetails(BoolInt.True)
|
||||
.build();
|
||||
|
||||
GetLibraryDetailsResponse res = sdk.library().getLibraryDetails()
|
||||
@@ -4824,7 +4833,7 @@ actions:
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.operations.ListContentRequest;
|
||||
import dev.plexapi.sdk.models.operations.ListContentResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import dev.plexapi.sdk.models.shared.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -4848,6 +4857,13 @@ actions:
|
||||
|
||||
ListContentRequest req = ListContentRequest.builder()
|
||||
.sectionId("<id>")
|
||||
.mediaQuery(MediaQuery.builder()
|
||||
.type(MediaType.Episode)
|
||||
.sourceType(2L)
|
||||
.sort("duration:desc,index")
|
||||
.build())
|
||||
.includeMeta(BoolInt.True)
|
||||
.includeGuids(BoolInt.True)
|
||||
.build();
|
||||
|
||||
ListContentResponse res = sdk.content().listContent()
|
||||
@@ -4895,7 +4911,7 @@ actions:
|
||||
|
||||
UpdateItemsRequest req = UpdateItemsRequest.builder()
|
||||
.sectionId("<id>")
|
||||
.fieldLocked(BoolInt.ONE)
|
||||
.fieldLocked(BoolInt.True)
|
||||
.build();
|
||||
|
||||
UpdateItemsResponse res = sdk.library().updateItems()
|
||||
@@ -5052,7 +5068,7 @@ actions:
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.operations.AutocompleteRequest;
|
||||
import dev.plexapi.sdk.models.operations.AutocompleteResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import dev.plexapi.sdk.models.shared.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -5076,6 +5092,11 @@ actions:
|
||||
|
||||
AutocompleteRequest req = AutocompleteRequest.builder()
|
||||
.sectionId(942007L)
|
||||
.mediaQuery(MediaQuery.builder()
|
||||
.type(MediaType.Episode)
|
||||
.sourceType(2L)
|
||||
.sort("duration:desc,index")
|
||||
.build())
|
||||
.build();
|
||||
|
||||
AutocompleteResponse res = sdk.library().autocomplete()
|
||||
@@ -5235,7 +5256,7 @@ actions:
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.operations.GetCollectionsRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetCollectionsResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import dev.plexapi.sdk.models.shared.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -5259,6 +5280,11 @@ actions:
|
||||
|
||||
GetCollectionsRequest req = GetCollectionsRequest.builder()
|
||||
.sectionId(348838L)
|
||||
.mediaQuery(MediaQuery.builder()
|
||||
.type(MediaType.Episode)
|
||||
.sourceType(2L)
|
||||
.sort("duration:desc,index")
|
||||
.build())
|
||||
.build();
|
||||
|
||||
GetCollectionsResponse res = sdk.library().getCollections()
|
||||
@@ -5281,7 +5307,7 @@ actions:
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.operations.GetCommonRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetCommonResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import dev.plexapi.sdk.models.shared.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -5305,6 +5331,11 @@ actions:
|
||||
|
||||
GetCommonRequest req = GetCommonRequest.builder()
|
||||
.sectionId(298154L)
|
||||
.mediaQuery(MediaQuery.builder()
|
||||
.type(MediaType.Episode)
|
||||
.sourceType(2L)
|
||||
.sort("duration:desc,index")
|
||||
.build())
|
||||
.build();
|
||||
|
||||
GetCommonResponse res = sdk.library().getCommon()
|
||||
@@ -5327,7 +5358,7 @@ actions:
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.operations.GetSectionImageRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetSectionImageResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import dev.plexapi.sdk.models.shared.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -5352,6 +5383,11 @@ actions:
|
||||
GetSectionImageRequest req = GetSectionImageRequest.builder()
|
||||
.sectionId(925611L)
|
||||
.updatedAt(117413L)
|
||||
.mediaQuery(MediaQuery.builder()
|
||||
.type(MediaType.Episode)
|
||||
.sourceType(2L)
|
||||
.sort("duration:desc,index")
|
||||
.build())
|
||||
.build();
|
||||
|
||||
GetSectionImageResponse res = sdk.library().getSectionImage()
|
||||
@@ -5510,7 +5546,7 @@ actions:
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.operations.GetFirstCharactersRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetFirstCharactersResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import dev.plexapi.sdk.models.shared.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -5534,6 +5570,11 @@ actions:
|
||||
|
||||
GetFirstCharactersRequest req = GetFirstCharactersRequest.builder()
|
||||
.sectionId(3947L)
|
||||
.mediaQuery(MediaQuery.builder()
|
||||
.type(MediaType.Episode)
|
||||
.sourceType(2L)
|
||||
.sort("duration:desc,index")
|
||||
.build())
|
||||
.build();
|
||||
|
||||
GetFirstCharactersResponse res = sdk.library().getFirstCharacters()
|
||||
@@ -5944,7 +5985,7 @@ actions:
|
||||
|
||||
RefreshSectionRequest req = RefreshSectionRequest.builder()
|
||||
.sectionId(450300L)
|
||||
.force(BoolInt.ONE)
|
||||
.force(BoolInt.True)
|
||||
.build();
|
||||
|
||||
RefreshSectionResponse res = sdk.library().refreshSection()
|
||||
@@ -6082,7 +6123,7 @@ actions:
|
||||
GetStreamRequest req = GetStreamRequest.builder()
|
||||
.streamId(314506L)
|
||||
.ext("<value>")
|
||||
.autoAdjustSubtitle(BoolInt.ONE)
|
||||
.autoAdjustSubtitle(BoolInt.True)
|
||||
.build();
|
||||
|
||||
GetStreamResponse res = sdk.library().getStream()
|
||||
@@ -6241,6 +6282,7 @@ actions:
|
||||
import dev.plexapi.sdk.models.operations.GetTagsRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetTagsResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import dev.plexapi.sdk.models.shared.MediaType;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -6263,6 +6305,7 @@ actions:
|
||||
.build();
|
||||
|
||||
GetTagsRequest req = GetTagsRequest.builder()
|
||||
.type(MediaType.TvShow)
|
||||
.build();
|
||||
|
||||
GetTagsResponse res = sdk.library().getTags()
|
||||
@@ -7805,7 +7848,7 @@ actions:
|
||||
|
||||
ModifyDeviceRequest req = ModifyDeviceRequest.builder()
|
||||
.deviceId(879135L)
|
||||
.enabled(BoolInt.ONE)
|
||||
.enabled(BoolInt.True)
|
||||
.build();
|
||||
|
||||
ModifyDeviceResponse res = sdk.devices().modifyDevice()
|
||||
@@ -8331,8 +8374,8 @@ actions:
|
||||
.build();
|
||||
|
||||
GetAllSubscriptionsRequest req = GetAllSubscriptionsRequest.builder()
|
||||
.includeGrabs(BoolInt.ONE)
|
||||
.includeStorage(BoolInt.ONE)
|
||||
.includeGrabs(BoolInt.True)
|
||||
.includeStorage(BoolInt.True)
|
||||
.build();
|
||||
|
||||
GetAllSubscriptionsResponse res = sdk.subscriptions().getAllSubscriptions()
|
||||
@@ -8577,8 +8620,8 @@ actions:
|
||||
|
||||
GetSubscriptionRequest req = GetSubscriptionRequest.builder()
|
||||
.subscriptionId(186713L)
|
||||
.includeGrabs(BoolInt.ONE)
|
||||
.includeStorage(BoolInt.ONE)
|
||||
.includeGrabs(BoolInt.True)
|
||||
.includeStorage(BoolInt.True)
|
||||
.build();
|
||||
|
||||
GetSubscriptionResponse res = sdk.subscriptions().getSubscription()
|
||||
@@ -8720,9 +8763,9 @@ actions:
|
||||
TranscodeImageRequest req = TranscodeImageRequest.builder()
|
||||
.url("/library/metadata/265/thumb/1715112705")
|
||||
.background("#ff5522")
|
||||
.upscale(BoolInt.ONE)
|
||||
.minSize(BoolInt.ONE)
|
||||
.rotate(BoolInt.ONE)
|
||||
.upscale(BoolInt.True)
|
||||
.minSize(BoolInt.True)
|
||||
.rotate(BoolInt.True)
|
||||
.blendColor("#ff5522")
|
||||
.build();
|
||||
|
||||
@@ -8770,11 +8813,11 @@ actions:
|
||||
|
||||
CreatePlayQueueRequest req = CreatePlayQueueRequest.builder()
|
||||
.type(Type.AUDIO)
|
||||
.shuffle(BoolInt.ONE)
|
||||
.repeat(BoolInt.ONE)
|
||||
.continuous(BoolInt.ONE)
|
||||
.recursive(BoolInt.ONE)
|
||||
.onDeck(BoolInt.ONE)
|
||||
.shuffle(BoolInt.True)
|
||||
.repeat(BoolInt.True)
|
||||
.continuous(BoolInt.True)
|
||||
.recursive(BoolInt.True)
|
||||
.onDeck(BoolInt.True)
|
||||
.build();
|
||||
|
||||
CreatePlayQueueResponse res = sdk.playQueue().createPlayQueue()
|
||||
@@ -8822,9 +8865,9 @@ actions:
|
||||
|
||||
GetPlayQueueRequest req = GetPlayQueueRequest.builder()
|
||||
.playQueueId(210646L)
|
||||
.own(BoolInt.ONE)
|
||||
.includeBefore(BoolInt.ONE)
|
||||
.includeAfter(BoolInt.ONE)
|
||||
.own(BoolInt.True)
|
||||
.includeBefore(BoolInt.True)
|
||||
.includeAfter(BoolInt.True)
|
||||
.build();
|
||||
|
||||
GetPlayQueueResponse res = sdk.playQueue().getPlayQueue()
|
||||
@@ -8872,7 +8915,7 @@ actions:
|
||||
|
||||
AddToPlayQueueRequest req = AddToPlayQueueRequest.builder()
|
||||
.playQueueId(919248L)
|
||||
.next(BoolInt.ONE)
|
||||
.next(BoolInt.True)
|
||||
.build();
|
||||
|
||||
AddToPlayQueueResponse res = sdk.playQueue().addToPlayQueue()
|
||||
@@ -9288,7 +9331,7 @@ actions:
|
||||
|
||||
UploadPlaylistRequest req = UploadPlaylistRequest.builder()
|
||||
.path("/home/barkley/playlist.m3u")
|
||||
.force(BoolInt.ONE)
|
||||
.force(BoolInt.True)
|
||||
.build();
|
||||
|
||||
UploadPlaylistResponse res = sdk.libraryPlaylists().uploadPlaylist()
|
||||
@@ -9850,6 +9893,45 @@ actions:
|
||||
}
|
||||
}
|
||||
}
|
||||
- target: $["paths"]["/resources"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: java
|
||||
label: PlexJava
|
||||
source: |-
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetServerResourcesUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.*;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) throws GetServerResourcesUnauthorized, Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accepts(Accepts.APPLICATION_XML)
|
||||
.clientIdentifier("abc123")
|
||||
.token(System.getenv().getOrDefault("TOKEN", ""))
|
||||
.build();
|
||||
|
||||
GetServerResourcesRequest req = GetServerResourcesRequest.builder()
|
||||
.includeHttps(IncludeHttps.True)
|
||||
.includeRelay(IncludeRelay.True)
|
||||
.includeIPv6(IncludeIPv6.True)
|
||||
.build();
|
||||
|
||||
GetServerResourcesResponse res = sdk.plex().getServerResources()
|
||||
.request(req)
|
||||
.call();
|
||||
|
||||
if (res.plexDevices().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
}
|
||||
- target: $["paths"]["/security/resources"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
@@ -9886,7 +9968,7 @@ actions:
|
||||
|
||||
GetSourceConnectionInformationRequest req = GetSourceConnectionInformationRequest.builder()
|
||||
.source("<value>")
|
||||
.refresh(BoolInt.ONE)
|
||||
.refresh(BoolInt.True)
|
||||
.build();
|
||||
|
||||
GetSourceConnectionInformationResponse res = sdk.general().getSourceConnectionInformation()
|
||||
@@ -10031,7 +10113,7 @@ actions:
|
||||
.bottomLeft("1c425d")
|
||||
.width(1920L)
|
||||
.height(1080L)
|
||||
.noise(BoolInt.ONE)
|
||||
.noise(BoolInt.True)
|
||||
.build();
|
||||
|
||||
GetImageResponse res = sdk.ultraBlur().getImage()
|
||||
@@ -10341,8 +10423,8 @@ actions:
|
||||
.build();
|
||||
|
||||
ApplyUpdatesRequest req = ApplyUpdatesRequest.builder()
|
||||
.tonight(BoolInt.ONE)
|
||||
.skip(BoolInt.ONE)
|
||||
.tonight(BoolInt.True)
|
||||
.skip(BoolInt.True)
|
||||
.build();
|
||||
|
||||
ApplyUpdatesResponse res = sdk.updater().applyUpdates()
|
||||
@@ -10387,7 +10469,7 @@ actions:
|
||||
.build();
|
||||
|
||||
CheckUpdatesRequest req = CheckUpdatesRequest.builder()
|
||||
.download(BoolInt.ONE)
|
||||
.download(BoolInt.True)
|
||||
.build();
|
||||
|
||||
CheckUpdatesResponse res = sdk.updater().checkUpdates()
|
||||
@@ -10425,6 +10507,150 @@ actions:
|
||||
}
|
||||
}
|
||||
}
|
||||
- target: $["paths"]["/user"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: java
|
||||
label: PlexJava
|
||||
source: |-
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetTokenDetailsBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetTokenDetailsUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetTokenDetailsRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetTokenDetailsResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) throws GetTokenDetailsBadRequest, GetTokenDetailsUnauthorized, Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accepts(Accepts.APPLICATION_XML)
|
||||
.clientIdentifier("abc123")
|
||||
.product("Plex for Roku")
|
||||
.version("2.4.1")
|
||||
.platform("Roku")
|
||||
.platformVersion("4.3 build 1057")
|
||||
.device("Roku 3")
|
||||
.model("4200X")
|
||||
.deviceVendor("Roku")
|
||||
.deviceName("Living Room TV")
|
||||
.marketplace("googlePlay")
|
||||
.token(System.getenv().getOrDefault("TOKEN", ""))
|
||||
.build();
|
||||
|
||||
GetTokenDetailsRequest req = GetTokenDetailsRequest.builder()
|
||||
.build();
|
||||
|
||||
GetTokenDetailsResponse res = sdk.authentication().getTokenDetails()
|
||||
.request(req)
|
||||
.call();
|
||||
|
||||
if (res.userPlexAccount().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
}
|
||||
- target: $["paths"]["/users"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: java
|
||||
label: PlexJava
|
||||
source: |-
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetUsersBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetUsersUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetUsersRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetUsersResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) throws GetUsersBadRequest, GetUsersUnauthorized, Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accepts(Accepts.APPLICATION_XML)
|
||||
.clientIdentifier("abc123")
|
||||
.product("Plex for Roku")
|
||||
.version("2.4.1")
|
||||
.platform("Roku")
|
||||
.platformVersion("4.3 build 1057")
|
||||
.device("Roku 3")
|
||||
.model("4200X")
|
||||
.deviceVendor("Roku")
|
||||
.deviceName("Living Room TV")
|
||||
.marketplace("googlePlay")
|
||||
.token(System.getenv().getOrDefault("TOKEN", ""))
|
||||
.build();
|
||||
|
||||
GetUsersRequest req = GetUsersRequest.builder()
|
||||
.build();
|
||||
|
||||
GetUsersResponse res = sdk.users().getUsers()
|
||||
.request(req)
|
||||
.call();
|
||||
|
||||
if (res.object().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
}
|
||||
- target: $["paths"]["/users/signin"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: java
|
||||
label: PlexJava
|
||||
source: |-
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.PostUsersSignInDataBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.PostUsersSignInDataUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.*;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) throws PostUsersSignInDataBadRequest, PostUsersSignInDataUnauthorized, Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accepts(Accepts.APPLICATION_XML)
|
||||
.clientIdentifier("abc123")
|
||||
.product("Plex for Roku")
|
||||
.version("2.4.1")
|
||||
.platform("Roku")
|
||||
.platformVersion("4.3 build 1057")
|
||||
.device("Roku 3")
|
||||
.model("4200X")
|
||||
.deviceVendor("Roku")
|
||||
.deviceName("Living Room TV")
|
||||
.marketplace("googlePlay")
|
||||
.build();
|
||||
|
||||
PostUsersSignInDataRequest req = PostUsersSignInDataRequest.builder()
|
||||
.requestBody(PostUsersSignInDataRequestBody.builder()
|
||||
.login("username@email.com")
|
||||
.password("password123")
|
||||
.verificationCode("123456")
|
||||
.build())
|
||||
.build();
|
||||
|
||||
PostUsersSignInDataResponse res = sdk.authentication().postUsersSignInData()
|
||||
.request(req)
|
||||
.call();
|
||||
|
||||
if (res.userPlexAccount().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
}
|
||||
- target: $["paths"]["/{transcodeType}/:/transcode/universal/decision"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
@@ -10462,13 +10688,13 @@ actions:
|
||||
.advancedSubtitles(AdvancedSubtitles.BURN)
|
||||
.audioBoost(50L)
|
||||
.audioChannelCount(5L)
|
||||
.autoAdjustQuality(BoolInt.ONE)
|
||||
.autoAdjustSubtitle(BoolInt.ONE)
|
||||
.directPlay(BoolInt.ONE)
|
||||
.directStream(BoolInt.ONE)
|
||||
.directStreamAudio(BoolInt.ONE)
|
||||
.disableResolutionRotation(BoolInt.ONE)
|
||||
.hasMDE(BoolInt.ONE)
|
||||
.autoAdjustQuality(BoolInt.True)
|
||||
.autoAdjustSubtitle(BoolInt.True)
|
||||
.directPlay(BoolInt.True)
|
||||
.directStream(BoolInt.True)
|
||||
.directStreamAudio(BoolInt.True)
|
||||
.disableResolutionRotation(BoolInt.True)
|
||||
.hasMDE(BoolInt.True)
|
||||
.location(Location.WAN)
|
||||
.mediaBufferSize(102400L)
|
||||
.mediaIndex(0L)
|
||||
@@ -10580,13 +10806,13 @@ actions:
|
||||
.advancedSubtitles(AdvancedSubtitles.BURN)
|
||||
.audioBoost(50L)
|
||||
.audioChannelCount(5L)
|
||||
.autoAdjustQuality(BoolInt.ONE)
|
||||
.autoAdjustSubtitle(BoolInt.ONE)
|
||||
.directPlay(BoolInt.ONE)
|
||||
.directStream(BoolInt.ONE)
|
||||
.directStreamAudio(BoolInt.ONE)
|
||||
.disableResolutionRotation(BoolInt.ONE)
|
||||
.hasMDE(BoolInt.ONE)
|
||||
.autoAdjustQuality(BoolInt.True)
|
||||
.autoAdjustSubtitle(BoolInt.True)
|
||||
.directPlay(BoolInt.True)
|
||||
.directStream(BoolInt.True)
|
||||
.directStreamAudio(BoolInt.True)
|
||||
.disableResolutionRotation(BoolInt.True)
|
||||
.hasMDE(BoolInt.True)
|
||||
.location(StartTranscodeSessionQueryParamLocation.WAN)
|
||||
.mediaBufferSize(102400L)
|
||||
.mediaIndex(0L)
|
||||
@@ -10652,13 +10878,13 @@ actions:
|
||||
.advancedSubtitles(AdvancedSubtitles.BURN)
|
||||
.audioBoost(50L)
|
||||
.audioChannelCount(5L)
|
||||
.autoAdjustQuality(BoolInt.ONE)
|
||||
.autoAdjustSubtitle(BoolInt.ONE)
|
||||
.directPlay(BoolInt.ONE)
|
||||
.directStream(BoolInt.ONE)
|
||||
.directStreamAudio(BoolInt.ONE)
|
||||
.disableResolutionRotation(BoolInt.ONE)
|
||||
.hasMDE(BoolInt.ONE)
|
||||
.autoAdjustQuality(BoolInt.True)
|
||||
.autoAdjustSubtitle(BoolInt.True)
|
||||
.directPlay(BoolInt.True)
|
||||
.directStream(BoolInt.True)
|
||||
.directStreamAudio(BoolInt.True)
|
||||
.disableResolutionRotation(BoolInt.True)
|
||||
.hasMDE(BoolInt.True)
|
||||
.location(QueryParamLocation.WAN)
|
||||
.mediaBufferSize(102400L)
|
||||
.mediaIndex(0L)
|
||||
|
||||
10
docs/models/errors/Errors.md
Normal file
10
docs/models/errors/Errors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Errors
|
||||
|
||||
|
||||
## 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/GetServerResourcesErrors.md
Normal file
10
docs/models/errors/GetServerResourcesErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetServerResourcesErrors
|
||||
|
||||
|
||||
## 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/GetServerResourcesUnauthorized.md
Normal file
11
docs/models/errors/GetServerResourcesUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetServerResourcesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List\<[GetServerResourcesErrors](../../models/errors/GetServerResourcesErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<?>](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 |
|
||||
11
docs/models/errors/GetTokenDetailsBadRequest.md
Normal file
11
docs/models/errors/GetTokenDetailsBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetTokenDetailsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List\<[Errors](../../models/errors/Errors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<?>](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/GetTokenDetailsErrors.md
Normal file
10
docs/models/errors/GetTokenDetailsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetTokenDetailsErrors
|
||||
|
||||
|
||||
## 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/GetTokenDetailsUnauthorized.md
Normal file
11
docs/models/errors/GetTokenDetailsUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetTokenDetailsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List\<[GetTokenDetailsErrors](../../models/errors/GetTokenDetailsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<?>](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 |
|
||||
11
docs/models/errors/GetUsersBadRequest.md
Normal file
11
docs/models/errors/GetUsersBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetUsersBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List\<[GetUsersErrors](../../models/errors/GetUsersErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<?>](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/GetUsersErrors.md
Normal file
10
docs/models/errors/GetUsersErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetUsersErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
11
docs/models/errors/GetUsersUnauthorized.md
Normal file
11
docs/models/errors/GetUsersUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetUsersUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List\<[GetUsersUsersErrors](../../models/errors/GetUsersUsersErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<?>](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/GetUsersUsersErrors.md
Normal file
10
docs/models/errors/GetUsersUsersErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetUsersUsersErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -0,0 +1,10 @@
|
||||
# PostUsersSignInDataAuthenticationErrors
|
||||
|
||||
|
||||
## 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/PostUsersSignInDataBadRequest.md
Normal file
11
docs/models/errors/PostUsersSignInDataBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# PostUsersSignInDataBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List\<[PostUsersSignInDataErrors](../../models/errors/PostUsersSignInDataErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<?>](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/PostUsersSignInDataErrors.md
Normal file
10
docs/models/errors/PostUsersSignInDataErrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# PostUsersSignInDataErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
11
docs/models/errors/PostUsersSignInDataUnauthorized.md
Normal file
11
docs/models/errors/PostUsersSignInDataUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# PostUsersSignInDataUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List\<[PostUsersSignInDataAuthenticationErrors](../../models/errors/PostUsersSignInDataAuthenticationErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<?>](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 |
|
||||
11
docs/models/operations/AllLibraries.md
Normal file
11
docs/models/operations/AllLibraries.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# AllLibraries
|
||||
|
||||
Indicates if the user has access to all libraries.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
11
docs/models/operations/AllowCameraUpload.md
Normal file
11
docs/models/operations/AllowCameraUpload.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# AllowCameraUpload
|
||||
|
||||
Indicates if the user is allowed to upload from a camera.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
11
docs/models/operations/AllowChannels.md
Normal file
11
docs/models/operations/AllowChannels.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# AllowChannels
|
||||
|
||||
Indicates if the user has access to channels.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
11
docs/models/operations/AllowSubtitleAdmin.md
Normal file
11
docs/models/operations/AllowSubtitleAdmin.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# AllowSubtitleAdmin
|
||||
|
||||
Indicates if the user can manage subtitles.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
11
docs/models/operations/AllowSync.md
Normal file
11
docs/models/operations/AllowSync.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# AllowSync
|
||||
|
||||
Indicates if the user is allowed to sync media.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
11
docs/models/operations/AllowTuners.md
Normal file
11
docs/models/operations/AllowTuners.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# AllowTuners
|
||||
|
||||
Indicates if the user is allowed to use tuners.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
@@ -3,20 +3,20 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `sectionId` | *long* | :heavy_check_mark: | Section identifier | |
|
||||
| `type` | *Optional\<Long>* | :heavy_minus_sign: | Item type | |
|
||||
| `fieldQuery` | *Optional\<String>* | :heavy_minus_sign: | The "field" stands in for any field, the value is a partial string for matching | |
|
||||
| `mediaQuery` | [Optional\<MediaQuery>](../../models/shared/MediaQuery.md) | :heavy_minus_sign: | This is a complex query built of several parameters. See [API Info section](#section/API-Info/Media-Queries) for information on building media queries | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `sectionId` | *long* | :heavy_check_mark: | Section identifier | |
|
||||
| `type` | *Optional\<Long>* | :heavy_minus_sign: | Item type | |
|
||||
| `fieldQuery` | *Optional\<String>* | :heavy_minus_sign: | The "field" stands in for any field, the value is a partial string for matching | |
|
||||
| `mediaQuery` | [Optional\<MediaQuery>](../../models/shared/MediaQuery.md) | :heavy_minus_sign: | A querystring-based filtering language used to select subsets of media. Can be provided as an object with typed properties for type safety, or as a string for complex queries with operators and boolean logic.<br/><br/>The query supports:<br/>- Fields: integer, boolean, tag, string, date, language<br/>- Operators: =, !=, ==, !==, <=, >=, >>=, <<= (varies by field type)<br/>- Boolean operators: & (AND), , (OR), push/pop (parentheses), or=1 (explicit OR)<br/>- Sorting: sort parameter with :desc, :nullsLast modifiers<br/>- Grouping: group parameter<br/>- Limits: limit parameter<br/><br/>Examples:<br/>- Object format: `{type: 4, sourceType: 2, title: "24"}` → `type=4&sourceType=2&title=24`<br/>- String format: `type=4&sourceType=2&title==24` - type = 4 AND sourceType = 2 AND title = "24"<br/>- Complex: `push=1&index=1&or=1&rating=2&pop=1&duration=10` - (index = 1 OR rating = 2) AND duration = 10<br/><br/>See [API Info section](#section/API-Info/Media-Queries) for detailed information on building media queries.<br/> | {<br/>"type": 4,<br/>"sourceType": 2,<br/>"sort": "duration:desc,index"<br/>} |
|
||||
9
docs/models/operations/Billing.md
Normal file
9
docs/models/operations/Billing.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Billing
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `internalPaymentMethod` | [InternalPaymentMethod](../../models/operations/InternalPaymentMethod.md) | :heavy_check_mark: | N/A |
|
||||
| `paymentMethodId` | *Optional\<Long>* | :heavy_check_mark: | N/A |
|
||||
@@ -1,13 +1,31 @@
|
||||
# ButlerTask
|
||||
|
||||
The task name
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `description` | *Optional\<String>* | :heavy_minus_sign: | A user-friendly description of the task |
|
||||
| `enabled` | *Optional\<Boolean>* | :heavy_minus_sign: | Whether this task is enabled or not |
|
||||
| `interval` | *Optional\<Long>* | :heavy_minus_sign: | The interval (in days) of when this task is run. A value of 1 is run every day, 7 is every week, etc. |
|
||||
| `name` | *Optional\<String>* | :heavy_minus_sign: | The name of the task |
|
||||
| `scheduleRandomized` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether the timing of the task is randomized within the butler interval |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | A user-friendly title of the task |
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------------------------------- | -------------------------------------- |
|
||||
| `AUTOMATIC_UPDATES` | AutomaticUpdates |
|
||||
| `BACKUP_DATABASE` | BackupDatabase |
|
||||
| `BUTLER_TASK_GENERATE_AD_MARKERS` | ButlerTaskGenerateAdMarkers |
|
||||
| `BUTLER_TASK_GENERATE_CREDITS_MARKERS` | ButlerTaskGenerateCreditsMarkers |
|
||||
| `BUTLER_TASK_GENERATE_INTRO_MARKERS` | ButlerTaskGenerateIntroMarkers |
|
||||
| `BUTLER_TASK_GENERATE_VOICE_ACTIVITY` | ButlerTaskGenerateVoiceActivity |
|
||||
| `CLEAN_OLD_BUNDLES` | CleanOldBundles |
|
||||
| `CLEAN_OLD_CACHE_FILES` | CleanOldCacheFiles |
|
||||
| `DEEP_MEDIA_ANALYSIS` | DeepMediaAnalysis |
|
||||
| `GARBAGE_COLLECT_BLOBS` | GarbageCollectBlobs |
|
||||
| `GARBAGE_COLLECT_LIBRARY_MEDIA` | GarbageCollectLibraryMedia |
|
||||
| `GENERATE_BLUR_HASHES` | GenerateBlurHashes |
|
||||
| `GENERATE_CHAPTER_THUMBS` | GenerateChapterThumbs |
|
||||
| `GENERATE_MEDIA_INDEX_FILES` | GenerateMediaIndexFiles |
|
||||
| `LOUDNESS_ANALYSIS` | LoudnessAnalysis |
|
||||
| `MUSIC_ANALYSIS` | MusicAnalysis |
|
||||
| `OPTIMIZE_DATABASE` | OptimizeDatabase |
|
||||
| `REFRESH_EPG_GUIDES` | RefreshEpgGuides |
|
||||
| `REFRESH_LIBRARIES` | RefreshLibraries |
|
||||
| `REFRESH_LOCAL_MEDIA` | RefreshLocalMedia |
|
||||
| `REFRESH_PERIODIC_METADATA` | RefreshPeriodicMetadata |
|
||||
| `UPGRADE_MEDIA_ANALYSIS` | UpgradeMediaAnalysis |
|
||||
@@ -3,6 +3,6 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| `butlerTask` | List\<[ButlerTask](../../models/operations/ButlerTask.md)> | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
||||
| `butlerTask` | List\<[GetTasksButlerTask](../../models/operations/GetTasksButlerTask.md)> | :heavy_minus_sign: | N/A |
|
||||
@@ -3,21 +3,21 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `sectionId` | *String* | :heavy_check_mark: | The section where this collection will be created | |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | The title to filter by or assign | |
|
||||
| `smart` | *Optional\<Boolean>* | :heavy_minus_sign: | Whether this is a smart collection/playlist | |
|
||||
| `uri` | *Optional\<String>* | :heavy_minus_sign: | The URI for processing the smart collection. Required for a smart collection | |
|
||||
| `type` | *Optional\<Long>* | :heavy_minus_sign: | The metadata type to filter by | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `sectionId` | *String* | :heavy_check_mark: | The section where this collection will be created | |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | The title to filter by or assign | |
|
||||
| `smart` | *Optional\<Boolean>* | :heavy_minus_sign: | Whether this is a smart collection/playlist | |
|
||||
| `uri` | *Optional\<String>* | :heavy_minus_sign: | The URI for processing the smart collection. Required for a smart collection | |
|
||||
| `type` | [Optional\<MediaType>](../../models/shared/MediaType.md) | :heavy_minus_sign: | The type of media to retrieve or filter by.<br/><br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>5 = artist<br/>6 = album<br/>7 = track<br/>8 = photo_album<br/>9 = photo<br/><br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
20
docs/models/operations/CreateDownloadQueueStatus.md
Normal file
20
docs/models/operations/CreateDownloadQueueStatus.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# CreateDownloadQueueStatus
|
||||
|
||||
The state of this queue
|
||||
- deciding: At least one item is still being decided
|
||||
- waiting: At least one item is waiting for transcode and none are currently transcoding
|
||||
- processing: At least one item is being transcoded
|
||||
- done: All items are available (or potentially expired)
|
||||
- error: At least one item has encountered an error
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `DECIDING` | deciding |
|
||||
| `WAITING` | waiting |
|
||||
| `PROCESSING` | processing |
|
||||
| `DONE` | done |
|
||||
| `ERROR` | error |
|
||||
@@ -7,4 +7,4 @@
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
| `itemCount` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
| `status` | [Optional\<Status>](../../models/operations/Status.md) | :heavy_minus_sign: | The state of this queue<br/> - deciding: At least one item is still being decided<br/> - waiting: At least one item is waiting for transcode and none are currently transcoding<br/> - processing: At least one item is being transcoded<br/> - done: All items are available (or potentially expired)<br/> - error: At least one item has encountered an error<br/> |
|
||||
| `status` | [Optional\<CreateDownloadQueueStatus>](../../models/operations/CreateDownloadQueueStatus.md) | :heavy_minus_sign: | The state of this queue<br/> - deciding: At least one item is still being decided<br/> - waiting: At least one item is waiting for transcode and none are currently transcoding<br/> - processing: At least one item is being transcoded<br/> - done: All items are available (or potentially expired)<br/> - error: At least one item has encountered an error<br/> |
|
||||
@@ -3,18 +3,18 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `sectionId` | *long* | :heavy_check_mark: | Section identifier | |
|
||||
| `mediaQuery` | [Optional\<MediaQuery>](../../models/shared/MediaQuery.md) | :heavy_minus_sign: | This is a complex query built of several parameters. See [API Info section](#section/API-Info/Media-Queries) for information on building media queries | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `sectionId` | *long* | :heavy_check_mark: | Section identifier | |
|
||||
| `mediaQuery` | [Optional\<MediaQuery>](../../models/shared/MediaQuery.md) | :heavy_minus_sign: | A querystring-based filtering language used to select subsets of media. Can be provided as an object with typed properties for type safety, or as a string for complex queries with operators and boolean logic.<br/><br/>The query supports:<br/>- Fields: integer, boolean, tag, string, date, language<br/>- Operators: =, !=, ==, !==, <=, >=, >>=, <<= (varies by field type)<br/>- Boolean operators: & (AND), , (OR), push/pop (parentheses), or=1 (explicit OR)<br/>- Sorting: sort parameter with :desc, :nullsLast modifiers<br/>- Grouping: group parameter<br/>- Limits: limit parameter<br/><br/>Examples:<br/>- Object format: `{type: 4, sourceType: 2, title: "24"}` → `type=4&sourceType=2&title=24`<br/>- String format: `type=4&sourceType=2&title==24` - type = 4 AND sourceType = 2 AND title = "24"<br/>- Complex: `push=1&index=1&or=1&rating=2&pop=1&duration=10` - (index = 1 OR rating = 2) AND duration = 10<br/><br/>See [API Info section](#section/API-Info/Media-Queries) for detailed information on building media queries.<br/> | {<br/>"type": 4,<br/>"sourceType": 2,<br/>"sort": "duration:desc,index"<br/>} |
|
||||
@@ -3,19 +3,19 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `sectionId` | *long* | :heavy_check_mark: | Section identifier | |
|
||||
| `type` | *Optional\<Long>* | :heavy_minus_sign: | Item type | |
|
||||
| `mediaQuery` | [Optional\<MediaQuery>](../../models/shared/MediaQuery.md) | :heavy_minus_sign: | This is a complex query built of several parameters. See [API Info section](#section/API-Info/Media-Queries) for information on building media queries | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `sectionId` | *long* | :heavy_check_mark: | Section identifier | |
|
||||
| `type` | *Optional\<Long>* | :heavy_minus_sign: | Item type | |
|
||||
| `mediaQuery` | [Optional\<MediaQuery>](../../models/shared/MediaQuery.md) | :heavy_minus_sign: | A querystring-based filtering language used to select subsets of media. Can be provided as an object with typed properties for type safety, or as a string for complex queries with operators and boolean logic.<br/><br/>The query supports:<br/>- Fields: integer, boolean, tag, string, date, language<br/>- Operators: =, !=, ==, !==, <=, >=, >>=, <<= (varies by field type)<br/>- Boolean operators: & (AND), , (OR), push/pop (parentheses), or=1 (explicit OR)<br/>- Sorting: sort parameter with :desc, :nullsLast modifiers<br/>- Grouping: group parameter<br/>- Limits: limit parameter<br/><br/>Examples:<br/>- Object format: `{type: 4, sourceType: 2, title: "24"}` → `type=4&sourceType=2&title=24`<br/>- String format: `type=4&sourceType=2&title==24` - type = 4 AND sourceType = 2 AND title = "24"<br/>- Complex: `push=1&index=1&or=1&rating=2&pop=1&duration=10` - (index = 1 OR rating = 2) AND duration = 10<br/><br/>See [API Info section](#section/API-Info/Media-Queries) for detailed information on building media queries.<br/> | {<br/>"type": 4,<br/>"sourceType": 2,<br/>"sort": "duration:desc,index"<br/>} |
|
||||
@@ -3,20 +3,20 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `sectionId` | *long* | :heavy_check_mark: | Section identifier | |
|
||||
| `type` | *Optional\<Long>* | :heavy_minus_sign: | The metadata type to filter on | |
|
||||
| `sort` | *Optional\<Long>* | :heavy_minus_sign: | The metadata type to filter on | |
|
||||
| `mediaQuery` | [Optional\<MediaQuery>](../../models/shared/MediaQuery.md) | :heavy_minus_sign: | This is a complex query built of several parameters. See [API Info section](#section/API-Info/Media-Queries) for information on building media queries | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `sectionId` | *long* | :heavy_check_mark: | Section identifier | |
|
||||
| `type` | *Optional\<Long>* | :heavy_minus_sign: | The metadata type to filter on | |
|
||||
| `sort` | *Optional\<Long>* | :heavy_minus_sign: | The metadata type to filter on | |
|
||||
| `mediaQuery` | [Optional\<MediaQuery>](../../models/shared/MediaQuery.md) | :heavy_minus_sign: | A querystring-based filtering language used to select subsets of media. Can be provided as an object with typed properties for type safety, or as a string for complex queries with operators and boolean logic.<br/><br/>The query supports:<br/>- Fields: integer, boolean, tag, string, date, language<br/>- Operators: =, !=, ==, !==, <=, >=, >>=, <<= (varies by field type)<br/>- Boolean operators: & (AND), , (OR), push/pop (parentheses), or=1 (explicit OR)<br/>- Sorting: sort parameter with :desc, :nullsLast modifiers<br/>- Grouping: group parameter<br/>- Limits: limit parameter<br/><br/>Examples:<br/>- Object format: `{type: 4, sourceType: 2, title: "24"}` → `type=4&sourceType=2&title=24`<br/>- String format: `type=4&sourceType=2&title==24` - type = 4 AND sourceType = 2 AND title = "24"<br/>- Complex: `push=1&index=1&or=1&rating=2&pop=1&duration=10` - (index = 1 OR rating = 2) AND duration = 10<br/><br/>See [API Info section](#section/API-Info/Media-Queries) for detailed information on building media queries.<br/> | {<br/>"type": 4,<br/>"sourceType": 2,<br/>"sort": "duration:desc,index"<br/>} |
|
||||
@@ -3,17 +3,17 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `mediaQuery` | [Optional\<MediaQuery>](../../models/shared/MediaQuery.md) | :heavy_minus_sign: | This is a complex query built of several parameters. See [API Info section](#section/API-Info/Media-Queries) for information on building media queries | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `mediaQuery` | [Optional\<MediaQuery>](../../models/shared/MediaQuery.md) | :heavy_minus_sign: | A querystring-based filtering language used to select subsets of media. Can be provided as an object with typed properties for type safety, or as a string for complex queries with operators and boolean logic.<br/><br/>The query supports:<br/>- Fields: integer, boolean, tag, string, date, language<br/>- Operators: =, !=, ==, !==, <=, >=, >>=, <<= (varies by field type)<br/>- Boolean operators: & (AND), , (OR), push/pop (parentheses), or=1 (explicit OR)<br/>- Sorting: sort parameter with :desc, :nullsLast modifiers<br/>- Grouping: group parameter<br/>- Limits: limit parameter<br/><br/>Examples:<br/>- Object format: `{type: 4, sourceType: 2, title: "24"}` → `type=4&sourceType=2&title=24`<br/>- String format: `type=4&sourceType=2&title==24` - type = 4 AND sourceType = 2 AND title = "24"<br/>- Complex: `push=1&index=1&or=1&rating=2&pop=1&duration=10` - (index = 1 OR rating = 2) AND duration = 10<br/><br/>See [API Info section](#section/API-Info/Media-Queries) for detailed information on building media queries.<br/> | {<br/>"type": 4,<br/>"sourceType": 2,<br/>"sort": "duration:desc,index"<br/>} |
|
||||
@@ -3,30 +3,30 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `type` | *Optional\<Long>* | :heavy_minus_sign: | The metadata type to filter by | |
|
||||
| `includeFullMetadata` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `includeAncestorMetadata` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `includeAlternateMetadataSources` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `guid` | *Optional\<String>* | :heavy_minus_sign: | Used for movies, shows, artists, albums, and tracks. Allowed for various URI schemes, to be defined. | |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | The title to filter by or assign | |
|
||||
| `year` | *Optional\<Long>* | :heavy_minus_sign: | Used for movies shows, and albums. Optional. | |
|
||||
| `path` | *Optional\<String>* | :heavy_minus_sign: | Used for movies, episodes, and tracks. The full path to the media file, used for "cloud-scanning" an item. | |
|
||||
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | Used for episodes and tracks. The title of the show/artist. Required if `path` isn't passed. | |
|
||||
| `grandparentYear` | *Optional\<Long>* | :heavy_minus_sign: | Used for episodes. The year of the show. | |
|
||||
| `parentIndex` | *Optional\<Long>* | :heavy_minus_sign: | Used for episodes and tracks. The season/album number. | |
|
||||
| `index` | *Optional\<Long>* | :heavy_minus_sign: | Used for episodes and tracks. The episode/tracks number in the season/album. | |
|
||||
| `originallyAvailableAt` | *Optional\<String>* | :heavy_minus_sign: | Used for episodes. In the format `YYYY-MM-DD`. | |
|
||||
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | Used for albums and tracks. The artist name for albums or the album name for tracks. | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `type` | [Optional\<MediaType>](../../models/shared/MediaType.md) | :heavy_minus_sign: | The type of media to retrieve or filter by.<br/><br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>5 = artist<br/>6 = album<br/>7 = track<br/>8 = photo_album<br/>9 = photo<br/><br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `includeFullMetadata` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `includeAncestorMetadata` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `includeAlternateMetadataSources` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `guid` | *Optional\<String>* | :heavy_minus_sign: | Used for movies, shows, artists, albums, and tracks. Allowed for various URI schemes, to be defined. | |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | The title to filter by or assign | |
|
||||
| `year` | *Optional\<Long>* | :heavy_minus_sign: | Used for movies shows, and albums. Optional. | |
|
||||
| `path` | *Optional\<String>* | :heavy_minus_sign: | Used for movies, episodes, and tracks. The full path to the media file, used for "cloud-scanning" an item. | |
|
||||
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | Used for episodes and tracks. The title of the show/artist. Required if `path` isn't passed. | |
|
||||
| `grandparentYear` | *Optional\<Long>* | :heavy_minus_sign: | Used for episodes. The year of the show. | |
|
||||
| `parentIndex` | *Optional\<Long>* | :heavy_minus_sign: | Used for episodes and tracks. The season/album number. | |
|
||||
| `index` | *Optional\<Long>* | :heavy_minus_sign: | Used for episodes and tracks. The episode/tracks number in the season/album. | |
|
||||
| `originallyAvailableAt` | *Optional\<String>* | :heavy_minus_sign: | Used for episodes. In the format `YYYY-MM-DD`. | |
|
||||
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | Used for albums and tracks. The artist name for albums or the album name for tracks. | |
|
||||
8
docs/models/operations/GetPlaylistGeneratorItemsGuids.md
Normal file
8
docs/models/operations/GetPlaylistGeneratorItemsGuids.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetPlaylistGeneratorItemsGuids
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *String* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |
|
||||
@@ -10,75 +10,79 @@ Metadata items can often live in a hierarchy with relationships between them. F
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `title` | *Optional\<Object>* | :heavy_minus_sign: | The title of the item (e.g. “300” or “The Simpsons”) |
|
||||
| `type` | *Optional\<Object>* | :heavy_minus_sign: | The type of the video item, such as `movie`, `episode`, or `clip`. |
|
||||
| `absoluteIndex` | *Optional\<Long>* | :heavy_minus_sign: | When present, contains the disc number for a track on multi-disc albums. |
|
||||
| `addedAt` | *Optional\<Long>* | :heavy_minus_sign: | In units of seconds since the epoch, returns the time at which the item was added to the library. |
|
||||
| `art` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for the background artwork for the item. |
|
||||
| `audienceRating` | *Optional\<Double>* | :heavy_minus_sign: | Some rating systems separate reviewer ratings from audience ratings |
|
||||
| `audienceRatingImage` | *Optional\<Object>* | :heavy_minus_sign: | A URI representing the image to be shown with the audience rating (e.g. rottentomatoes://image.rating.spilled). |
|
||||
| `autotag` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `banner` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for a banner graphic for the item. |
|
||||
| `chapterSource` | *Optional\<Object>* | :heavy_minus_sign: | When present, indicates the source for the chapters in the media file. Can be media (the chapters were embedded in the media itself), agent (a metadata agent computed them), or mixed (a combination of the two). |
|
||||
| `composite` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for a composite image for descendent items (e.g. photo albums or playlists). |
|
||||
| `contentRating` | *Optional\<Object>* | :heavy_minus_sign: | If known, the content rating (e.g. MPAA) for an item. |
|
||||
| `country` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `director` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `duration` | *Optional\<Long>* | :heavy_minus_sign: | When present, the duration for the item, in units of milliseconds. |
|
||||
| `filter` | List\<[Filter](../../models/shared/Filter.md)> | :heavy_minus_sign: | Typically only seen in metadata at a library's top level |
|
||||
| `genre` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | The `art` of the grandparent |
|
||||
| `grandparentHero` | *Optional\<String>* | :heavy_minus_sign: | The `hero` of the grandparent |
|
||||
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | The `key` of the grandparent |
|
||||
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The `ratingKey` of the grandparent |
|
||||
| `grandparentTheme` | *Optional\<String>* | :heavy_minus_sign: | The `theme` of the grandparent |
|
||||
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | The `thumb` of the grandparent |
|
||||
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | The `title` of the grandparent |
|
||||
| `guid` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `hero` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for a hero image for the item. |
|
||||
| `image` | List\<[Image](../../models/shared/Image.md)> | :heavy_minus_sign: | N/A |
|
||||
| `index` | *Optional\<Long>* | :heavy_minus_sign: | When present, this represents the episode number for episodes, season number for seasons, or track number for audio tracks. |
|
||||
| `key` | *Optional\<Object>* | :heavy_minus_sign: | The key at which the item's details can be fetched. In many cases a metadata item may be passed without all the details (such as in a hub) and this key corresponds to the endpoint to fetch additional details. |
|
||||
| `lastViewedAt` | *Optional\<Long>* | :heavy_minus_sign: | When a user has watched or listened to an item, this contains a timestamp (epoch seconds) for that last consumption time. |
|
||||
| `leafCount` | *Optional\<Long>* | :heavy_minus_sign: | For shows and seasons, contains the number of total episodes. |
|
||||
| `media` | List\<[Media](../../models/shared/Media.md)> | :heavy_minus_sign: | N/A |
|
||||
| `originallyAvailableAt` | *Optional\<Object>* | :heavy_minus_sign: | When present, in the format YYYY-MM-DD [HH:MM:SS] (the hours/minutes/seconds part is not always present). The air date, or a higher resolution release date for an item, depending on type. For example, episodes usually have air date like 1979-08-10 (we don't use epoch seconds because media existed prior to 1970). In some cases, recorded over-the-air content has higher resolution air date which includes a time component. Albums and movies may have day-resolution release dates as well. |
|
||||
| `originalTitle` | *Optional\<Object>* | :heavy_minus_sign: | When present, used to indicate an item's original title, e.g. a movie's foreign title. |
|
||||
| `parentHero` | *Optional\<String>* | :heavy_minus_sign: | The `hero` of the parent |
|
||||
| `parentIndex` | *Optional\<Long>* | :heavy_minus_sign: | The `index` of the parent |
|
||||
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | The `key` of the parent |
|
||||
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The `ratingKey` of the parent |
|
||||
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | The `thumb` of the parent |
|
||||
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | The `title` of the parent |
|
||||
| `primaryExtraKey` | *Optional\<Object>* | :heavy_minus_sign: | Indicates that the item has a primary extra; for a movie, this is a trailer, and for a music track it is a music video. The URL points to the metadata details endpoint for the item. |
|
||||
| `prompt` | *Optional\<String>* | :heavy_minus_sign: | Prompt to give the user for this directory (such as `Search Movies`) |
|
||||
| `rating` | *Optional\<Double>* | :heavy_minus_sign: | When present, the rating for the item. The exact meaning and representation depends on where the rating was sourced from. |
|
||||
| `ratingArray` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `ratingCount` | *Optional\<Long>* | :heavy_minus_sign: | Number of ratings under this metadata |
|
||||
| `ratingImage` | *Optional\<Object>* | :heavy_minus_sign: | When present, indicates an image to be shown with the rating. This is passed back as a small set of defined URI values, e.g. rottentomatoes://image.rating.rotten. |
|
||||
| `ratingKey` | *Optional\<Object>* | :heavy_minus_sign: | This is the opaque string to be passed into timeline, scrobble, and rating endpoints to identify them. While it often appears to be numeric, this is not guaranteed. |
|
||||
| `role` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `search` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates this is a search directory |
|
||||
| `secondary` | *Optional\<Boolean>* | :heavy_minus_sign: | Used by old clients to provide nested menus allowing for primative (but structured) navigation. |
|
||||
| `skipChildren` | *Optional\<Boolean>* | :heavy_minus_sign: | When found on a show item, indicates that the children (seasons) should be skipped in favor of the grandchildren (episodes). Useful for mini-series, etc. |
|
||||
| `skipParent` | *Optional\<Boolean>* | :heavy_minus_sign: | When present on an episode or track item, indicates parent should be skipped in favor of grandparent (show). |
|
||||
| `sort` | List\<[Sort](../../models/shared/Sort.md)> | :heavy_minus_sign: | Typically only seen in metadata at a library's top level |
|
||||
| `studio` | *Optional\<Object>* | :heavy_minus_sign: | When present, the studio or label which produced an item (e.g. movie studio for movies, record label for albums). |
|
||||
| `subtype` | *Optional\<Object>* | :heavy_minus_sign: | The subtype of the video item, such as `photo` when the video item is in a photo library |
|
||||
| `summary` | *Optional\<Object>* | :heavy_minus_sign: | When present, the extended textual information about the item (e.g. movie plot, artist biography, album review). |
|
||||
| `tagline` | *Optional\<Object>* | :heavy_minus_sign: | When present, a pithy one-liner about the item (usually only seen for movies). |
|
||||
| `theme` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for theme music for the item (usually only for TV shows). |
|
||||
| `thumb` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for the poster or thumbnail for the item. When available for types like movie, it will be the poster graphic, but fall-back to the extracted media thumbnail. |
|
||||
| `titleSort` | *Optional\<Object>* | :heavy_minus_sign: | Whene present, this is the string used for sorting the item. It's usually the title with any leading articles removed (e.g. “Simpsons”). |
|
||||
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | In units of seconds since the epoch, returns the time at which the item was last changed (e.g. had its metadata updated). |
|
||||
| `userRating` | *Optional\<Double>* | :heavy_minus_sign: | When the user has rated an item, this contains the user rating |
|
||||
| `viewCount` | *Optional\<Long>* | :heavy_minus_sign: | When a users has completed watched or listened to an item, this attribute contains the number of consumptions. |
|
||||
| `viewedLeafCount` | *Optional\<Long>* | :heavy_minus_sign: | For shows and seasons, contains the number of viewed episodes. |
|
||||
| `viewOffset` | *Optional\<Long>* | :heavy_minus_sign: | When a user is in the process of viewing or listening to this item, this attribute contains the current offset, in units of milliseconds. |
|
||||
| `writer` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `year` | *Optional\<Long>* | :heavy_minus_sign: | When present, the year associated with the item's release (e.g. release year for a movie). |
|
||||
| `processingState` | [Optional\<ProcessingState>](../../models/operations/ProcessingState.md) | :heavy_minus_sign: | The state of processing if this generator is part of an optimizer playlist |
|
||||
| `processingStateContext` | [Optional\<ProcessingStateContext>](../../models/operations/ProcessingStateContext.md) | :heavy_minus_sign: | The error which could have occurred (or `good`) |
|
||||
| `additionalProperties` | Map\<String, *Object*> | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `title` | *String* | :heavy_check_mark: | The title of the item (e.g. “300” or “The Simpsons”) | |
|
||||
| `type` | *String* | :heavy_check_mark: | The type of the video item, such as `movie`, `episode`, or `clip`. | |
|
||||
| `absoluteIndex` | *Optional\<Integer>* | :heavy_minus_sign: | When present, contains the disc number for a track on multi-disc albums. | |
|
||||
| `addedAt` | *long* | :heavy_check_mark: | In units of seconds since the epoch, returns the time at which the item was added to the library. | |
|
||||
| `art` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for the background artwork for the item. | /library/metadata/58683/art/1703239236 |
|
||||
| `audienceRating` | *Optional\<Float>* | :heavy_minus_sign: | Some rating systems separate reviewer ratings from audience ratings | |
|
||||
| `audienceRatingImage` | *Optional\<String>* | :heavy_minus_sign: | A URI representing the image to be shown with the audience rating (e.g. rottentomatoes://image.rating.spilled). | |
|
||||
| `autotag` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `banner` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for a banner graphic for the item. | |
|
||||
| `chapterSource` | *Optional\<String>* | :heavy_minus_sign: | When present, indicates the source for the chapters in the media file. Can be media (the chapters were embedded in the media itself), agent (a metadata agent computed them), or mixed (a combination of the two). | media |
|
||||
| `childCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of child items associated with this media item. | 1 |
|
||||
| `composite` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for a composite image for descendent items (e.g. photo albums or playlists). | |
|
||||
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | If known, the content rating (e.g. MPAA) for an item. | |
|
||||
| `country` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `director` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | When present, the duration for the item, in units of milliseconds. | |
|
||||
| `filter` | List\<[Filter](../../models/shared/Filter.md)> | :heavy_minus_sign: | Typically only seen in metadata at a library's top level | |
|
||||
| `genre` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | The `art` of the grandparent | |
|
||||
| `grandparentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentHero` | *Optional\<String>* | :heavy_minus_sign: | The `hero` of the grandparent | |
|
||||
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | The `key` of the grandparent | |
|
||||
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The `ratingKey` of the grandparent | |
|
||||
| `grandparentTheme` | *Optional\<String>* | :heavy_minus_sign: | The `theme` of the grandparent | |
|
||||
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | The `thumb` of the grandparent | |
|
||||
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | The `title` of the grandparent | |
|
||||
| `guid` | *Optional\<String>* | :heavy_minus_sign: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `guids` | List\<[GetPlaylistGeneratorItemsGuids](../../models/operations/GetPlaylistGeneratorItemsGuids.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `hero` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for a hero image for the item. | |
|
||||
| `image` | List\<[Image](../../models/shared/Image.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `index` | *Optional\<Integer>* | :heavy_minus_sign: | When present, this represents the episode number for episodes, season number for seasons, or track number for audio tracks. | |
|
||||
| `key` | *String* | :heavy_check_mark: | The key at which the item's details can be fetched. In many cases a metadata item may be passed without all the details (such as in a hub) and this key corresponds to the endpoint to fetch additional details. | |
|
||||
| `lastViewedAt` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1556281940 |
|
||||
| `leafCount` | *Optional\<Integer>* | :heavy_minus_sign: | For shows and seasons, contains the number of total episodes. | |
|
||||
| `media` | List\<[Media](../../models/shared/Media.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_minus_sign: | When present, in the format YYYY-MM-DD [HH:MM:SS] (the hours/minutes/seconds part is not always present). The air date, or a higher resolution release date for an item, depending on type. For example, episodes usually have air date like 1979-08-10 (we don't use epoch seconds because media existed prior to 1970). In some cases, recorded over-the-air content has higher resolution air date which includes a time component. Albums and movies may have day-resolution release dates as well. | 2022-12-14 |
|
||||
| `originalTitle` | *Optional\<String>* | :heavy_minus_sign: | When present, used to indicate an item's original title, e.g. a movie's foreign title. | |
|
||||
| `parentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `parentHero` | *Optional\<String>* | :heavy_minus_sign: | The `hero` of the parent | |
|
||||
| `parentIndex` | *Optional\<Integer>* | :heavy_minus_sign: | The `index` of the parent | |
|
||||
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | The `key` of the parent | |
|
||||
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The `ratingKey` of the parent | |
|
||||
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | The `thumb` of the parent | |
|
||||
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | The `title` of the parent | |
|
||||
| `primaryExtraKey` | *Optional\<String>* | :heavy_minus_sign: | Indicates that the item has a primary extra; for a movie, this is a trailer, and for a music track it is a music video. The URL points to the metadata details endpoint for the item. | |
|
||||
| `prompt` | *Optional\<String>* | :heavy_minus_sign: | Prompt to give the user for this directory (such as `Search Movies`) | |
|
||||
| `rating` | *Optional\<Float>* | :heavy_minus_sign: | When present, the rating for the item. The exact meaning and representation depends on where the rating was sourced from. | |
|
||||
| `ratingArray` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `ratingCount` | *Optional\<Integer>* | :heavy_minus_sign: | Number of ratings under this metadata | |
|
||||
| `ratingImage` | *Optional\<String>* | :heavy_minus_sign: | When present, indicates an image to be shown with the rating. This is passed back as a small set of defined URI values, e.g. rottentomatoes://image.rating.rotten. | |
|
||||
| `ratingKey` | *Optional\<String>* | :heavy_minus_sign: | This is the opaque string to be passed into timeline, scrobble, and rating endpoints to identify them. While it often appears to be numeric, this is not guaranteed. | |
|
||||
| `role` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `search` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates this is a search directory | |
|
||||
| `secondary` | *Optional\<Boolean>* | :heavy_minus_sign: | Used by old clients to provide nested menus allowing for primative (but structured) navigation. | |
|
||||
| `skipChildren` | *Optional\<Boolean>* | :heavy_minus_sign: | When found on a show item, indicates that the children (seasons) should be skipped in favor of the grandchildren (episodes). Useful for mini-series, etc. | |
|
||||
| `skipParent` | *Optional\<Boolean>* | :heavy_minus_sign: | When present on an episode or track item, indicates parent should be skipped in favor of grandparent (show). | |
|
||||
| `sort` | List\<[Sort](../../models/shared/Sort.md)> | :heavy_minus_sign: | Typically only seen in metadata at a library's top level | |
|
||||
| `studio` | *Optional\<String>* | :heavy_minus_sign: | When present, the studio or label which produced an item (e.g. movie studio for movies, record label for albums). | |
|
||||
| `subtype` | *Optional\<String>* | :heavy_minus_sign: | The subtype of the video item, such as `photo` when the video item is in a photo library | |
|
||||
| `summary` | *Optional\<String>* | :heavy_minus_sign: | When present, the extended textual information about the item (e.g. movie plot, artist biography, album review). | |
|
||||
| `tagline` | *Optional\<String>* | :heavy_minus_sign: | When present, a pithy one-liner about the item (usually only seen for movies). | |
|
||||
| `theme` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for theme music for the item (usually only for TV shows). | /library/metadata/1/theme/1705636920 |
|
||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for the poster or thumbnail for the item. When available for types like movie, it will be the poster graphic, but fall-back to the extracted media thumbnail. | /library/metadata/58683/thumb/1703239236 |
|
||||
| `titleSort` | *Optional\<String>* | :heavy_minus_sign: | Whene present, this is the string used for sorting the item. It's usually the title with any leading articles removed (e.g. “Simpsons”). | |
|
||||
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | In units of seconds since the epoch, returns the time at which the item was last changed (e.g. had its metadata updated). | |
|
||||
| `userRating` | *Optional\<Float>* | :heavy_minus_sign: | When the user has rated an item, this contains the user rating | |
|
||||
| `viewCount` | *Optional\<Integer>* | :heavy_minus_sign: | When a users has completed watched or listened to an item, this attribute contains the number of consumptions. | |
|
||||
| `viewedLeafCount` | *Optional\<Integer>* | :heavy_minus_sign: | For shows and seasons, contains the number of viewed episodes. | |
|
||||
| `viewOffset` | *Optional\<Integer>* | :heavy_minus_sign: | When a user is in the process of viewing or listening to this item, this attribute contains the current offset, in units of milliseconds. | |
|
||||
| `writer` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | When present, the year associated with the item's release (e.g. release year for a movie). | |
|
||||
| `processingState` | [Optional\<ProcessingState>](../../models/operations/ProcessingState.md) | :heavy_minus_sign: | The state of processing if this generator is part of an optimizer playlist | |
|
||||
| `processingStateContext` | [Optional\<ProcessingStateContext>](../../models/operations/ProcessingStateContext.md) | :heavy_minus_sign: | The error which could have occurred (or `good`) | |
|
||||
| `additionalProperties` | Map\<String, *Object*> | :heavy_minus_sign: | N/A | |
|
||||
@@ -3,20 +3,20 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `sectionId` | *long* | :heavy_check_mark: | Section identifier | |
|
||||
| `updatedAt` | *long* | :heavy_check_mark: | The update time of the image. Used for busting cache. | |
|
||||
| `mediaQuery` | [Optional\<MediaQuery>](../../models/shared/MediaQuery.md) | :heavy_minus_sign: | This is a complex query built of several parameters. See [API Info section](#section/API-Info/Media-Queries) for information on building media queries | |
|
||||
| `composite` | [Optional\<Composite>](../../models/shared/Composite.md) | :heavy_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `sectionId` | *long* | :heavy_check_mark: | Section identifier | |
|
||||
| `updatedAt` | *long* | :heavy_check_mark: | The update time of the image. Used for busting cache. | |
|
||||
| `mediaQuery` | [Optional\<MediaQuery>](../../models/shared/MediaQuery.md) | :heavy_minus_sign: | A querystring-based filtering language used to select subsets of media. Can be provided as an object with typed properties for type safety, or as a string for complex queries with operators and boolean logic.<br/><br/>The query supports:<br/>- Fields: integer, boolean, tag, string, date, language<br/>- Operators: =, !=, ==, !==, <=, >=, >>=, <<= (varies by field type)<br/>- Boolean operators: & (AND), , (OR), push/pop (parentheses), or=1 (explicit OR)<br/>- Sorting: sort parameter with :desc, :nullsLast modifiers<br/>- Grouping: group parameter<br/>- Limits: limit parameter<br/><br/>Examples:<br/>- Object format: `{type: 4, sourceType: 2, title: "24"}` → `type=4&sourceType=2&title=24`<br/>- String format: `type=4&sourceType=2&title==24` - type = 4 AND sourceType = 2 AND title = "24"<br/>- Complex: `push=1&index=1&or=1&rating=2&pop=1&duration=10` - (index = 1 OR rating = 2) AND duration = 10<br/><br/>See [API Info section](#section/API-Info/Media-Queries) for detailed information on building media queries.<br/> | {<br/>"type": 4,<br/>"sourceType": 2,<br/>"sort": "duration:desc,index"<br/>} |
|
||||
| `composite` | [Optional\<Composite>](../../models/shared/Composite.md) | :heavy_minus_sign: | N/A | |
|
||||
@@ -8,4 +8,4 @@
|
||||
| `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\<?>](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 |
|
||||
| `requestHandlerSlashGetResponses200` | [Optional\<RequestHandlerSlashGetResponses200>](../../models/shared/RequestHandlerSlashGetResponses200.md) | :heavy_minus_sign: | OK |
|
||||
| `librarySections` | [Optional\<LibrarySections>](../../models/shared/LibrarySections.md) | :heavy_minus_sign: | OK |
|
||||
12
docs/models/operations/GetServerResourcesRequest.md
Normal file
12
docs/models/operations/GetServerResourcesRequest.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetServerResourcesRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `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 |
|
||||
11
docs/models/operations/GetServerResourcesResponse.md
Normal file
11
docs/models/operations/GetServerResourcesResponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetServerResourcesResponse
|
||||
|
||||
|
||||
## 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\<?>](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 |
|
||||
| `plexDevices` | List\<[PlexDevice](../../models/shared/PlexDevice.md)> | :heavy_minus_sign: | List of Plex Devices. This includes Plex hosted servers and clients |
|
||||
@@ -3,17 +3,17 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `type` | *Optional\<Long>* | :heavy_minus_sign: | The metadata type to filter by | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `type` | [Optional\<MediaType>](../../models/shared/MediaType.md) | :heavy_minus_sign: | The type of media to retrieve or filter by.<br/><br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>5 = artist<br/>6 = album<br/>7 = track<br/>8 = photo_album<br/>9 = photo<br/><br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
13
docs/models/operations/GetTasksButlerTask.md
Normal file
13
docs/models/operations/GetTasksButlerTask.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetTasksButlerTask
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `description` | *Optional\<String>* | :heavy_minus_sign: | A user-friendly description of the task |
|
||||
| `enabled` | *Optional\<Boolean>* | :heavy_minus_sign: | Whether this task is enabled or not |
|
||||
| `interval` | *Optional\<Long>* | :heavy_minus_sign: | The interval (in days) of when this task is run. A value of 1 is run every day, 7 is every week, etc. |
|
||||
| `name` | *Optional\<String>* | :heavy_minus_sign: | The name of the task |
|
||||
| `scheduleRandomized` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether the timing of the task is randomized within the butler interval |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | A user-friendly title of the task |
|
||||
18
docs/models/operations/GetTokenDetailsRequest.md
Normal file
18
docs/models/operations/GetTokenDetailsRequest.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetTokenDetailsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
11
docs/models/operations/GetTokenDetailsResponse.md
Normal file
11
docs/models/operations/GetTokenDetailsResponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetTokenDetailsResponse
|
||||
|
||||
|
||||
## 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\<?>](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 |
|
||||
| `userPlexAccount` | [Optional\<UserPlexAccount>](../../models/shared/UserPlexAccount.md) | :heavy_minus_sign: | Logged in user details |
|
||||
15
docs/models/operations/GetUsersMediaContainer.md
Normal file
15
docs/models/operations/GetUsersMediaContainer.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# GetUsersMediaContainer
|
||||
|
||||
Container holding user and server details.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| `friendlyName` | *String* | :heavy_check_mark: | The friendly name of the Plex instance. | myPlex |
|
||||
| `identifier` | *String* | :heavy_check_mark: | N/A | com.plexapp.plugins.myplex |
|
||||
| `machineIdentifier` | *String* | :heavy_check_mark: | Unique Machine identifier of the Plex server. | 3dff4c4da3b1229a649aa574a9e2b419a684a20e |
|
||||
| `totalSize` | *long* | :heavy_check_mark: | Total number of users. | 30 |
|
||||
| `size` | *long* | :heavy_check_mark: | Number of users in the current response. | 30 |
|
||||
| `user` | List\<[User](../../models/operations/User.md)> | :heavy_check_mark: | List of users with access to the Plex server. | |
|
||||
18
docs/models/operations/GetUsersRequest.md
Normal file
18
docs/models/operations/GetUsersRequest.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetUsersRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
11
docs/models/operations/GetUsersResponse.md
Normal file
11
docs/models/operations/GetUsersResponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetUsersResponse
|
||||
|
||||
|
||||
## 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\<?>](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\<GetUsersResponseBody>](../../models/operations/GetUsersResponseBody.md) | :heavy_minus_sign: | Successful response with media container data in JSON |
|
||||
10
docs/models/operations/GetUsersResponseBody.md
Normal file
10
docs/models/operations/GetUsersResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetUsersResponseBody
|
||||
|
||||
Successful response with media container data in JSON
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [Optional\<GetUsersMediaContainer>](../../models/operations/GetUsersMediaContainer.md) | :heavy_minus_sign: | Container holding user and server details. |
|
||||
8
docs/models/operations/Guids.md
Normal file
8
docs/models/operations/Guids.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Guids
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *String* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |
|
||||
11
docs/models/operations/Home.md
Normal file
11
docs/models/operations/Home.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Home
|
||||
|
||||
Indicates if the user is part of a home group.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
11
docs/models/operations/IncludeHttps.md
Normal file
11
docs/models/operations/IncludeHttps.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# IncludeHttps
|
||||
|
||||
Include Https entries in the results
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `False` | 0 |
|
||||
| `True` | 1 |
|
||||
11
docs/models/operations/IncludeIPv6.md
Normal file
11
docs/models/operations/IncludeIPv6.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# IncludeIPv6
|
||||
|
||||
Include IPv6 entries in the results
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `False` | 0 |
|
||||
| `True` | 1 |
|
||||
13
docs/models/operations/IncludeRelay.md
Normal file
13
docs/models/operations/IncludeRelay.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# IncludeRelay
|
||||
|
||||
Include Relay addresses in the results
|
||||
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `False` | 0 |
|
||||
| `True` | 1 |
|
||||
7
docs/models/operations/InternalPaymentMethod.md
Normal file
7
docs/models/operations/InternalPaymentMethod.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# InternalPaymentMethod
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
@@ -3,18 +3,22 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `mediaQuery` | [Optional\<MediaQuery>](../../models/shared/MediaQuery.md) | :heavy_minus_sign: | This is a complex query built of several parameters. See [API Info section](#section/API-Info/Media-Queries) for information on building media queries | |
|
||||
| `sectionId` | *String* | :heavy_check_mark: | The id of the section | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `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 |
|
||||
| `mediaQuery` | [Optional\<MediaQuery>](../../models/shared/MediaQuery.md) | :heavy_minus_sign: | A querystring-based filtering language used to select subsets of media. Can be provided as an object with typed properties for type safety, or as a string for complex queries with operators and boolean logic.<br/><br/>The query supports:<br/>- Fields: integer, boolean, tag, string, date, language<br/>- Operators: =, !=, ==, !==, <=, >=, >>=, <<= (varies by field type)<br/>- Boolean operators: & (AND), , (OR), push/pop (parentheses), or=1 (explicit OR)<br/>- Sorting: sort parameter with :desc, :nullsLast modifiers<br/>- Grouping: group parameter<br/>- Limits: limit parameter<br/><br/>Examples:<br/>- Object format: `{type: 4, sourceType: 2, title: "24"}` → `type=4&sourceType=2&title=24`<br/>- String format: `type=4&sourceType=2&title==24` - type = 4 AND sourceType = 2 AND title = "24"<br/>- Complex: `push=1&index=1&or=1&rating=2&pop=1&duration=10` - (index = 1 OR rating = 2) AND duration = 10<br/><br/>See [API Info section](#section/API-Info/Media-Queries) for detailed information on building media queries.<br/> | {<br/>"type": 4,<br/>"sourceType": 2,<br/>"sort": "duration:desc,index"<br/>} |
|
||||
| `includeMeta` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||
| `includeGuids` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
|
||||
| `sectionId` | *String* | :heavy_check_mark: | The id of the section | |
|
||||
12
docs/models/operations/MailingListStatus.md
Normal file
12
docs/models/operations/MailingListStatus.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# MailingListStatus
|
||||
|
||||
Your current mailing list status
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------- | -------------- |
|
||||
| `Active` | active |
|
||||
| `Unsubscribed` | unsubscribed |
|
||||
| `Removed` | removed |
|
||||
@@ -10,76 +10,80 @@ Metadata items can often live in a hierarchy with relationships between them. F
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `player` | [Optional\<Player>](../../models/shared/Player.md) | :heavy_minus_sign: | Information about the player being used for playback |
|
||||
| `session` | [Optional\<Session>](../../models/shared/Session.md) | :heavy_minus_sign: | Information about the playback session |
|
||||
| `user` | [Optional\<User>](../../models/shared/User.md) | :heavy_minus_sign: | The user playing the content |
|
||||
| `title` | *Optional\<Object>* | :heavy_minus_sign: | The title of the item (e.g. “300” or “The Simpsons”) |
|
||||
| `type` | *Optional\<Object>* | :heavy_minus_sign: | The type of the video item, such as `movie`, `episode`, or `clip`. |
|
||||
| `absoluteIndex` | *Optional\<Long>* | :heavy_minus_sign: | When present, contains the disc number for a track on multi-disc albums. |
|
||||
| `addedAt` | *Optional\<Long>* | :heavy_minus_sign: | In units of seconds since the epoch, returns the time at which the item was added to the library. |
|
||||
| `art` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for the background artwork for the item. |
|
||||
| `audienceRating` | *Optional\<Double>* | :heavy_minus_sign: | Some rating systems separate reviewer ratings from audience ratings |
|
||||
| `audienceRatingImage` | *Optional\<Object>* | :heavy_minus_sign: | A URI representing the image to be shown with the audience rating (e.g. rottentomatoes://image.rating.spilled). |
|
||||
| `autotag` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `banner` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for a banner graphic for the item. |
|
||||
| `chapterSource` | *Optional\<Object>* | :heavy_minus_sign: | When present, indicates the source for the chapters in the media file. Can be media (the chapters were embedded in the media itself), agent (a metadata agent computed them), or mixed (a combination of the two). |
|
||||
| `composite` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for a composite image for descendent items (e.g. photo albums or playlists). |
|
||||
| `contentRating` | *Optional\<Object>* | :heavy_minus_sign: | If known, the content rating (e.g. MPAA) for an item. |
|
||||
| `country` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `director` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `duration` | *Optional\<Long>* | :heavy_minus_sign: | When present, the duration for the item, in units of milliseconds. |
|
||||
| `filter` | List\<[Filter](../../models/shared/Filter.md)> | :heavy_minus_sign: | Typically only seen in metadata at a library's top level |
|
||||
| `genre` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | The `art` of the grandparent |
|
||||
| `grandparentHero` | *Optional\<String>* | :heavy_minus_sign: | The `hero` of the grandparent |
|
||||
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | The `key` of the grandparent |
|
||||
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The `ratingKey` of the grandparent |
|
||||
| `grandparentTheme` | *Optional\<String>* | :heavy_minus_sign: | The `theme` of the grandparent |
|
||||
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | The `thumb` of the grandparent |
|
||||
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | The `title` of the grandparent |
|
||||
| `guid` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `hero` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for a hero image for the item. |
|
||||
| `image` | List\<[Image](../../models/shared/Image.md)> | :heavy_minus_sign: | N/A |
|
||||
| `index` | *Optional\<Long>* | :heavy_minus_sign: | When present, this represents the episode number for episodes, season number for seasons, or track number for audio tracks. |
|
||||
| `key` | *Optional\<Object>* | :heavy_minus_sign: | The key at which the item's details can be fetched. In many cases a metadata item may be passed without all the details (such as in a hub) and this key corresponds to the endpoint to fetch additional details. |
|
||||
| `lastViewedAt` | *Optional\<Long>* | :heavy_minus_sign: | When a user has watched or listened to an item, this contains a timestamp (epoch seconds) for that last consumption time. |
|
||||
| `leafCount` | *Optional\<Long>* | :heavy_minus_sign: | For shows and seasons, contains the number of total episodes. |
|
||||
| `media` | List\<[Media](../../models/shared/Media.md)> | :heavy_minus_sign: | N/A |
|
||||
| `originallyAvailableAt` | *Optional\<Object>* | :heavy_minus_sign: | When present, in the format YYYY-MM-DD [HH:MM:SS] (the hours/minutes/seconds part is not always present). The air date, or a higher resolution release date for an item, depending on type. For example, episodes usually have air date like 1979-08-10 (we don't use epoch seconds because media existed prior to 1970). In some cases, recorded over-the-air content has higher resolution air date which includes a time component. Albums and movies may have day-resolution release dates as well. |
|
||||
| `originalTitle` | *Optional\<Object>* | :heavy_minus_sign: | When present, used to indicate an item's original title, e.g. a movie's foreign title. |
|
||||
| `parentHero` | *Optional\<String>* | :heavy_minus_sign: | The `hero` of the parent |
|
||||
| `parentIndex` | *Optional\<Long>* | :heavy_minus_sign: | The `index` of the parent |
|
||||
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | The `key` of the parent |
|
||||
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The `ratingKey` of the parent |
|
||||
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | The `thumb` of the parent |
|
||||
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | The `title` of the parent |
|
||||
| `primaryExtraKey` | *Optional\<Object>* | :heavy_minus_sign: | Indicates that the item has a primary extra; for a movie, this is a trailer, and for a music track it is a music video. The URL points to the metadata details endpoint for the item. |
|
||||
| `prompt` | *Optional\<String>* | :heavy_minus_sign: | Prompt to give the user for this directory (such as `Search Movies`) |
|
||||
| `rating` | *Optional\<Double>* | :heavy_minus_sign: | When present, the rating for the item. The exact meaning and representation depends on where the rating was sourced from. |
|
||||
| `ratingArray` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `ratingCount` | *Optional\<Long>* | :heavy_minus_sign: | Number of ratings under this metadata |
|
||||
| `ratingImage` | *Optional\<Object>* | :heavy_minus_sign: | When present, indicates an image to be shown with the rating. This is passed back as a small set of defined URI values, e.g. rottentomatoes://image.rating.rotten. |
|
||||
| `ratingKey` | *Optional\<Object>* | :heavy_minus_sign: | This is the opaque string to be passed into timeline, scrobble, and rating endpoints to identify them. While it often appears to be numeric, this is not guaranteed. |
|
||||
| `role` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `search` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates this is a search directory |
|
||||
| `secondary` | *Optional\<Boolean>* | :heavy_minus_sign: | Used by old clients to provide nested menus allowing for primative (but structured) navigation. |
|
||||
| `skipChildren` | *Optional\<Boolean>* | :heavy_minus_sign: | When found on a show item, indicates that the children (seasons) should be skipped in favor of the grandchildren (episodes). Useful for mini-series, etc. |
|
||||
| `skipParent` | *Optional\<Boolean>* | :heavy_minus_sign: | When present on an episode or track item, indicates parent should be skipped in favor of grandparent (show). |
|
||||
| `sort` | List\<[Sort](../../models/shared/Sort.md)> | :heavy_minus_sign: | Typically only seen in metadata at a library's top level |
|
||||
| `studio` | *Optional\<Object>* | :heavy_minus_sign: | When present, the studio or label which produced an item (e.g. movie studio for movies, record label for albums). |
|
||||
| `subtype` | *Optional\<Object>* | :heavy_minus_sign: | The subtype of the video item, such as `photo` when the video item is in a photo library |
|
||||
| `summary` | *Optional\<Object>* | :heavy_minus_sign: | When present, the extended textual information about the item (e.g. movie plot, artist biography, album review). |
|
||||
| `tagline` | *Optional\<Object>* | :heavy_minus_sign: | When present, a pithy one-liner about the item (usually only seen for movies). |
|
||||
| `theme` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for theme music for the item (usually only for TV shows). |
|
||||
| `thumb` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for the poster or thumbnail for the item. When available for types like movie, it will be the poster graphic, but fall-back to the extracted media thumbnail. |
|
||||
| `titleSort` | *Optional\<Object>* | :heavy_minus_sign: | Whene present, this is the string used for sorting the item. It's usually the title with any leading articles removed (e.g. “Simpsons”). |
|
||||
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | In units of seconds since the epoch, returns the time at which the item was last changed (e.g. had its metadata updated). |
|
||||
| `userRating` | *Optional\<Double>* | :heavy_minus_sign: | When the user has rated an item, this contains the user rating |
|
||||
| `viewCount` | *Optional\<Long>* | :heavy_minus_sign: | When a users has completed watched or listened to an item, this attribute contains the number of consumptions. |
|
||||
| `viewedLeafCount` | *Optional\<Long>* | :heavy_minus_sign: | For shows and seasons, contains the number of viewed episodes. |
|
||||
| `viewOffset` | *Optional\<Long>* | :heavy_minus_sign: | When a user is in the process of viewing or listening to this item, this attribute contains the current offset, in units of milliseconds. |
|
||||
| `writer` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `year` | *Optional\<Long>* | :heavy_minus_sign: | When present, the year associated with the item's release (e.g. release year for a movie). |
|
||||
| `additionalProperties` | Map\<String, *Object*> | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `player` | [Optional\<Player>](../../models/shared/Player.md) | :heavy_minus_sign: | Information about the player being used for playback | |
|
||||
| `session` | [Optional\<Session>](../../models/shared/Session.md) | :heavy_minus_sign: | Information about the playback session | |
|
||||
| `user` | [Optional\<User>](../../models/shared/User.md) | :heavy_minus_sign: | The user playing the content | |
|
||||
| `title` | *String* | :heavy_check_mark: | The title of the item (e.g. “300” or “The Simpsons”) | |
|
||||
| `type` | *String* | :heavy_check_mark: | The type of the video item, such as `movie`, `episode`, or `clip`. | |
|
||||
| `absoluteIndex` | *Optional\<Integer>* | :heavy_minus_sign: | When present, contains the disc number for a track on multi-disc albums. | |
|
||||
| `addedAt` | *long* | :heavy_check_mark: | In units of seconds since the epoch, returns the time at which the item was added to the library. | |
|
||||
| `art` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for the background artwork for the item. | /library/metadata/58683/art/1703239236 |
|
||||
| `audienceRating` | *Optional\<Float>* | :heavy_minus_sign: | Some rating systems separate reviewer ratings from audience ratings | |
|
||||
| `audienceRatingImage` | *Optional\<String>* | :heavy_minus_sign: | A URI representing the image to be shown with the audience rating (e.g. rottentomatoes://image.rating.spilled). | |
|
||||
| `autotag` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `banner` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for a banner graphic for the item. | |
|
||||
| `chapterSource` | *Optional\<String>* | :heavy_minus_sign: | When present, indicates the source for the chapters in the media file. Can be media (the chapters were embedded in the media itself), agent (a metadata agent computed them), or mixed (a combination of the two). | media |
|
||||
| `childCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of child items associated with this media item. | 1 |
|
||||
| `composite` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for a composite image for descendent items (e.g. photo albums or playlists). | |
|
||||
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | If known, the content rating (e.g. MPAA) for an item. | |
|
||||
| `country` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `director` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | When present, the duration for the item, in units of milliseconds. | |
|
||||
| `filter` | List\<[Filter](../../models/shared/Filter.md)> | :heavy_minus_sign: | Typically only seen in metadata at a library's top level | |
|
||||
| `genre` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | The `art` of the grandparent | |
|
||||
| `grandparentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentHero` | *Optional\<String>* | :heavy_minus_sign: | The `hero` of the grandparent | |
|
||||
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | The `key` of the grandparent | |
|
||||
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The `ratingKey` of the grandparent | |
|
||||
| `grandparentTheme` | *Optional\<String>* | :heavy_minus_sign: | The `theme` of the grandparent | |
|
||||
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | The `thumb` of the grandparent | |
|
||||
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | The `title` of the grandparent | |
|
||||
| `guid` | *Optional\<String>* | :heavy_minus_sign: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `guids` | List\<[Guids](../../models/operations/Guids.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `hero` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for a hero image for the item. | |
|
||||
| `image` | List\<[Image](../../models/shared/Image.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `index` | *Optional\<Integer>* | :heavy_minus_sign: | When present, this represents the episode number for episodes, season number for seasons, or track number for audio tracks. | |
|
||||
| `key` | *String* | :heavy_check_mark: | The key at which the item's details can be fetched. In many cases a metadata item may be passed without all the details (such as in a hub) and this key corresponds to the endpoint to fetch additional details. | |
|
||||
| `lastViewedAt` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1556281940 |
|
||||
| `leafCount` | *Optional\<Integer>* | :heavy_minus_sign: | For shows and seasons, contains the number of total episodes. | |
|
||||
| `media` | List\<[Media](../../models/shared/Media.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_minus_sign: | When present, in the format YYYY-MM-DD [HH:MM:SS] (the hours/minutes/seconds part is not always present). The air date, or a higher resolution release date for an item, depending on type. For example, episodes usually have air date like 1979-08-10 (we don't use epoch seconds because media existed prior to 1970). In some cases, recorded over-the-air content has higher resolution air date which includes a time component. Albums and movies may have day-resolution release dates as well. | 2022-12-14 |
|
||||
| `originalTitle` | *Optional\<String>* | :heavy_minus_sign: | When present, used to indicate an item's original title, e.g. a movie's foreign title. | |
|
||||
| `parentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `parentHero` | *Optional\<String>* | :heavy_minus_sign: | The `hero` of the parent | |
|
||||
| `parentIndex` | *Optional\<Integer>* | :heavy_minus_sign: | The `index` of the parent | |
|
||||
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | The `key` of the parent | |
|
||||
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The `ratingKey` of the parent | |
|
||||
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | The `thumb` of the parent | |
|
||||
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | The `title` of the parent | |
|
||||
| `primaryExtraKey` | *Optional\<String>* | :heavy_minus_sign: | Indicates that the item has a primary extra; for a movie, this is a trailer, and for a music track it is a music video. The URL points to the metadata details endpoint for the item. | |
|
||||
| `prompt` | *Optional\<String>* | :heavy_minus_sign: | Prompt to give the user for this directory (such as `Search Movies`) | |
|
||||
| `rating` | *Optional\<Float>* | :heavy_minus_sign: | When present, the rating for the item. The exact meaning and representation depends on where the rating was sourced from. | |
|
||||
| `ratingArray` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `ratingCount` | *Optional\<Integer>* | :heavy_minus_sign: | Number of ratings under this metadata | |
|
||||
| `ratingImage` | *Optional\<String>* | :heavy_minus_sign: | When present, indicates an image to be shown with the rating. This is passed back as a small set of defined URI values, e.g. rottentomatoes://image.rating.rotten. | |
|
||||
| `ratingKey` | *Optional\<String>* | :heavy_minus_sign: | This is the opaque string to be passed into timeline, scrobble, and rating endpoints to identify them. While it often appears to be numeric, this is not guaranteed. | |
|
||||
| `role` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `search` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates this is a search directory | |
|
||||
| `secondary` | *Optional\<Boolean>* | :heavy_minus_sign: | Used by old clients to provide nested menus allowing for primative (but structured) navigation. | |
|
||||
| `skipChildren` | *Optional\<Boolean>* | :heavy_minus_sign: | When found on a show item, indicates that the children (seasons) should be skipped in favor of the grandchildren (episodes). Useful for mini-series, etc. | |
|
||||
| `skipParent` | *Optional\<Boolean>* | :heavy_minus_sign: | When present on an episode or track item, indicates parent should be skipped in favor of grandparent (show). | |
|
||||
| `sort` | List\<[Sort](../../models/shared/Sort.md)> | :heavy_minus_sign: | Typically only seen in metadata at a library's top level | |
|
||||
| `studio` | *Optional\<String>* | :heavy_minus_sign: | When present, the studio or label which produced an item (e.g. movie studio for movies, record label for albums). | |
|
||||
| `subtype` | *Optional\<String>* | :heavy_minus_sign: | The subtype of the video item, such as `photo` when the video item is in a photo library | |
|
||||
| `summary` | *Optional\<String>* | :heavy_minus_sign: | When present, the extended textual information about the item (e.g. movie plot, artist biography, album review). | |
|
||||
| `tagline` | *Optional\<String>* | :heavy_minus_sign: | When present, a pithy one-liner about the item (usually only seen for movies). | |
|
||||
| `theme` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for theme music for the item (usually only for TV shows). | /library/metadata/1/theme/1705636920 |
|
||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for the poster or thumbnail for the item. When available for types like movie, it will be the poster graphic, but fall-back to the extracted media thumbnail. | /library/metadata/58683/thumb/1703239236 |
|
||||
| `titleSort` | *Optional\<String>* | :heavy_minus_sign: | Whene present, this is the string used for sorting the item. It's usually the title with any leading articles removed (e.g. “Simpsons”). | |
|
||||
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | In units of seconds since the epoch, returns the time at which the item was last changed (e.g. had its metadata updated). | |
|
||||
| `userRating` | *Optional\<Float>* | :heavy_minus_sign: | When the user has rated an item, this contains the user rating | |
|
||||
| `viewCount` | *Optional\<Integer>* | :heavy_minus_sign: | When a users has completed watched or listened to an item, this attribute contains the number of consumptions. | |
|
||||
| `viewedLeafCount` | *Optional\<Integer>* | :heavy_minus_sign: | For shows and seasons, contains the number of viewed episodes. | |
|
||||
| `viewOffset` | *Optional\<Integer>* | :heavy_minus_sign: | When a user is in the process of viewing or listening to this item, this attribute contains the current offset, in units of milliseconds. | |
|
||||
| `writer` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | When present, the year associated with the item's release (e.g. release year for a movie). | |
|
||||
| `additionalProperties` | Map\<String, *Object*> | :heavy_minus_sign: | N/A | |
|
||||
11
docs/models/operations/Owned.md
Normal file
11
docs/models/operations/Owned.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Owned
|
||||
|
||||
Indicates if the user owns the server.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
22
docs/models/operations/PastSubscription.md
Normal file
22
docs/models/operations/PastSubscription.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# PastSubscription
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
||||
| `id` | *Optional\<String>* | :heavy_check_mark: | N/A | |
|
||||
| `mode` | *Optional\<String>* | :heavy_check_mark: | N/A | |
|
||||
| `renewsAt` | *Optional\<Long>* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `endsAt` | *Optional\<Long>* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `canceled` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `gracePeriod` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `onHold` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `canReactivate` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `canUpgrade` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `canDowngrade` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `canConvert` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `type` | *String* | :heavy_check_mark: | N/A | plexpass |
|
||||
| `transfer` | *Optional\<String>* | :heavy_check_mark: | N/A | |
|
||||
| `state` | [PostUsersSignInDataState](../../models/operations/PostUsersSignInDataState.md) | :heavy_check_mark: | N/A | ended |
|
||||
| `billing` | [Billing](../../models/operations/Billing.md) | :heavy_check_mark: | N/A | |
|
||||
@@ -1,4 +1,4 @@
|
||||
# PathParamTask
|
||||
# PathParamButlerTask
|
||||
|
||||
The task name
|
||||
|
||||
11
docs/models/operations/Pending.md
Normal file
11
docs/models/operations/Pending.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Pending
|
||||
|
||||
Indicates if the server is pending approval.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
@@ -0,0 +1,11 @@
|
||||
# PostUsersSignInDataAuthenticationStatus
|
||||
|
||||
String representation of subscriptionActive
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------- | ---------- |
|
||||
| `INACTIVE` | Inactive |
|
||||
| `ACTIVE` | Active |
|
||||
19
docs/models/operations/PostUsersSignInDataRequest.md
Normal file
19
docs/models/operations/PostUsersSignInDataRequest.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# PostUsersSignInDataRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `requestBody` | [Optional\<PostUsersSignInDataRequestBody>](../../models/operations/PostUsersSignInDataRequestBody.md) | :heavy_minus_sign: | Login credentials | |
|
||||
13
docs/models/operations/PostUsersSignInDataRequestBody.md
Normal file
13
docs/models/operations/PostUsersSignInDataRequestBody.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# PostUsersSignInDataRequestBody
|
||||
|
||||
Login credentials
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||
| `login` | *String* | :heavy_check_mark: | N/A | username@email.com |
|
||||
| `password` | *String* | :heavy_check_mark: | N/A | password123 |
|
||||
| `rememberMe` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
||||
| `verificationCode` | *Optional\<String>* | :heavy_minus_sign: | N/A | 123456 |
|
||||
11
docs/models/operations/PostUsersSignInDataResponse.md
Normal file
11
docs/models/operations/PostUsersSignInDataResponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# PostUsersSignInDataResponse
|
||||
|
||||
|
||||
## 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\<?>](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 |
|
||||
| `userPlexAccount` | [Optional\<PostUsersSignInDataUserPlexAccount>](../../models/operations/PostUsersSignInDataUserPlexAccount.md) | :heavy_minus_sign: | Returns the user account data with a valid auth token |
|
||||
8
docs/models/operations/PostUsersSignInDataState.md
Normal file
8
docs/models/operations/PostUsersSignInDataState.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# PostUsersSignInDataState
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `ENDED` | ended |
|
||||
11
docs/models/operations/PostUsersSignInDataStatus.md
Normal file
11
docs/models/operations/PostUsersSignInDataStatus.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# PostUsersSignInDataStatus
|
||||
|
||||
String representation of subscriptionActive
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------- | ---------- |
|
||||
| `Inactive` | Inactive |
|
||||
| `Active` | Active |
|
||||
13
docs/models/operations/PostUsersSignInDataSubscription.md
Normal file
13
docs/models/operations/PostUsersSignInDataSubscription.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# PostUsersSignInDataSubscription
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `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 |
|
||||
| `paymentService` | *JsonNullable\<String>* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
|
||||
| `plan` | *JsonNullable\<String>* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |
|
||||
52
docs/models/operations/PostUsersSignInDataUserPlexAccount.md
Normal file
52
docs/models/operations/PostUsersSignInDataUserPlexAccount.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# PostUsersSignInDataUserPlexAccount
|
||||
|
||||
Returns the user account data with a valid auth token
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `adsConsent` | *JsonNullable\<Boolean>* | :heavy_minus_sign: | Unknown | |
|
||||
| `adsConsentReminderAt` | *JsonNullable\<Long>* | :heavy_minus_sign: | N/A | 1556281940 |
|
||||
| `adsConsentSetAt` | *JsonNullable\<Long>* | :heavy_minus_sign: | 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 | |
|
||||
| `confirmed` | *Optional\<Boolean>* | :heavy_minus_sign: | If the account has been confirmed | |
|
||||
| `country` | *Optional\<String>* | :heavy_minus_sign: | The account country | US |
|
||||
| `email` | *String* | :heavy_check_mark: | The account email address | username@email.com |
|
||||
| `emailOnlyAuth` | *Optional\<Boolean>* | :heavy_minus_sign: | If login with email only is enabled | |
|
||||
| `experimentalFeatures` | *Optional\<Boolean>* | :heavy_minus_sign: | If experimental features are enabled | |
|
||||
| `friendlyName` | *String* | :heavy_check_mark: | Your account full name | friendlyUsername |
|
||||
| `entitlements` | List\<*String*> | :heavy_minus_sign: | List of devices your allowed to use with this account | [] |
|
||||
| `guest` | *Optional\<Boolean>* | :heavy_minus_sign: | If the account is a Plex Home guest user | |
|
||||
| `hasPassword` | *Optional\<Boolean>* | :heavy_minus_sign: | If the account has a password | |
|
||||
| `home` | *Optional\<Boolean>* | :heavy_minus_sign: | If the account is a Plex Home user | |
|
||||
| `homeAdmin` | *Optional\<Boolean>* | :heavy_minus_sign: | If the account is the Plex Home admin | |
|
||||
| `homeSize` | *Optional\<Integer>* | :heavy_minus_sign: | The number of accounts in the Plex Home | 1 |
|
||||
| `id` | *int* | :heavy_check_mark: | The Plex account ID | 13692262 |
|
||||
| `joinedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `locale` | *JsonNullable\<String>* | :heavy_minus_sign: | The account locale | |
|
||||
| `mailingListActive` | *Optional\<Boolean>* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
|
||||
| `mailingListStatus` | [Optional\<MailingListStatus>](../../models/operations/MailingListStatus.md) | :heavy_minus_sign: | Your current mailing list status | active |
|
||||
| `maxHomeSize` | *Optional\<Integer>* | :heavy_minus_sign: | The maximum number of accounts allowed in the Plex Home | 15 |
|
||||
| ~~`pin`~~ | *Optional\<String>* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
|
||||
| `profile` | [Optional\<UserProfile>](../../models/shared/UserProfile.md) | :heavy_minus_sign: | N/A | |
|
||||
| `protected_` | *Optional\<Boolean>* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
|
||||
| `rememberExpiresAt` | *Optional\<Long>* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `restricted` | *Optional\<Boolean>* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
|
||||
| `roles` | List\<*String*> | :heavy_minus_sign: | [Might be removed] List of account roles. Plexpass membership listed here | |
|
||||
| `scrobbleTypes` | *Optional\<String>* | :heavy_minus_sign: | Unknown | |
|
||||
| `services` | List\<[Services](../../models/operations/Services.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `subscription` | [Optional\<Subscription>](../../models/operations/Subscription.md) | :heavy_minus_sign: | If the account's Plex Pass subscription is active | |
|
||||
| `subscriptionDescription` | *JsonNullable\<String>* | :heavy_minus_sign: | Description of the Plex Pass subscription | |
|
||||
| `subscriptions` | List\<[PostUsersSignInDataSubscription](../../models/operations/PostUsersSignInDataSubscription.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | URL of the account thumbnail | https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101 |
|
||||
| `title` | *String* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
|
||||
| `twoFactorEnabled` | *Optional\<Boolean>* | :heavy_minus_sign: | If two-factor authentication is enabled | |
|
||||
| `username` | *String* | :heavy_check_mark: | The account username | Username |
|
||||
| `uuid` | *String* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
|
||||
| `attributionPartner` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A | <nil> |
|
||||
| `pastSubscriptions` | List\<[PastSubscription](../../models/operations/PastSubscription.md)> | :heavy_check_mark: | N/A | |
|
||||
| `trials` | List\<[Trials](../../models/operations/Trials.md)> | :heavy_check_mark: | N/A | |
|
||||
11
docs/models/operations/Protected.md
Normal file
11
docs/models/operations/Protected.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Protected
|
||||
|
||||
Indicates whether the account is protected.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
11
docs/models/operations/Restricted.md
Normal file
11
docs/models/operations/Restricted.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Restricted
|
||||
|
||||
Indicates if the user has restricted access.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
16
docs/models/operations/Server.md
Normal file
16
docs/models/operations/Server.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# Server
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||
| `id` | *long* | :heavy_check_mark: | Unique ID of the server of the connected user | 907759180 |
|
||||
| `serverId` | *long* | :heavy_check_mark: | ID of the actual Plex server. | 9999999 |
|
||||
| `machineIdentifier` | *String* | :heavy_check_mark: | Machine identifier of the Plex server. | fbb8aa6be6e0c997c6268bc2b4431c8807f70a3 |
|
||||
| `name` | *String* | :heavy_check_mark: | Name of the Plex server of the connected user. | ConnectedUserFlix |
|
||||
| `lastSeenAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `numLibraries` | *long* | :heavy_check_mark: | Number of libraries in the server this user has access to. | 16 |
|
||||
| `allLibraries` | [Optional\<AllLibraries>](../../models/operations/AllLibraries.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `owned` | [Optional\<Owned>](../../models/operations/Owned.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `pending` | [Optional\<Pending>](../../models/operations/Pending.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
12
docs/models/operations/Services.md
Normal file
12
docs/models/operations/Services.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# Services
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
|
||||
| `identifier` | *String* | :heavy_check_mark: | N/A | metadata-dev |
|
||||
| `endpoint` | *String* | :heavy_check_mark: | N/A | https://epg.provider.plex.tv |
|
||||
| `token` | *Optional\<String>* | :heavy_check_mark: | N/A | DjoMtqFAGRL1uVtCyF1dKIorTbShJeqv |
|
||||
| `secret` | *Optional\<String>* | :heavy_check_mark: | N/A | |
|
||||
| `status` | [Status](../../models/operations/Status.md) | :heavy_check_mark: | N/A | online |
|
||||
@@ -3,17 +3,17 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `task` | [PathParamTask](../../models/operations/PathParamTask.md) | :heavy_check_mark: | The task name | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `butlerTask` | [PathParamButlerTask](../../models/operations/PathParamButlerTask.md) | :heavy_check_mark: | The task name | |
|
||||
@@ -1,20 +1,9 @@
|
||||
# Status
|
||||
|
||||
The state of this queue
|
||||
- deciding: At least one item is still being decided
|
||||
- waiting: At least one item is waiting for transcode and none are currently transcoding
|
||||
- processing: At least one item is being transcoded
|
||||
- done: All items are available (or potentially expired)
|
||||
- error: At least one item has encountered an error
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `DECIDING` | deciding |
|
||||
| `WAITING` | waiting |
|
||||
| `PROCESSING` | processing |
|
||||
| `DONE` | done |
|
||||
| `ERROR` | error |
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Online` | online |
|
||||
| `Offline` | offline |
|
||||
@@ -8,4 +8,4 @@
|
||||
| `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\<?>](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 |
|
||||
| `requestHandlerSlashGetResponses200` | [Optional\<RequestHandlerSlashGetResponses200>](../../models/shared/RequestHandlerSlashGetResponses200.md) | :heavy_minus_sign: | OK |
|
||||
| `librarySections` | [Optional\<LibrarySections>](../../models/shared/LibrarySections.md) | :heavy_minus_sign: | OK |
|
||||
@@ -16,4 +16,4 @@
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `task` | [Task](../../models/operations/Task.md) | :heavy_check_mark: | The task name | |
|
||||
| `butlerTask` | [ButlerTask](../../models/operations/ButlerTask.md) | :heavy_check_mark: | The task name | |
|
||||
15
docs/models/operations/Subscription.md
Normal file
15
docs/models/operations/Subscription.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# Subscription
|
||||
|
||||
If the account's Plex Pass subscription is active
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| `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\<PostUsersSignInDataStatus>](../../models/operations/PostUsersSignInDataStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
|
||||
| `paymentService` | *JsonNullable\<String>* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
|
||||
| `plan` | *JsonNullable\<String>* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |
|
||||
@@ -1,31 +0,0 @@
|
||||
# Task
|
||||
|
||||
The task name
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------------------------------- | -------------------------------------- |
|
||||
| `AUTOMATIC_UPDATES` | AutomaticUpdates |
|
||||
| `BACKUP_DATABASE` | BackupDatabase |
|
||||
| `BUTLER_TASK_GENERATE_AD_MARKERS` | ButlerTaskGenerateAdMarkers |
|
||||
| `BUTLER_TASK_GENERATE_CREDITS_MARKERS` | ButlerTaskGenerateCreditsMarkers |
|
||||
| `BUTLER_TASK_GENERATE_INTRO_MARKERS` | ButlerTaskGenerateIntroMarkers |
|
||||
| `BUTLER_TASK_GENERATE_VOICE_ACTIVITY` | ButlerTaskGenerateVoiceActivity |
|
||||
| `CLEAN_OLD_BUNDLES` | CleanOldBundles |
|
||||
| `CLEAN_OLD_CACHE_FILES` | CleanOldCacheFiles |
|
||||
| `DEEP_MEDIA_ANALYSIS` | DeepMediaAnalysis |
|
||||
| `GARBAGE_COLLECT_BLOBS` | GarbageCollectBlobs |
|
||||
| `GARBAGE_COLLECT_LIBRARY_MEDIA` | GarbageCollectLibraryMedia |
|
||||
| `GENERATE_BLUR_HASHES` | GenerateBlurHashes |
|
||||
| `GENERATE_CHAPTER_THUMBS` | GenerateChapterThumbs |
|
||||
| `GENERATE_MEDIA_INDEX_FILES` | GenerateMediaIndexFiles |
|
||||
| `LOUDNESS_ANALYSIS` | LoudnessAnalysis |
|
||||
| `MUSIC_ANALYSIS` | MusicAnalysis |
|
||||
| `OPTIMIZE_DATABASE` | OptimizeDatabase |
|
||||
| `REFRESH_EPG_GUIDES` | RefreshEpgGuides |
|
||||
| `REFRESH_LIBRARIES` | RefreshLibraries |
|
||||
| `REFRESH_LOCAL_MEDIA` | RefreshLocalMedia |
|
||||
| `REFRESH_PERIODIC_METADATA` | RefreshPeriodicMetadata |
|
||||
| `UPGRADE_MEDIA_ANALYSIS` | UpgradeMediaAnalysis |
|
||||
7
docs/models/operations/Trials.md
Normal file
7
docs/models/operations/Trials.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Trials
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
27
docs/models/operations/User.md
Normal file
27
docs/models/operations/User.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# User
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| `id` | *long* | :heavy_check_mark: | User's unique ID. | 22526914 |
|
||||
| `title` | *String* | :heavy_check_mark: | User's display name. | Plex User |
|
||||
| `username` | *String* | :heavy_check_mark: | User's username. | zgfuc7krcqfimrmb9lsl5j |
|
||||
| `email` | *String* | :heavy_check_mark: | User's email address. | zgfuc7krcqfimrmb9lsl5j@protonmail.com |
|
||||
| `recommendationsPlaylistId` | *JsonNullable\<String>* | :heavy_minus_sign: | ID of the user's recommendation playlist. | |
|
||||
| `thumb` | *String* | :heavy_check_mark: | URL to the user's avatar image. | https://plex.tv/users/3346028014e93acd/avatar?c=1731605021 |
|
||||
| `protected_` | [Optional\<Protected>](../../models/operations/Protected.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `home` | [Optional\<Home>](../../models/operations/Home.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `allowTuners` | [Optional\<AllowTuners>](../../models/operations/AllowTuners.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `allowSync` | [Optional\<AllowSync>](../../models/operations/AllowSync.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `allowCameraUpload` | [Optional\<AllowCameraUpload>](../../models/operations/AllowCameraUpload.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `allowChannels` | [Optional\<AllowChannels>](../../models/operations/AllowChannels.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `allowSubtitleAdmin` | [Optional\<AllowSubtitleAdmin>](../../models/operations/AllowSubtitleAdmin.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `filterAll` | *JsonNullable\<String>* | :heavy_minus_sign: | Filters applied for all content. | |
|
||||
| `filterMovies` | *JsonNullable\<String>* | :heavy_minus_sign: | Filters applied for movies. | |
|
||||
| `filterMusic` | *JsonNullable\<String>* | :heavy_minus_sign: | Filters applied for music. | |
|
||||
| `filterPhotos` | *JsonNullable\<String>* | :heavy_minus_sign: | Filters applied for photos. | |
|
||||
| `filterTelevision` | *Optional\<String>* | :heavy_minus_sign: | Filters applied for television. | |
|
||||
| `restricted` | [Optional\<Restricted>](../../models/operations/Restricted.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `server` | List\<[Server](../../models/operations/Server.md)> | :heavy_check_mark: | List of servers owned by the user. | |
|
||||
@@ -3,19 +3,19 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `query` | *String* | :heavy_check_mark: | The query term | |
|
||||
| `type` | *Optional\<Long>* | :heavy_minus_sign: | The metadata type to filter by | |
|
||||
| `limit` | *Optional\<Long>* | :heavy_minus_sign: | The number of items to return per hub. 3 if not specified | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *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 | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `query` | *String* | :heavy_check_mark: | The query term | |
|
||||
| `type` | [Optional\<MediaType>](../../models/shared/MediaType.md) | :heavy_minus_sign: | The type of media to retrieve or filter by.<br/><br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>5 = artist<br/>6 = album<br/>7 = track<br/>8 = photo_album<br/>9 = photo<br/><br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `limit` | *Optional\<Long>* | :heavy_minus_sign: | The number of items to return per hub. 3 if not specified | |
|
||||
12
docs/models/shared/AutoSelectSubtitle.md
Normal file
12
docs/models/shared/AutoSelectSubtitle.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# AutoSelectSubtitle
|
||||
|
||||
The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled)
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------------- | ----------------------- |
|
||||
| `ManuallySelected` | 0 |
|
||||
| `ShownWithForeignAudio` | 1 |
|
||||
| `AlwaysEnabled` | 2 |
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `ZERO` | 0 |
|
||||
| `ONE` | 1 |
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `False` | 0 |
|
||||
| `True` | 1 |
|
||||
14
docs/models/shared/Connections.md
Normal file
14
docs/models/shared/Connections.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# Connections
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `protocol` | [PlexDeviceProtocol](../../models/shared/PlexDeviceProtocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) | http |
|
||||
| `address` | *String* | :heavy_check_mark: | The (ip) address or domain name used for the connection | |
|
||||
| `port` | *int* | :heavy_check_mark: | The port used for the connection | |
|
||||
| `uri` | *String* | :heavy_check_mark: | The full URI of the connection | |
|
||||
| `local` | *boolean* | :heavy_check_mark: | If the connection is local address | |
|
||||
| `relay` | *boolean* | :heavy_check_mark: | If the connection is relayed through plex.direct | |
|
||||
| `iPv6` | *boolean* | :heavy_check_mark: | If the connection is using IPv6 | |
|
||||
13
docs/models/shared/DefaultAudioAccessibility.md
Normal file
13
docs/models/shared/DefaultAudioAccessibility.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# DefaultAudioAccessibility
|
||||
|
||||
The audio accessibility mode (0 = Prefer non-accessibility audio, 1 = Prefer accessibility audio, 2 = Only show accessibility audio, 3 = Only show non-accessibility audio)
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------------ | ------------------------ |
|
||||
| `PreferNonAccessibility` | 0 |
|
||||
| `PreferAccessibility` | 1 |
|
||||
| `OnlyAccessibility` | 2 |
|
||||
| `OnlyNonAccessibility` | 3 |
|
||||
13
docs/models/shared/DefaultSubtitleAccessibility.md
Normal file
13
docs/models/shared/DefaultSubtitleAccessibility.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# DefaultSubtitleAccessibility
|
||||
|
||||
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only show non-SDH subtitles)
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------- | -------------- |
|
||||
| `PreferNonSdh` | 0 |
|
||||
| `PreferSdh` | 1 |
|
||||
| `OnlySdh` | 2 |
|
||||
| `OnlyNonSdh` | 3 |
|
||||
13
docs/models/shared/DefaultSubtitleForced.md
Normal file
13
docs/models/shared/DefaultSubtitleForced.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# DefaultSubtitleForced
|
||||
|
||||
The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles)
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------- | ----------------- |
|
||||
| `PreferNonForced` | 0 |
|
||||
| `PreferForced` | 1 |
|
||||
| `OnlyForced` | 2 |
|
||||
| `OnlyNonForced` | 3 |
|
||||
8
docs/models/shared/Guids.md
Normal file
8
docs/models/shared/Guids.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Guids
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *String* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |
|
||||
@@ -10,74 +10,78 @@ Metadata items can often live in a hierarchy with relationships between them. F
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `title` | *Optional\<Object>* | :heavy_minus_sign: | The title of the item (e.g. “300” or “The Simpsons”) |
|
||||
| `type` | *Optional\<Object>* | :heavy_minus_sign: | The type of the video item, such as `movie`, `episode`, or `clip`. |
|
||||
| `absoluteIndex` | *Optional\<Long>* | :heavy_minus_sign: | When present, contains the disc number for a track on multi-disc albums. |
|
||||
| `addedAt` | *Optional\<Long>* | :heavy_minus_sign: | In units of seconds since the epoch, returns the time at which the item was added to the library. |
|
||||
| `art` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for the background artwork for the item. |
|
||||
| `audienceRating` | *Optional\<Double>* | :heavy_minus_sign: | Some rating systems separate reviewer ratings from audience ratings |
|
||||
| `audienceRatingImage` | *Optional\<Object>* | :heavy_minus_sign: | A URI representing the image to be shown with the audience rating (e.g. rottentomatoes://image.rating.spilled). |
|
||||
| `autotag` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `banner` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for a banner graphic for the item. |
|
||||
| `chapterSource` | *Optional\<Object>* | :heavy_minus_sign: | When present, indicates the source for the chapters in the media file. Can be media (the chapters were embedded in the media itself), agent (a metadata agent computed them), or mixed (a combination of the two). |
|
||||
| `composite` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for a composite image for descendent items (e.g. photo albums or playlists). |
|
||||
| `contentRating` | *Optional\<Object>* | :heavy_minus_sign: | If known, the content rating (e.g. MPAA) for an item. |
|
||||
| `country` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `director` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `duration` | *Optional\<Long>* | :heavy_minus_sign: | When present, the duration for the item, in units of milliseconds. |
|
||||
| `filter` | List\<[Filter](../../models/shared/Filter.md)> | :heavy_minus_sign: | Typically only seen in metadata at a library's top level |
|
||||
| `genre` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | The `art` of the grandparent |
|
||||
| `grandparentHero` | *Optional\<String>* | :heavy_minus_sign: | The `hero` of the grandparent |
|
||||
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | The `key` of the grandparent |
|
||||
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The `ratingKey` of the grandparent |
|
||||
| `grandparentTheme` | *Optional\<String>* | :heavy_minus_sign: | The `theme` of the grandparent |
|
||||
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | The `thumb` of the grandparent |
|
||||
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | The `title` of the grandparent |
|
||||
| `guid` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `hero` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for a hero image for the item. |
|
||||
| `image` | List\<[Image](../../models/shared/Image.md)> | :heavy_minus_sign: | N/A |
|
||||
| `index` | *Optional\<Long>* | :heavy_minus_sign: | When present, this represents the episode number for episodes, season number for seasons, or track number for audio tracks. |
|
||||
| `key` | *Optional\<Object>* | :heavy_minus_sign: | The key at which the item's details can be fetched. In many cases a metadata item may be passed without all the details (such as in a hub) and this key corresponds to the endpoint to fetch additional details. |
|
||||
| `lastViewedAt` | *Optional\<Long>* | :heavy_minus_sign: | When a user has watched or listened to an item, this contains a timestamp (epoch seconds) for that last consumption time. |
|
||||
| `leafCount` | *Optional\<Long>* | :heavy_minus_sign: | For shows and seasons, contains the number of total episodes. |
|
||||
| `media` | List\<[Media](../../models/shared/Media.md)> | :heavy_minus_sign: | N/A |
|
||||
| `originallyAvailableAt` | *Optional\<Object>* | :heavy_minus_sign: | When present, in the format YYYY-MM-DD [HH:MM:SS] (the hours/minutes/seconds part is not always present). The air date, or a higher resolution release date for an item, depending on type. For example, episodes usually have air date like 1979-08-10 (we don't use epoch seconds because media existed prior to 1970). In some cases, recorded over-the-air content has higher resolution air date which includes a time component. Albums and movies may have day-resolution release dates as well. |
|
||||
| `originalTitle` | *Optional\<Object>* | :heavy_minus_sign: | When present, used to indicate an item's original title, e.g. a movie's foreign title. |
|
||||
| `parentHero` | *Optional\<String>* | :heavy_minus_sign: | The `hero` of the parent |
|
||||
| `parentIndex` | *Optional\<Long>* | :heavy_minus_sign: | The `index` of the parent |
|
||||
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | The `key` of the parent |
|
||||
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The `ratingKey` of the parent |
|
||||
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | The `thumb` of the parent |
|
||||
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | The `title` of the parent |
|
||||
| `primaryExtraKey` | *Optional\<Object>* | :heavy_minus_sign: | Indicates that the item has a primary extra; for a movie, this is a trailer, and for a music track it is a music video. The URL points to the metadata details endpoint for the item. |
|
||||
| `prompt` | *Optional\<String>* | :heavy_minus_sign: | Prompt to give the user for this directory (such as `Search Movies`) |
|
||||
| `rating` | *Optional\<Double>* | :heavy_minus_sign: | When present, the rating for the item. The exact meaning and representation depends on where the rating was sourced from. |
|
||||
| `ratingArray` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `ratingCount` | *Optional\<Long>* | :heavy_minus_sign: | Number of ratings under this metadata |
|
||||
| `ratingImage` | *Optional\<Object>* | :heavy_minus_sign: | When present, indicates an image to be shown with the rating. This is passed back as a small set of defined URI values, e.g. rottentomatoes://image.rating.rotten. |
|
||||
| `ratingKey` | *Optional\<Object>* | :heavy_minus_sign: | This is the opaque string to be passed into timeline, scrobble, and rating endpoints to identify them. While it often appears to be numeric, this is not guaranteed. |
|
||||
| `role` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `search` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates this is a search directory |
|
||||
| `secondary` | *Optional\<Boolean>* | :heavy_minus_sign: | Used by old clients to provide nested menus allowing for primative (but structured) navigation. |
|
||||
| `skipChildren` | *Optional\<Boolean>* | :heavy_minus_sign: | When found on a show item, indicates that the children (seasons) should be skipped in favor of the grandchildren (episodes). Useful for mini-series, etc. |
|
||||
| `skipParent` | *Optional\<Boolean>* | :heavy_minus_sign: | When present on an episode or track item, indicates parent should be skipped in favor of grandparent (show). |
|
||||
| `sort` | List\<[Sort](../../models/shared/Sort.md)> | :heavy_minus_sign: | Typically only seen in metadata at a library's top level |
|
||||
| `studio` | *Optional\<Object>* | :heavy_minus_sign: | When present, the studio or label which produced an item (e.g. movie studio for movies, record label for albums). |
|
||||
| `subtype` | *Optional\<Object>* | :heavy_minus_sign: | The subtype of the video item, such as `photo` when the video item is in a photo library |
|
||||
| `summary` | *Optional\<Object>* | :heavy_minus_sign: | When present, the extended textual information about the item (e.g. movie plot, artist biography, album review). |
|
||||
| `tagline` | *Optional\<Object>* | :heavy_minus_sign: | When present, a pithy one-liner about the item (usually only seen for movies). |
|
||||
| `theme` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for theme music for the item (usually only for TV shows). |
|
||||
| `thumb` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for the poster or thumbnail for the item. When available for types like movie, it will be the poster graphic, but fall-back to the extracted media thumbnail. |
|
||||
| `titleSort` | *Optional\<Object>* | :heavy_minus_sign: | Whene present, this is the string used for sorting the item. It's usually the title with any leading articles removed (e.g. “Simpsons”). |
|
||||
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | In units of seconds since the epoch, returns the time at which the item was last changed (e.g. had its metadata updated). |
|
||||
| `userRating` | *Optional\<Double>* | :heavy_minus_sign: | When the user has rated an item, this contains the user rating |
|
||||
| `viewCount` | *Optional\<Long>* | :heavy_minus_sign: | When a users has completed watched or listened to an item, this attribute contains the number of consumptions. |
|
||||
| `viewedLeafCount` | *Optional\<Long>* | :heavy_minus_sign: | For shows and seasons, contains the number of viewed episodes. |
|
||||
| `viewOffset` | *Optional\<Long>* | :heavy_minus_sign: | When a user is in the process of viewing or listening to this item, this attribute contains the current offset, in units of milliseconds. |
|
||||
| `writer` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
|
||||
| `year` | *Optional\<Long>* | :heavy_minus_sign: | When present, the year associated with the item's release (e.g. release year for a movie). |
|
||||
| `metadataItem` | List\<[Items](../../models/shared/Items.md)> | :heavy_minus_sign: | N/A |
|
||||
| `additionalProperties` | Map\<String, *Object*> | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `title` | *String* | :heavy_check_mark: | The title of the item (e.g. “300” or “The Simpsons”) | |
|
||||
| `type` | *String* | :heavy_check_mark: | The type of the video item, such as `movie`, `episode`, or `clip`. | |
|
||||
| `absoluteIndex` | *Optional\<Integer>* | :heavy_minus_sign: | When present, contains the disc number for a track on multi-disc albums. | |
|
||||
| `addedAt` | *long* | :heavy_check_mark: | In units of seconds since the epoch, returns the time at which the item was added to the library. | |
|
||||
| `art` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for the background artwork for the item. | /library/metadata/58683/art/1703239236 |
|
||||
| `audienceRating` | *Optional\<Float>* | :heavy_minus_sign: | Some rating systems separate reviewer ratings from audience ratings | |
|
||||
| `audienceRatingImage` | *Optional\<String>* | :heavy_minus_sign: | A URI representing the image to be shown with the audience rating (e.g. rottentomatoes://image.rating.spilled). | |
|
||||
| `autotag` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `banner` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for a banner graphic for the item. | |
|
||||
| `chapterSource` | *Optional\<String>* | :heavy_minus_sign: | When present, indicates the source for the chapters in the media file. Can be media (the chapters were embedded in the media itself), agent (a metadata agent computed them), or mixed (a combination of the two). | media |
|
||||
| `childCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of child items associated with this media item. | 1 |
|
||||
| `composite` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for a composite image for descendent items (e.g. photo albums or playlists). | |
|
||||
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | If known, the content rating (e.g. MPAA) for an item. | |
|
||||
| `country` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `director` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | When present, the duration for the item, in units of milliseconds. | |
|
||||
| `filter` | List\<[Filter](../../models/shared/Filter.md)> | :heavy_minus_sign: | Typically only seen in metadata at a library's top level | |
|
||||
| `genre` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | The `art` of the grandparent | |
|
||||
| `grandparentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentHero` | *Optional\<String>* | :heavy_minus_sign: | The `hero` of the grandparent | |
|
||||
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | The `key` of the grandparent | |
|
||||
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The `ratingKey` of the grandparent | |
|
||||
| `grandparentTheme` | *Optional\<String>* | :heavy_minus_sign: | The `theme` of the grandparent | |
|
||||
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | The `thumb` of the grandparent | |
|
||||
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | The `title` of the grandparent | |
|
||||
| `guid` | *Optional\<String>* | :heavy_minus_sign: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `guids` | List\<[ItemsGuids](../../models/shared/ItemsGuids.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `hero` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for a hero image for the item. | |
|
||||
| `image` | List\<[Image](../../models/shared/Image.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `index` | *Optional\<Integer>* | :heavy_minus_sign: | When present, this represents the episode number for episodes, season number for seasons, or track number for audio tracks. | |
|
||||
| `key` | *String* | :heavy_check_mark: | The key at which the item's details can be fetched. In many cases a metadata item may be passed without all the details (such as in a hub) and this key corresponds to the endpoint to fetch additional details. | |
|
||||
| `lastViewedAt` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1556281940 |
|
||||
| `leafCount` | *Optional\<Integer>* | :heavy_minus_sign: | For shows and seasons, contains the number of total episodes. | |
|
||||
| `media` | List\<[Media](../../models/shared/Media.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_minus_sign: | When present, in the format YYYY-MM-DD [HH:MM:SS] (the hours/minutes/seconds part is not always present). The air date, or a higher resolution release date for an item, depending on type. For example, episodes usually have air date like 1979-08-10 (we don't use epoch seconds because media existed prior to 1970). In some cases, recorded over-the-air content has higher resolution air date which includes a time component. Albums and movies may have day-resolution release dates as well. | 2022-12-14 |
|
||||
| `originalTitle` | *Optional\<String>* | :heavy_minus_sign: | When present, used to indicate an item's original title, e.g. a movie's foreign title. | |
|
||||
| `parentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `parentHero` | *Optional\<String>* | :heavy_minus_sign: | The `hero` of the parent | |
|
||||
| `parentIndex` | *Optional\<Integer>* | :heavy_minus_sign: | The `index` of the parent | |
|
||||
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | The `key` of the parent | |
|
||||
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The `ratingKey` of the parent | |
|
||||
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | The `thumb` of the parent | |
|
||||
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | The `title` of the parent | |
|
||||
| `primaryExtraKey` | *Optional\<String>* | :heavy_minus_sign: | Indicates that the item has a primary extra; for a movie, this is a trailer, and for a music track it is a music video. The URL points to the metadata details endpoint for the item. | |
|
||||
| `prompt` | *Optional\<String>* | :heavy_minus_sign: | Prompt to give the user for this directory (such as `Search Movies`) | |
|
||||
| `rating` | *Optional\<Float>* | :heavy_minus_sign: | When present, the rating for the item. The exact meaning and representation depends on where the rating was sourced from. | |
|
||||
| `ratingArray` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `ratingCount` | *Optional\<Integer>* | :heavy_minus_sign: | Number of ratings under this metadata | |
|
||||
| `ratingImage` | *Optional\<String>* | :heavy_minus_sign: | When present, indicates an image to be shown with the rating. This is passed back as a small set of defined URI values, e.g. rottentomatoes://image.rating.rotten. | |
|
||||
| `ratingKey` | *Optional\<String>* | :heavy_minus_sign: | This is the opaque string to be passed into timeline, scrobble, and rating endpoints to identify them. While it often appears to be numeric, this is not guaranteed. | |
|
||||
| `role` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `search` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates this is a search directory | |
|
||||
| `secondary` | *Optional\<Boolean>* | :heavy_minus_sign: | Used by old clients to provide nested menus allowing for primative (but structured) navigation. | |
|
||||
| `skipChildren` | *Optional\<Boolean>* | :heavy_minus_sign: | When found on a show item, indicates that the children (seasons) should be skipped in favor of the grandchildren (episodes). Useful for mini-series, etc. | |
|
||||
| `skipParent` | *Optional\<Boolean>* | :heavy_minus_sign: | When present on an episode or track item, indicates parent should be skipped in favor of grandparent (show). | |
|
||||
| `sort` | List\<[Sort](../../models/shared/Sort.md)> | :heavy_minus_sign: | Typically only seen in metadata at a library's top level | |
|
||||
| `studio` | *Optional\<String>* | :heavy_minus_sign: | When present, the studio or label which produced an item (e.g. movie studio for movies, record label for albums). | |
|
||||
| `subtype` | *Optional\<String>* | :heavy_minus_sign: | The subtype of the video item, such as `photo` when the video item is in a photo library | |
|
||||
| `summary` | *Optional\<String>* | :heavy_minus_sign: | When present, the extended textual information about the item (e.g. movie plot, artist biography, album review). | |
|
||||
| `tagline` | *Optional\<String>* | :heavy_minus_sign: | When present, a pithy one-liner about the item (usually only seen for movies). | |
|
||||
| `theme` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for theme music for the item (usually only for TV shows). | /library/metadata/1/theme/1705636920 |
|
||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for the poster or thumbnail for the item. When available for types like movie, it will be the poster graphic, but fall-back to the extracted media thumbnail. | /library/metadata/58683/thumb/1703239236 |
|
||||
| `titleSort` | *Optional\<String>* | :heavy_minus_sign: | Whene present, this is the string used for sorting the item. It's usually the title with any leading articles removed (e.g. “Simpsons”). | |
|
||||
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | In units of seconds since the epoch, returns the time at which the item was last changed (e.g. had its metadata updated). | |
|
||||
| `userRating` | *Optional\<Float>* | :heavy_minus_sign: | When the user has rated an item, this contains the user rating | |
|
||||
| `viewCount` | *Optional\<Integer>* | :heavy_minus_sign: | When a users has completed watched or listened to an item, this attribute contains the number of consumptions. | |
|
||||
| `viewedLeafCount` | *Optional\<Integer>* | :heavy_minus_sign: | For shows and seasons, contains the number of viewed episodes. | |
|
||||
| `viewOffset` | *Optional\<Integer>* | :heavy_minus_sign: | When a user is in the process of viewing or listening to this item, this attribute contains the current offset, in units of milliseconds. | |
|
||||
| `writer` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | When present, the year associated with the item's release (e.g. release year for a movie). | |
|
||||
| `metadataItem` | List\<[Items](../../models/shared/Items.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `additionalProperties` | Map\<String, *Object*> | :heavy_minus_sign: | N/A | |
|
||||
8
docs/models/shared/ItemsGuids.md
Normal file
8
docs/models/shared/ItemsGuids.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# ItemsGuids
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *String* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |
|
||||
@@ -3,25 +3,26 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `type` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `agent` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `allowSync` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A |
|
||||
| `art` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `composite` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `content` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A |
|
||||
| `contentChangedAt` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
| `createdAt` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
| `directory` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A |
|
||||
| `filters` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether this section has filtering capabilities |
|
||||
| `hidden` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A |
|
||||
| `key` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `language` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `location` | List\<[LibrarySectionLocation](../../models/shared/LibrarySectionLocation.md)> | :heavy_minus_sign: | N/A |
|
||||
| `refreshing` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether this library section is currently scanning |
|
||||
| `scannedAt` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
| `scanner` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | The title of the library | Movies |
|
||||
| `type` | [MediaTypeString](../../models/shared/MediaTypeString.md) | :heavy_check_mark: | The type of media content in the Plex library. This can represent videos, music, or photos.<br/> | movie |
|
||||
| `agent` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
|
||||
| `allowSync` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
||||
| `art` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
|
||||
| `composite` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
|
||||
| `content` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
||||
| `contentChangedAt` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1556281940 |
|
||||
| `createdAt` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1556281940 |
|
||||
| `directory` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
||||
| `filters` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether this section has filtering capabilities | |
|
||||
| `hidden` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
||||
| `key` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
|
||||
| `language` | *String* | :heavy_check_mark: | N/A | |
|
||||
| `uuid` | *String* | :heavy_check_mark: | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-d3cc3401e7d6 |
|
||||
| `location` | List\<[LibrarySectionLocation](../../models/shared/LibrarySectionLocation.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `refreshing` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether this library section is currently scanning | |
|
||||
| `scannedAt` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1556281940 |
|
||||
| `scanner` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
|
||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
|
||||
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1556281940 |
|
||||
10
docs/models/shared/LibrarySections.md
Normal file
10
docs/models/shared/LibrarySections.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# LibrarySections
|
||||
|
||||
OK
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `mediaContainer` | [Optional\<LibrarySectionsMediaContainer>](../../models/shared/LibrarySectionsMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,4 +1,4 @@
|
||||
# RequestHandlerSlashGetResponses200Directory
|
||||
# LibrarySectionsDirectory
|
||||
|
||||
|
||||
## Fields
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user