mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-07 04:20:49 +00:00
Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
dcdcafc044 | ||
|
|
04db2979db | ||
|
|
c2eeb488c4 | ||
|
|
8194abfa99 | ||
|
|
26e1ac258e |
File diff suppressed because one or more lines are too long
@@ -7,13 +7,15 @@ generation:
|
|||||||
useClassNamesForArrayFields: true
|
useClassNamesForArrayFields: true
|
||||||
fixes:
|
fixes:
|
||||||
nameResolutionDec2023: true
|
nameResolutionDec2023: true
|
||||||
|
nameResolutionFeb2025: false
|
||||||
parameterOrderingFeb2024: true
|
parameterOrderingFeb2024: true
|
||||||
requestResponseComponentNamesFeb2024: true
|
requestResponseComponentNamesFeb2024: true
|
||||||
|
securityFeb2025: false
|
||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
oAuth2PasswordEnabled: false
|
oAuth2PasswordEnabled: false
|
||||||
java:
|
java:
|
||||||
version: 0.12.0
|
version: 0.14.1
|
||||||
additionalDependencies: []
|
additionalDependencies: []
|
||||||
additionalPlugins: []
|
additionalPlugins: []
|
||||||
artifactID: plexapi
|
artifactID: plexapi
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
speakeasyVersion: 1.487.1
|
speakeasyVersion: 1.528.1
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
@@ -8,19 +8,19 @@ sources:
|
|||||||
- latest
|
- latest
|
||||||
plexapi:
|
plexapi:
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:0efb9039972533bf1190dfc1ffb377429a8e486b6299442e732f662c1ffbeca6
|
sourceRevisionDigest: sha256:b5580df6ec4a386e12249ff13f35b916fe5559e101de4a816b53e47d6947f1a5
|
||||||
sourceBlobDigest: sha256:038d73166cc9db17f514d511cfe4365ea032f4ebcb247fa86b7aa1bba0e1ab46
|
sourceBlobDigest: sha256:6108b6c35fbe7e9163ffe0c804170f5e3a6edb63b8e745454ea8ee249bd790c3
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- speakeasy-sdk-regen-1739147238
|
- speakeasy-sdk-regen-1743640078
|
||||||
targets:
|
targets:
|
||||||
plexjava:
|
plexjava:
|
||||||
source: plexapi
|
source: plexapi
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:0efb9039972533bf1190dfc1ffb377429a8e486b6299442e732f662c1ffbeca6
|
sourceRevisionDigest: sha256:b5580df6ec4a386e12249ff13f35b916fe5559e101de4a816b53e47d6947f1a5
|
||||||
sourceBlobDigest: sha256:038d73166cc9db17f514d511cfe4365ea032f4ebcb247fa86b7aa1bba0e1ab46
|
sourceBlobDigest: sha256:6108b6c35fbe7e9163ffe0c804170f5e3a6edb63b8e745454ea8ee249bd790c3
|
||||||
codeSamplesNamespace: code-samples-java-plexjava
|
codeSamplesNamespace: code-samples-java-plexjava
|
||||||
codeSamplesRevisionDigest: sha256:2d1414485f745cc63505b9790fa16ac01e42822a6b28a5ff61486ffdd08ed8de
|
codeSamplesRevisionDigest: sha256:5ac1b6e0506bbf85ab353ce21dbf6646b6590efa4ba68ab778ba9836b378e0f6
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
@@ -42,3 +42,5 @@ workflow:
|
|||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
|
||||||
|
labelOverride:
|
||||||
|
fixedValue: PlexJava
|
||||||
|
|||||||
@@ -18,3 +18,5 @@ targets:
|
|||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
|
||||||
|
labelOverride:
|
||||||
|
fixedValue: PlexJava
|
||||||
|
|||||||
53
README.md
53
README.md
@@ -69,7 +69,7 @@ The samples below show how a published SDK artifact is used:
|
|||||||
|
|
||||||
Gradle:
|
Gradle:
|
||||||
```groovy
|
```groovy
|
||||||
implementation 'dev.plexapi:plexapi:0.12.0'
|
implementation 'dev.plexapi:plexapi:0.14.1'
|
||||||
```
|
```
|
||||||
|
|
||||||
Maven:
|
Maven:
|
||||||
@@ -77,7 +77,7 @@ Maven:
|
|||||||
<dependency>
|
<dependency>
|
||||||
<groupId>dev.plexapi</groupId>
|
<groupId>dev.plexapi</groupId>
|
||||||
<artifactId>plexapi</artifactId>
|
<artifactId>plexapi</artifactId>
|
||||||
<version>0.12.0</version>
|
<version>0.14.1</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -177,9 +177,12 @@ public class Application {
|
|||||||
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
|
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
|
||||||
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||||
* [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
* [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
||||||
|
* [getMediaArts](docs/sdks/library/README.md#getmediaarts) - Get Media Background Artwork
|
||||||
|
* [postMediaArts](docs/sdks/library/README.md#postmediaarts) - Upload Media Background Artwork
|
||||||
|
* [getMediaPosters](docs/sdks/library/README.md#getmediaposters) - Get Media Posters
|
||||||
|
* [postMediaPoster](docs/sdks/library/README.md#postmediaposter) - Upload Media Poster
|
||||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||||
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||||
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
|
||||||
|
|
||||||
### [log()](docs/sdks/log/README.md)
|
### [log()](docs/sdks/log/README.md)
|
||||||
|
|
||||||
@@ -320,13 +323,49 @@ public class Application {
|
|||||||
### Server Variables
|
### Server Variables
|
||||||
|
|
||||||
The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following builder methods are available when initializing the SDK client instance:
|
The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following builder methods are available when initializing the SDK client instance:
|
||||||
* `protocol(ServerProtocol protocol)`
|
|
||||||
* `ip(String ip)`
|
| Variable | BuilderMethod | Supported Values | Default | Description |
|
||||||
* `port(String port)`
|
| ---------- | ----------------------------------- | -------------------------- | --------------- | ---------------------------------------------- |
|
||||||
|
| `protocol` | `protocol(ServerProtocol protocol)` | - `"http"`<br/>- `"https"` | `"https"` | The protocol to use for the server connection |
|
||||||
|
| `ip` | `ip(String ip)` | java.lang.String | `"10.10.10.47"` | The IP address or hostname of your Plex Server |
|
||||||
|
| `port` | `port(String port)` | java.lang.String | `"32400"` | The port of your Plex Server |
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
```java
|
||||||
|
package hello.world;
|
||||||
|
|
||||||
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
|
import dev.plexapi.sdk.SDK.Builder.ServerProtocol;
|
||||||
|
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesBadRequest;
|
||||||
|
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesUnauthorized;
|
||||||
|
import dev.plexapi.sdk.models.operations.GetServerCapabilitiesResponse;
|
||||||
|
import java.lang.Exception;
|
||||||
|
|
||||||
|
public class Application {
|
||||||
|
|
||||||
|
public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {
|
||||||
|
|
||||||
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
|
.protocol(ServerProtocol.HTTPS)
|
||||||
|
.ip("e0c3:bcc0:6bac:dccc:c4ec:34b1:ca98:4cb9")
|
||||||
|
.port("40311")
|
||||||
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
|
.build();
|
||||||
|
|
||||||
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
|
.call();
|
||||||
|
|
||||||
|
if (res.object().isPresent()) {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### Override Server URL Per-Client
|
### Override Server URL Per-Client
|
||||||
|
|
||||||
The default server can also be overridden globally using the `.serverURL(String serverUrl)` builder method when initializing the SDK client instance. For example:
|
The default server can be overridden globally using the `.serverURL(String serverUrl)` builder method when initializing the SDK client instance. For example:
|
||||||
```java
|
```java
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
|
|||||||
42
RELEASES.md
42
RELEASES.md
@@ -258,4 +258,44 @@ Based on:
|
|||||||
### Generated
|
### Generated
|
||||||
- [java v0.12.0] .
|
- [java v0.12.0] .
|
||||||
### Releases
|
### Releases
|
||||||
- [Maven Central v0.12.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.12.0 - .
|
- [Maven Central v0.12.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.12.0 - .
|
||||||
|
|
||||||
|
## 2025-03-07 00:27:17
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.513.2 (2.545.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.13.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.13.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.13.0 - .
|
||||||
|
|
||||||
|
## 2025-03-09 00:24:27
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.513.4 (2.545.4) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.13.1] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.13.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.13.1 - .
|
||||||
|
|
||||||
|
## 2025-03-31 17:07:30
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.14.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.14.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.14.0 - .
|
||||||
|
|
||||||
|
## 2025-04-03 00:27:41
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.528.1 (2.565.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.14.1] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.14.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.14.1 - .
|
||||||
27
build.gradle
27
build.gradle
@@ -39,9 +39,12 @@ model {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
version = "${version}"
|
||||||
|
group = "${groupId}"
|
||||||
|
|
||||||
jar {
|
jar {
|
||||||
dependsOn(":generatePomFileForMavenPublication")
|
dependsOn(":generatePomFileForMavenPublication")
|
||||||
archiveBaseName = "plexapi"
|
archiveBaseName = "${artifactId}"
|
||||||
|
|
||||||
into("META-INF/maven/dev.plexapi/plexapi") {
|
into("META-INF/maven/dev.plexapi/plexapi") {
|
||||||
from("$buildDir/pom.xml")
|
from("$buildDir/pom.xml")
|
||||||
@@ -62,15 +65,12 @@ tasks.withType(Javadoc) {
|
|||||||
options.addStringOption('Xdoclint:none', '-quiet')
|
options.addStringOption('Xdoclint:none', '-quiet')
|
||||||
}
|
}
|
||||||
|
|
||||||
group = "dev.plexapi"
|
|
||||||
version = "0.12.0"
|
|
||||||
|
|
||||||
sourcesJar {
|
sourcesJar {
|
||||||
archiveBaseName = "plexapi"
|
archiveBaseName = "${artifactId}"
|
||||||
}
|
}
|
||||||
|
|
||||||
javadocJar {
|
javadocJar {
|
||||||
archiveBaseName = "plexapi"
|
archiveBaseName = "${artifactId}"
|
||||||
}
|
}
|
||||||
sonatypeCentralUpload {
|
sonatypeCentralUpload {
|
||||||
// This is your Sonatype generated username
|
// This is your Sonatype generated username
|
||||||
@@ -80,9 +80,9 @@ sonatypeCentralUpload {
|
|||||||
|
|
||||||
// This is a list of files to upload. Ideally you would point to your jar file, source and javadoc jar (required by central)
|
// This is a list of files to upload. Ideally you would point to your jar file, source and javadoc jar (required by central)
|
||||||
archives = files(
|
archives = files(
|
||||||
"$buildDir/libs/plexapi-${version}.jar",
|
"$buildDir/libs/${artifactId}-${version}.jar",
|
||||||
"$buildDir/libs/plexapi-${version}-sources.jar",
|
"$buildDir/libs/${artifactId}-${version}-sources.jar",
|
||||||
"$buildDir/libs/plexapi-${version}-javadoc.jar"
|
"$buildDir/libs/${artifactId}-${version}-javadoc.jar"
|
||||||
)
|
)
|
||||||
|
|
||||||
// This is the pom file to upload. This is required by central
|
// This is the pom file to upload. This is required by central
|
||||||
@@ -99,9 +99,11 @@ publishing {
|
|||||||
|
|
||||||
publications {
|
publications {
|
||||||
maven(MavenPublication) {
|
maven(MavenPublication) {
|
||||||
groupId = 'dev.plexapi'
|
// note that properties can't yet be used below!
|
||||||
artifactId = 'plexapi'
|
// https://github.com/gradle/gradle/issues/18619
|
||||||
version = '0.12.0'
|
groupId = "dev.plexapi"
|
||||||
|
artifactId = "plexapi"
|
||||||
|
version = "0.14.1"
|
||||||
|
|
||||||
from components.java
|
from components.java
|
||||||
|
|
||||||
@@ -152,7 +154,6 @@ dependencies {
|
|||||||
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.18.2'
|
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.18.2'
|
||||||
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.18.2'
|
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.18.2'
|
||||||
api('org.openapitools:jackson-databind-nullable:0.2.6') {exclude group: 'com.fasterxml.jackson.core', module: 'jackson-databind'}
|
api('org.openapitools:jackson-databind-nullable:0.2.6') {exclude group: 'com.fasterxml.jackson.core', module: 'jackson-databind'}
|
||||||
implementation 'org.apache.httpcomponents.client5:httpclient5:5.4.1'
|
|
||||||
implementation 'commons-io:commons-io:2.18.0'
|
implementation 'commons-io:commons-io:2.18.0'
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
448
codeSamples.yaml
448
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
@@ -1,10 +0,0 @@
|
|||||||
# GetOnDeckErrors
|
|
||||||
|
|
||||||
|
|
||||||
## 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 |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetOnDeckLibraryErrors
|
|
||||||
|
|
||||||
|
|
||||||
## 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 |
|
|
||||||
@@ -3,6 +3,6 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | Working NL Subs |
|
| `tag` | *String* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||||
@@ -1,8 +1,12 @@
|
|||||||
# Country
|
# Country
|
||||||
|
|
||||||
|
The filter query string for country media items.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | United States of America |
|
| `id` | *long* | :heavy_check_mark: | N/A | 259 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||||
|
| `filter` | *Optional\<String>* | :heavy_minus_sign: | N/A | country=19 |
|
||||||
@@ -3,6 +3,6 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | James Cameron |
|
| `tag` | *String* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||||
@@ -1,8 +1,12 @@
|
|||||||
# Genre
|
# Genre
|
||||||
|
|
||||||
|
The filter query string for similar items.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | Adventure |
|
| `id` | *long* | :heavy_check_mark: | N/A | 259 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | N/A | genre=19 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||||
@@ -3,6 +3,6 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||||
| `tag` | *String* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
| `tag` | *String* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||||
8
docs/models/operations/GetAllMediaLibraryGuids.md
Normal file
8
docs/models/operations/GetAllMediaLibraryGuids.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetAllMediaLibraryGuids
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *Optional\<String>* | :heavy_minus_sign: | The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337<br/> | tvdb://2337 |
|
||||||
@@ -19,8 +19,8 @@
|
|||||||
| `container` | *Optional\<String>* | :heavy_minus_sign: | File container type. | mkv |
|
| `container` | *Optional\<String>* | :heavy_minus_sign: | File container type. | mkv |
|
||||||
| `videoFrameRate` | *Optional\<String>* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
| `videoFrameRate` | *Optional\<String>* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||||
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||||
| `hasVoiceActivity` | *boolean* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
|
| `hasVoiceActivity` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||||
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
| `optimizedForStreaming` | [Optional\<GetAllMediaLibraryOptimizedForStreaming>](../../models/operations/GetAllMediaLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
| `optimizedForStreaming` | [Optional\<GetAllMediaLibraryOptimizedForStreaming>](../../models/operations/GetAllMediaLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
| `part` | List\<[GetAllMediaLibraryPart](../../models/operations/GetAllMediaLibraryPart.md)> | :heavy_check_mark: | An array of parts for this media item. | |
|
| `part` | List\<[GetAllMediaLibraryPart](../../models/operations/GetAllMediaLibraryPart.md)> | :heavy_minus_sign: | An array of parts for this media item. | |
|
||||||
@@ -20,7 +20,7 @@ Unknown
|
|||||||
| `summary` | *String* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
|
| `summary` | *String* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
|
||||||
| `rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
| `rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||||||
| `audienceRating` | *double* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
| `audienceRating` | *double* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||||
| `year` | *int* | :heavy_check_mark: | The release year of the media item. | 2022 |
|
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||||
| `tagline` | *String* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
| `tagline` | *String* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||||
| `thumb` | *String* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
| `thumb` | *String* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||||
| `art` | *String* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
| `art` | *String* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||||
@@ -70,5 +70,5 @@ Unknown
|
|||||||
| `director` | List\<[GetAllMediaLibraryDirector](../../models/operations/GetAllMediaLibraryDirector.md)> | :heavy_minus_sign: | N/A | |
|
| `director` | List\<[GetAllMediaLibraryDirector](../../models/operations/GetAllMediaLibraryDirector.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `writer` | List\<[GetAllMediaLibraryWriter](../../models/operations/GetAllMediaLibraryWriter.md)> | :heavy_minus_sign: | N/A | |
|
| `writer` | List\<[GetAllMediaLibraryWriter](../../models/operations/GetAllMediaLibraryWriter.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `role` | List\<[GetAllMediaLibraryRole](../../models/operations/GetAllMediaLibraryRole.md)> | :heavy_minus_sign: | N/A | |
|
| `role` | List\<[GetAllMediaLibraryRole](../../models/operations/GetAllMediaLibraryRole.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `guids` | List\<[Guids](../../models/operations/Guids.md)> | :heavy_minus_sign: | N/A | |
|
| `guids` | List\<[GetAllMediaLibraryGuids](../../models/operations/GetAllMediaLibraryGuids.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `collection` | List\<[GetAllMediaLibraryCollection](../../models/operations/GetAllMediaLibraryCollection.md)> | :heavy_minus_sign: | N/A | |
|
| `collection` | List\<[GetAllMediaLibraryCollection](../../models/operations/GetAllMediaLibraryCollection.md)> | :heavy_minus_sign: | N/A | |
|
||||||
@@ -3,6 +3,6 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||||
| `tag` | *String* | :heavy_check_mark: | The name of the actor for this role | Danny Boyle |
|
| `tag` | *String* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
|
||||||
@@ -11,9 +11,9 @@
|
|||||||
| `codec` | *String* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
| `codec` | *String* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||||
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
|
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||||
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||||
| `language` | *String* | :heavy_check_mark: | Language of the stream. | English |
|
| `language` | *Optional\<String>* | :heavy_minus_sign: | Language of the stream. | English |
|
||||||
| `languageTag` | *String* | :heavy_check_mark: | Language tag (e.g., en). | en |
|
| `languageTag` | *Optional\<String>* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||||
| `languageCode` | *String* | :heavy_check_mark: | ISO language code. | eng |
|
| `languageCode` | *Optional\<String>* | :heavy_minus_sign: | ISO language code. | eng |
|
||||||
| `headerCompression` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
| `headerCompression` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||||
| `doviblCompatID` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
| `doviblCompatID` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||||
| `doviblPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
| `doviblPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||||
@@ -28,6 +28,7 @@
|
|||||||
| `chromaSubsampling` | *Optional\<String>* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
| `chromaSubsampling` | *Optional\<String>* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||||
| `codedHeight` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video height. | 1608 |
|
| `codedHeight` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||||
| `codedWidth` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video width. | 3840 |
|
| `codedWidth` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||||
|
| `closedCaptions` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||||
| `colorPrimaries` | *Optional\<String>* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
| `colorPrimaries` | *Optional\<String>* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||||
| `colorRange` | *Optional\<String>* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
| `colorRange` | *Optional\<String>* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||||
| `colorSpace` | *Optional\<String>* | :heavy_minus_sign: | Color space. | bt2020nc |
|
| `colorSpace` | *Optional\<String>* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||||
@@ -39,6 +40,7 @@
|
|||||||
| `hasScalingMatrix` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `hasScalingMatrix` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
| `profile` | *Optional\<String>* | :heavy_minus_sign: | Video profile. | main 10 |
|
| `profile` | *Optional\<String>* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||||
| `scanType` | *Optional\<String>* | :heavy_minus_sign: | N/A | progressive |
|
| `scanType` | *Optional\<String>* | :heavy_minus_sign: | N/A | progressive |
|
||||||
|
| `embeddedInVideo` | *Optional\<String>* | :heavy_minus_sign: | N/A | progressive |
|
||||||
| `refFrames` | *Optional\<Integer>* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
| `refFrames` | *Optional\<Integer>* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||||
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||||
| `displayTitle` | *String* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
| `displayTitle` | *String* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
|
|||||||
@@ -5,4 +5,4 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
| `tag` | *String* | :heavy_check_mark: | The role of Writer | Danny Boyle |
|
| `tag` | *String* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetLibraryItemsEnableCreditsMarkerGeneration
|
|
||||||
|
|
||||||
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ---------------- | ---------------- |
|
|
||||||
| `LibraryDefault` | -1 |
|
|
||||||
| `Disabled` | 0 |
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# GetLibraryItemsEpisodeSort
|
|
||||||
|
|
||||||
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ---------------- | ---------------- |
|
|
||||||
| `LibraryDefault` | -1 |
|
|
||||||
| `OldestFirst` | 0 |
|
|
||||||
| `NewestFirst` | 1 |
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# GetLibraryItemsFlattenSeasons
|
|
||||||
|
|
||||||
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ---------------- | ---------------- |
|
|
||||||
| `LibraryDefault` | -1 |
|
|
||||||
| `Hide` | 0 |
|
|
||||||
| `Show` | 1 |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# GetLibraryItemsMediaGuid
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
|
||||||
| `id` | *String* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetLibraryItemsMetaDataRating
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
|
||||||
| `image` | *String* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
|
|
||||||
| `value` | *float* | :heavy_check_mark: | The value of the rating. | 3 |
|
|
||||||
| `type` | *String* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
|
||||||
@@ -23,10 +23,10 @@
|
|||||||
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
||||||
| `seasonCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
| `seasonCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
||||||
| `tagline` | *Optional\<String>* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
| `tagline` | *Optional\<String>* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||||
| `flattenSeasons` | [Optional\<GetLibraryItemsFlattenSeasons>](../../models/operations/GetLibraryItemsFlattenSeasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
|
| `flattenSeasons` | [Optional\<FlattenSeasons>](../../models/operations/FlattenSeasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
|
||||||
| `episodeSort` | [Optional\<GetLibraryItemsEpisodeSort>](../../models/operations/GetLibraryItemsEpisodeSort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
|
| `episodeSort` | [Optional\<EpisodeSort>](../../models/operations/EpisodeSort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
|
||||||
| `enableCreditsMarkerGeneration` | [Optional\<GetLibraryItemsEnableCreditsMarkerGeneration>](../../models/operations/GetLibraryItemsEnableCreditsMarkerGeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
| `enableCreditsMarkerGeneration` | [Optional\<EnableCreditsMarkerGeneration>](../../models/operations/EnableCreditsMarkerGeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
||||||
| `showOrdering` | [Optional\<GetLibraryItemsShowOrdering>](../../models/operations/GetLibraryItemsShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
|
| `showOrdering` | [Optional\<ShowOrdering>](../../models/operations/ShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
|
||||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||||
| `art` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
| `art` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||||
| `banner` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
| `banner` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||||
@@ -55,9 +55,9 @@
|
|||||||
| `collection` | List\<[GetLibraryItemsCollection](../../models/operations/GetLibraryItemsCollection.md)> | :heavy_minus_sign: | N/A | |
|
| `collection` | List\<[GetLibraryItemsCollection](../../models/operations/GetLibraryItemsCollection.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `role` | List\<[GetLibraryItemsRole](../../models/operations/GetLibraryItemsRole.md)> | :heavy_minus_sign: | N/A | |
|
| `role` | List\<[GetLibraryItemsRole](../../models/operations/GetLibraryItemsRole.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `location` | List\<[GetLibraryItemsLocation](../../models/operations/GetLibraryItemsLocation.md)> | :heavy_minus_sign: | N/A | |
|
| `location` | List\<[GetLibraryItemsLocation](../../models/operations/GetLibraryItemsLocation.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `mediaGuid` | List\<[GetLibraryItemsMediaGuid](../../models/operations/GetLibraryItemsMediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
| `mediaGuid` | List\<[MediaGuid](../../models/operations/MediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||||
| `ultraBlurColors` | [Optional\<GetLibraryItemsUltraBlurColors>](../../models/operations/GetLibraryItemsUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
| `ultraBlurColors` | [Optional\<GetLibraryItemsUltraBlurColors>](../../models/operations/GetLibraryItemsUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `metaDataRating` | List\<[GetLibraryItemsMetaDataRating](../../models/operations/GetLibraryItemsMetaDataRating.md)> | :heavy_minus_sign: | N/A | |
|
| `metaDataRating` | List\<[MetaDataRating](../../models/operations/MetaDataRating.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `image` | List\<[GetLibraryItemsImage](../../models/operations/GetLibraryItemsImage.md)> | :heavy_minus_sign: | N/A | |
|
| `image` | List\<[GetLibraryItemsImage](../../models/operations/GetLibraryItemsImage.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `titleSort` | *Optional\<String>* | :heavy_minus_sign: | N/A | Whale |
|
| `titleSort` | *Optional\<String>* | :heavy_minus_sign: | N/A | Whale |
|
||||||
| `viewCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
| `viewCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
|||||||
@@ -1,20 +0,0 @@
|
|||||||
# GetLibraryItemsShowOrdering
|
|
||||||
|
|
||||||
Setting that indicates the episode ordering for the show.
|
|
||||||
None = Library default,
|
|
||||||
tmdbAiring = The Movie Database (Aired),
|
|
||||||
aired = TheTVDB (Aired),
|
|
||||||
dvd = TheTVDB (DVD),
|
|
||||||
absolute = TheTVDB (Absolute)).
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| -------------- | -------------- |
|
|
||||||
| `None` | None |
|
|
||||||
| `TmdbAiring` | tmdbAiring |
|
|
||||||
| `TvdbAired` | aired |
|
|
||||||
| `TvdbDvd` | dvd |
|
|
||||||
| `TvdbAbsolute` | absolute |
|
|
||||||
12
docs/models/operations/GetMediaArtsMediaContainer.md
Normal file
12
docs/models/operations/GetMediaArtsMediaContainer.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetMediaArtsMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||||
|
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
|
| `mediaTagVersion` | *long* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
|
| `mediaTagPrefix` | *String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
|
| `identifier` | *String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
|
| `metadata` | List\<[GetMediaArtsMetadata](../../models/operations/GetMediaArtsMetadata.md)> | :heavy_check_mark: | N/A | |
|
||||||
12
docs/models/operations/GetMediaArtsMetadata.md
Normal file
12
docs/models/operations/GetMediaArtsMetadata.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetMediaArtsMetadata
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | The URL of the artwork. | https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg |
|
||||||
|
| `provider` | *Optional\<String>* | :heavy_minus_sign: | The provider of the artwork. | tmdb |
|
||||||
|
| `ratingKey` | *String* | :heavy_check_mark: | The URL of the artwork. | https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg |
|
||||||
|
| `selected` | *boolean* | :heavy_check_mark: | Whether this is the selected artwork. | true |
|
||||||
|
| `thumb` | *String* | :heavy_check_mark: | The URL of the artwork thumbnail. | https://images.plex.tv/photo?height=270&width=480&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FixgFmf1X59PUZam2qbAfskx2gQr%2Ejpg |
|
||||||
8
docs/models/operations/GetMediaArtsRequest.md
Normal file
8
docs/models/operations/GetMediaArtsRequest.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetMediaArtsRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
||||||
|
| `ratingKey` | *long* | :heavy_check_mark: | the id of the library item to return the artwork of. | 16099 |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetOnDeckResponse
|
# GetMediaArtsResponse
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -8,4 +8,4 @@
|
|||||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
| `object` | [Optional\<GetOnDeckResponseBody>](../../models/operations/GetOnDeckResponseBody.md) | :heavy_minus_sign: | The on Deck content |
|
| `object` | [Optional\<GetMediaArtsResponseBody>](../../models/operations/GetMediaArtsResponseBody.md) | :heavy_minus_sign: | The available background artwork for the library item. |
|
||||||
10
docs/models/operations/GetMediaArtsResponseBody.md
Normal file
10
docs/models/operations/GetMediaArtsResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetMediaArtsResponseBody
|
||||||
|
|
||||||
|
The available background artwork for the library item.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||||
|
| `mediaContainer` | [Optional\<GetMediaArtsMediaContainer>](../../models/operations/GetMediaArtsMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -19,8 +19,8 @@
|
|||||||
| `container` | *Optional\<String>* | :heavy_minus_sign: | File container type. | mkv |
|
| `container` | *Optional\<String>* | :heavy_minus_sign: | File container type. | mkv |
|
||||||
| `videoFrameRate` | *Optional\<String>* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
| `videoFrameRate` | *Optional\<String>* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||||
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||||
| `hasVoiceActivity` | *boolean* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
|
| `hasVoiceActivity` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||||
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
| `optimizedForStreaming` | [Optional\<GetMediaMetaDataOptimizedForStreaming>](../../models/operations/GetMediaMetaDataOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
| `optimizedForStreaming` | [Optional\<GetMediaMetaDataOptimizedForStreaming>](../../models/operations/GetMediaMetaDataOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
| `part` | List\<[GetMediaMetaDataPart](../../models/operations/GetMediaMetaDataPart.md)> | :heavy_check_mark: | An array of parts for this media item. | |
|
| `part` | List\<[GetMediaMetaDataPart](../../models/operations/GetMediaMetaDataPart.md)> | :heavy_minus_sign: | An array of parts for this media item. | |
|
||||||
@@ -63,6 +63,6 @@
|
|||||||
| `role` | List\<[GetMediaMetaDataRole](../../models/operations/GetMediaMetaDataRole.md)> | :heavy_minus_sign: | An array of Actor roles. | |
|
| `role` | List\<[GetMediaMetaDataRole](../../models/operations/GetMediaMetaDataRole.md)> | :heavy_minus_sign: | An array of Actor roles. | |
|
||||||
| `director` | List\<[GetMediaMetaDataDirector](../../models/operations/GetMediaMetaDataDirector.md)> | :heavy_minus_sign: | An array of Director roles. | |
|
| `director` | List\<[GetMediaMetaDataDirector](../../models/operations/GetMediaMetaDataDirector.md)> | :heavy_minus_sign: | An array of Director roles. | |
|
||||||
| `writer` | List\<[GetMediaMetaDataWriter](../../models/operations/GetMediaMetaDataWriter.md)> | :heavy_minus_sign: | An array of Writer roles. | |
|
| `writer` | List\<[GetMediaMetaDataWriter](../../models/operations/GetMediaMetaDataWriter.md)> | :heavy_minus_sign: | An array of Writer roles. | |
|
||||||
| `producer` | List\<[Producer](../../models/operations/Producer.md)> | :heavy_minus_sign: | An array of Writer roles. | |
|
| `producer` | List\<[GetMediaMetaDataProducer](../../models/operations/GetMediaMetaDataProducer.md)> | :heavy_minus_sign: | An array of Writer roles. | |
|
||||||
| `similar` | List\<[Similar](../../models/operations/Similar.md)> | :heavy_minus_sign: | An array of similar content objects. | |
|
| `similar` | List\<[GetMediaMetaDataSimilar](../../models/operations/GetMediaMetaDataSimilar.md)> | :heavy_minus_sign: | An array of similar content objects. | |
|
||||||
| `location` | List\<[GetMediaMetaDataLocation](../../models/operations/GetMediaMetaDataLocation.md)> | :heavy_minus_sign: | An array of location objects. | |
|
| `location` | List\<[GetMediaMetaDataLocation](../../models/operations/GetMediaMetaDataLocation.md)> | :heavy_minus_sign: | An array of location objects. | |
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GetMediaMetaDataOptimizedForStreamingLibrary1
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `ZERO` | 0 |
|
||||||
|
| `ONE` | 1 |
|
||||||
13
docs/models/operations/GetMediaMetaDataProducer.md
Normal file
13
docs/models/operations/GetMediaMetaDataProducer.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# GetMediaMetaDataProducer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||||
|
| `tagKey` | *String* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||||
|
| `role` | *Optional\<String>* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||||
|
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||||
10
docs/models/operations/GetMediaMetaDataSimilar.md
Normal file
10
docs/models/operations/GetMediaMetaDataSimilar.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetMediaMetaDataSimilar
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | The unique similar item identifier. | 26 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | The filter string for similar items. | similar=26 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The tag or title of the similar content. | Breaking Bad |
|
||||||
@@ -11,9 +11,9 @@
|
|||||||
| `codec` | *String* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
| `codec` | *String* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||||
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
|
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||||
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||||
| `language` | *String* | :heavy_check_mark: | Language of the stream. | English |
|
| `language` | *Optional\<String>* | :heavy_minus_sign: | Language of the stream. | English |
|
||||||
| `languageTag` | *String* | :heavy_check_mark: | Language tag (e.g., en). | en |
|
| `languageTag` | *Optional\<String>* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||||
| `languageCode` | *String* | :heavy_check_mark: | ISO language code. | eng |
|
| `languageCode` | *Optional\<String>* | :heavy_minus_sign: | ISO language code. | eng |
|
||||||
| `headerCompression` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
| `headerCompression` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||||
| `doviblCompatID` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
| `doviblCompatID` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||||
| `doviblPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
| `doviblPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||||
@@ -28,6 +28,7 @@
|
|||||||
| `chromaSubsampling` | *Optional\<String>* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
| `chromaSubsampling` | *Optional\<String>* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||||
| `codedHeight` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video height. | 1608 |
|
| `codedHeight` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||||
| `codedWidth` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video width. | 3840 |
|
| `codedWidth` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||||
|
| `closedCaptions` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||||
| `colorPrimaries` | *Optional\<String>* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
| `colorPrimaries` | *Optional\<String>* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||||
| `colorRange` | *Optional\<String>* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
| `colorRange` | *Optional\<String>* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||||
| `colorSpace` | *Optional\<String>* | :heavy_minus_sign: | Color space. | bt2020nc |
|
| `colorSpace` | *Optional\<String>* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||||
@@ -39,6 +40,7 @@
|
|||||||
| `hasScalingMatrix` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `hasScalingMatrix` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
| `profile` | *Optional\<String>* | :heavy_minus_sign: | Video profile. | main 10 |
|
| `profile` | *Optional\<String>* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||||
| `scanType` | *Optional\<String>* | :heavy_minus_sign: | N/A | progressive |
|
| `scanType` | *Optional\<String>* | :heavy_minus_sign: | N/A | progressive |
|
||||||
|
| `embeddedInVideo` | *Optional\<String>* | :heavy_minus_sign: | N/A | progressive |
|
||||||
| `refFrames` | *Optional\<Integer>* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
| `refFrames` | *Optional\<Integer>* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||||
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||||
| `displayTitle` | *String* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
| `displayTitle` | *String* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
|
|||||||
12
docs/models/operations/GetMediaPostersMediaContainer.md
Normal file
12
docs/models/operations/GetMediaPostersMediaContainer.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetMediaPostersMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||||
|
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
|
| `mediaTagVersion` | *long* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
|
| `mediaTagPrefix` | *String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
|
| `identifier` | *String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
|
| `metadata` | List\<[GetMediaPostersMetadata](../../models/operations/GetMediaPostersMetadata.md)> | :heavy_check_mark: | N/A | |
|
||||||
12
docs/models/operations/GetMediaPostersMetadata.md
Normal file
12
docs/models/operations/GetMediaPostersMetadata.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetMediaPostersMetadata
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | The URL of the poster. | https://image.tmdb.org/t/p/original/hntBJjqbv4m0Iyniqaztv9xaudI.jpg |
|
||||||
|
| `provider` | *Optional\<String>* | :heavy_minus_sign: | The provider of the poster. | tmdb |
|
||||||
|
| `ratingKey` | *String* | :heavy_check_mark: | The URL of the poster. | https://image.tmdb.org/t/p/original/hntBJjqbv4m0Iyniqaztv9xaudI.jpg |
|
||||||
|
| `selected` | *boolean* | :heavy_check_mark: | Whether this is the selected poster. | true |
|
||||||
|
| `thumb` | *String* | :heavy_check_mark: | The URL of the poster thumbnail. | https://images.plex.tv/photo?height=336&width=225&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FhntBJjqbv4m0Iyniqaztv9xaudI%2Ejpg |
|
||||||
8
docs/models/operations/GetMediaPostersRequest.md
Normal file
8
docs/models/operations/GetMediaPostersRequest.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetMediaPostersRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
||||||
|
| `ratingKey` | *long* | :heavy_check_mark: | the id of the library item to return the posters of. | 16099 |
|
||||||
11
docs/models/operations/GetMediaPostersResponse.md
Normal file
11
docs/models/operations/GetMediaPostersResponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetMediaPostersResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [Optional\<GetMediaPostersResponseBody>](../../models/operations/GetMediaPostersResponseBody.md) | :heavy_minus_sign: | The available posters for the library item. |
|
||||||
10
docs/models/operations/GetMediaPostersResponseBody.md
Normal file
10
docs/models/operations/GetMediaPostersResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetMediaPostersResponseBody
|
||||||
|
|
||||||
|
The available posters for the library item.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||||
|
| `mediaContainer` | [Optional\<GetMediaPostersMediaContainer>](../../models/operations/GetMediaPostersMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# GetOnDeckGuids
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
|
||||||
| `id` | *Optional\<String>* | :heavy_minus_sign: | N/A | imdb://tt13303712 |
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
# GetOnDeckMedia
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
|
||||||
| `id` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 80994 |
|
|
||||||
| `duration` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 420080 |
|
|
||||||
| `bitrate` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 1046 |
|
|
||||||
| `width` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 1920 |
|
|
||||||
| `height` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 1080 |
|
|
||||||
| `aspectRatio` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 1.78 |
|
|
||||||
| `audioChannels` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 2 |
|
|
||||||
| `audioCodec` | *Optional\<String>* | :heavy_minus_sign: | N/A | aac |
|
|
||||||
| `videoCodec` | *Optional\<String>* | :heavy_minus_sign: | N/A | hevc |
|
|
||||||
| `videoResolution` | *Optional\<String>* | :heavy_minus_sign: | N/A | 1080 |
|
|
||||||
| `container` | *Optional\<String>* | :heavy_minus_sign: | N/A | mkv |
|
|
||||||
| `videoFrameRate` | *Optional\<String>* | :heavy_minus_sign: | N/A | PAL |
|
|
||||||
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | N/A | lc |
|
|
||||||
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | N/A | main |
|
|
||||||
| `part` | List\<[GetOnDeckPart](../../models/operations/GetOnDeckPart.md)> | :heavy_minus_sign: | N/A | |
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
# GetOnDeckMediaContainer
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
|
||||||
| `size` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 16 |
|
|
||||||
| `allowSync` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `identifier` | *Optional\<String>* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
|
||||||
| `mediaTagPrefix` | *Optional\<String>* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
|
||||||
| `mediaTagVersion` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 1680021154 |
|
|
||||||
| `mixedParents` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `metadata` | List\<[GetOnDeckMetadata](../../models/operations/GetOnDeckMetadata.md)> | :heavy_minus_sign: | N/A | |
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
# GetOnDeckMetadata
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `allowSync` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `librarySectionID` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 2 |
|
|
||||||
| `librarySectionTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | TV Shows |
|
|
||||||
| `librarySectionUUID` | *Optional\<String>* | :heavy_minus_sign: | N/A | 4bb2521c-8ba9-459b-aaee-8ab8bc35eabd |
|
|
||||||
| `ratingKey` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 49564 |
|
|
||||||
| `key` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/49564 |
|
|
||||||
| `parentRatingKey` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 49557 |
|
|
||||||
| `grandparentRatingKey` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 49556 |
|
|
||||||
| `guid` | *Optional\<String>* | :heavy_minus_sign: | N/A | plex://episode/5ea7d7402e7ab10042e74d4f |
|
|
||||||
| `parentGuid` | *Optional\<String>* | :heavy_minus_sign: | N/A | plex://season/602e754d67f4c8002ce54b3d |
|
|
||||||
| `grandparentGuid` | *Optional\<String>* | :heavy_minus_sign: | N/A | plex://show/5d9c090e705e7a001e6e94d8 |
|
|
||||||
| `type` | *Optional\<String>* | :heavy_minus_sign: | N/A | episode |
|
|
||||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | N/A | Circus |
|
|
||||||
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/49556 |
|
|
||||||
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/49557 |
|
|
||||||
| `librarySectionKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/2 |
|
|
||||||
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Bluey (2018) |
|
|
||||||
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Season 2 |
|
|
||||||
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | N/A | TV-Y |
|
|
||||||
| `summary` | *Optional\<String>* | :heavy_minus_sign: | N/A | Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy. |
|
|
||||||
| `index` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 33 |
|
|
||||||
| `parentIndex` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 2 |
|
|
||||||
| `lastViewedAt` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 1681908352 |
|
|
||||||
| `year` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 2018 |
|
|
||||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/49564/thumb/1654258204 |
|
|
||||||
| `art` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/49556/art/1680939546 |
|
|
||||||
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/49557/thumb/1654258204 |
|
|
||||||
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/49556/thumb/1680939546 |
|
|
||||||
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/49556/art/1680939546 |
|
|
||||||
| `grandparentTheme` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/49556/theme/1680939546 |
|
|
||||||
| `duration` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 420080 |
|
|
||||||
| `originallyAvailableAt` | [OffsetDateTime](https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html) | :heavy_minus_sign: | N/A | 2020-10-31 00:00:00 +0000 UTC |
|
|
||||||
| `addedAt` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 1654258196 |
|
|
||||||
| `updatedAt` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 1654258204 |
|
|
||||||
| `media` | List\<[GetOnDeckMedia](../../models/operations/GetOnDeckMedia.md)> | :heavy_minus_sign: | N/A | |
|
|
||||||
| `guids` | List\<[GetOnDeckGuids](../../models/operations/GetOnDeckGuids.md)> | :heavy_minus_sign: | N/A | |
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
# GetOnDeckPart
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
|
||||||
| `id` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 80994 |
|
|
||||||
| `key` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/parts/80994/1655007810/file.mkv |
|
|
||||||
| `duration` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 420080 |
|
|
||||||
| `file` | *Optional\<String>* | :heavy_minus_sign: | N/A | /tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv |
|
|
||||||
| `size` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 55148931 |
|
|
||||||
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | N/A | lc |
|
|
||||||
| `container` | *Optional\<String>* | :heavy_minus_sign: | N/A | mkv |
|
|
||||||
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | N/A | main |
|
|
||||||
| `stream` | List\<[GetOnDeckStream](../../models/operations/GetOnDeckStream.md)> | :heavy_minus_sign: | N/A | |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetOnDeckResponseBody
|
|
||||||
|
|
||||||
The on Deck content
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
|
||||||
| `mediaContainer` | [Optional\<GetOnDeckMediaContainer>](../../models/operations/GetOnDeckMediaContainer.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
# GetOnDeckStream
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
|
||||||
| `id` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 211234 |
|
|
||||||
| `streamType` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `default_` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `codec` | *Optional\<String>* | :heavy_minus_sign: | N/A | hevc |
|
|
||||||
| `index` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 0 |
|
|
||||||
| `bitrate` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 918 |
|
|
||||||
| `language` | *Optional\<String>* | :heavy_minus_sign: | N/A | English |
|
|
||||||
| `languageTag` | *Optional\<String>* | :heavy_minus_sign: | N/A | en |
|
|
||||||
| `languageCode` | *Optional\<String>* | :heavy_minus_sign: | N/A | eng |
|
|
||||||
| `bitDepth` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 8 |
|
|
||||||
| `chromaLocation` | *Optional\<String>* | :heavy_minus_sign: | N/A | left |
|
|
||||||
| `chromaSubsampling` | *Optional\<String>* | :heavy_minus_sign: | N/A | 4:2:0 |
|
|
||||||
| `codedHeight` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 1080 |
|
|
||||||
| `codedWidth` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 1920 |
|
|
||||||
| `colorRange` | *Optional\<String>* | :heavy_minus_sign: | N/A | tv |
|
|
||||||
| `frameRate` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 25 |
|
|
||||||
| `height` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 1080 |
|
|
||||||
| `level` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 120 |
|
|
||||||
| `profile` | *Optional\<String>* | :heavy_minus_sign: | N/A | main |
|
|
||||||
| `refFrames` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `width` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 1920 |
|
|
||||||
| `displayTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | 1080p (HEVC Main) |
|
|
||||||
| `extendedDisplayTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | 1080p (HEVC Main) |
|
|
||||||
@@ -5,10 +5,10 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||||
| `size` | *long* | :heavy_check_mark: | N/A | 50 |
|
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
| `offset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | |
|
| `totalSize` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
||||||
| `totalSize` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | |
|
| `offset` | *long* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
||||||
| `identifier` | *Optional\<String>* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `allowSync` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `identifier` | *String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
| `meta` | [Optional\<Meta>](../../models/operations/Meta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
| `meta` | [Optional\<Meta>](../../models/operations/Meta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||||
| `metadata` | List\<[GetRecentlyAddedMetadata](../../models/operations/GetRecentlyAddedMetadata.md)> | :heavy_minus_sign: | N/A | |
|
| `metadata` | List\<[GetRecentlyAddedMetadata](../../models/operations/GetRecentlyAddedMetadata.md)> | :heavy_minus_sign: | An array of metadata items. | |
|
||||||
@@ -1,83 +1,85 @@
|
|||||||
# GetRecentlyAddedMetadata
|
# GetRecentlyAddedMetadata
|
||||||
|
|
||||||
|
Unknown
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `ratingKey` | *String* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
|
| `addedAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/metadata/58683 |
|
| `art` | *String* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||||
| `guid` | *String* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
| `audienceRatingImage` | *Optional\<String>* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||||
| `studio` | *Optional\<String>* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
| `audienceRating` | *double* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||||
| `skipChildren` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `chapterSource` | *Optional\<String>* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||||||
| `librarySectionID` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1 |
|
| `childCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||||
| `librarySectionTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Movies |
|
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||||
| `librarySectionKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
| `createdAtAccuracy` | *Optional\<String>* | :heavy_minus_sign: | The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). | epoch,local |
|
||||||
| `type` | [GetRecentlyAddedHubsType](../../models/operations/GetRecentlyAddedHubsType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
| `createdAtTZOffset` | *Optional\<String>* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||||
| `slug` | *Optional\<String>* | :heavy_minus_sign: | N/A | 4-for-texas |
|
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||||||
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | N/A | PG-13 |
|
| `grandparentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
| `summary` | *String* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||||||
| `rating` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 7.6 |
|
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||||||
| `audienceRating` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 9.2 |
|
| `grandparentSlug` | *Optional\<String>* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||||||
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
| `grandparentTheme` | *Optional\<String>* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||||||
| `seasonCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||||||
| `tagline` | *Optional\<String>* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||||||
| `flattenSeasons` | [Optional\<FlattenSeasons>](../../models/operations/FlattenSeasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
|
| `guid` | *String* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||||
| `episodeSort` | [Optional\<EpisodeSort>](../../models/operations/EpisodeSort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
|
| `index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||||||
| `enableCreditsMarkerGeneration` | [Optional\<EnableCreditsMarkerGeneration>](../../models/operations/EnableCreditsMarkerGeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
| `key` | *String* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
|
||||||
| `showOrdering` | [Optional\<ShowOrdering>](../../models/operations/ShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
|
| `lastRatedAt` | *Optional\<Long>* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
| `lastViewedAt` | *Optional\<Integer>* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||||
| `art` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
| `leafCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||||
| `banner` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
| `librarySectionID` | *long* | :heavy_check_mark: | The identifier for the library section. | 1 |
|
||||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
| `librarySectionKey` | *String* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
|
||||||
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
| `librarySectionTitle` | *String* | :heavy_check_mark: | The title of the library section. | Movies |
|
||||||
| `addedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
| `originalTitle` | *Optional\<String>* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||||
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
||||||
| `audienceRatingImage` | *Optional\<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
| `parentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
| `chapterSource` | *Optional\<String>* | :heavy_minus_sign: | N/A | media |
|
| `parentIndex` | *Optional\<Integer>* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||||
| `primaryExtraKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||||
| `ratingImage` | *Optional\<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||||||
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | 66 |
|
| `parentSlug` | *Optional\<String>* | :heavy_minus_sign: | The slug for the parent media item. | alice-in-borderland-2020 |
|
||||||
| `grandparentGuid` | *Optional\<String>* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
| `parentStudio` | *String* | :heavy_check_mark: | The studio of the parent media item. | UCP |
|
||||||
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
| `parentTheme` | *String* | :heavy_check_mark: | The theme URL for the parent media item. | /library/metadata/66/theme/1705716261 |
|
||||||
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Caprica |
|
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||||||
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||||||
| `parentSlug` | *Optional\<String>* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
| `parentYear` | *Optional\<Integer>* | :heavy_minus_sign: | The release year of the parent media item. | 2010 |
|
||||||
| `grandparentSlug` | *Optional\<String>* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
| `primaryExtraKey` | *Optional\<String>* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||||||
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
| `ratingImage` | *Optional\<String>* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||||||
| `grandparentTheme` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
| `ratingKey` | *String* | :heavy_check_mark: | The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. | 58683 |
|
||||||
| `media` | List\<[Media](../../models/operations/Media.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
| `rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||||||
| `genre` | List\<[Genre](../../models/operations/Genre.md)> | :heavy_minus_sign: | N/A | |
|
| `seasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||||
| `country` | List\<[Country](../../models/operations/Country.md)> | :heavy_minus_sign: | N/A | |
|
| `skipCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||||||
| `director` | List\<[Director](../../models/operations/Director.md)> | :heavy_minus_sign: | N/A | |
|
| `slug` | *String* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
||||||
| `writer` | List\<[Writer](../../models/operations/Writer.md)> | :heavy_minus_sign: | N/A | |
|
| `studio` | *Optional\<String>* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
||||||
| `collection` | List\<[Collection](../../models/operations/Collection.md)> | :heavy_minus_sign: | N/A | |
|
| `subtype` | *Optional\<String>* | :heavy_minus_sign: | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
|
||||||
| `role` | List\<[Role](../../models/operations/Role.md)> | :heavy_minus_sign: | N/A | |
|
| `summary` | *String* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
|
||||||
| `location` | List\<[Location](../../models/operations/Location.md)> | :heavy_minus_sign: | N/A | |
|
| `tagline` | *String* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||||
| `mediaGuid` | List\<[MediaGuid](../../models/operations/MediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
| `theme` | *String* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
|
||||||
| `ultraBlurColors` | [Optional\<UltraBlurColors>](../../models/operations/UltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
| `thumb` | *String* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||||
| `metaDataRating` | List\<[MetaDataRating](../../models/operations/MetaDataRating.md)> | :heavy_minus_sign: | N/A | |
|
| `titleSort` | *String* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
||||||
| `image` | List\<[GetRecentlyAddedImage](../../models/operations/GetRecentlyAddedImage.md)> | :heavy_minus_sign: | N/A | |
|
| `title` | *String* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||||
| `titleSort` | *Optional\<String>* | :heavy_minus_sign: | N/A | Whale |
|
| `type` | [GetRecentlyAddedHubsType](../../models/operations/GetRecentlyAddedHubsType.md) | :heavy_check_mark: | N/A | movie |
|
||||||
| `viewCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `lastViewedAt` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1682752242 |
|
| `userRating` | *Optional\<Float>* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||||
| `originalTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
| `viewCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||||||
| `viewOffset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 5222500 |
|
| `viewOffset` | *Optional\<Integer>* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||||
| `skipCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
| `viewedLeafCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||||
| `index` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||||
| `theme` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
| `image` | List\<[GetRecentlyAddedImage](../../models/operations/GetRecentlyAddedImage.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `leafCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 14 |
|
| `ultraBlurColors` | [Optional\<UltraBlurColors>](../../models/operations/UltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `viewedLeafCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 0 |
|
| `media` | List\<[Media](../../models/operations/Media.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `childCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
| `genre` | List\<[Genre](../../models/operations/Genre.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `hasPremiumExtras` | *Optional\<String>* | :heavy_minus_sign: | N/A | 1 |
|
| `country` | List\<[Country](../../models/operations/Country.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `hasPremiumPrimaryExtra` | *Optional\<String>* | :heavy_minus_sign: | N/A | 1 |
|
| `director` | List\<[Director](../../models/operations/Director.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
| `writer` | List\<[Writer](../../models/operations/Writer.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `parentGuid` | *Optional\<String>* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
| `role` | List\<[Role](../../models/operations/Role.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `parentStudio` | *Optional\<String>* | :heavy_minus_sign: | N/A | UCP |
|
| `producer` | List\<[Producer](../../models/operations/Producer.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
| `rating1` | List\<[Rating](../../models/operations/Rating.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Caprica |
|
| `similar` | List\<[Similar](../../models/operations/Similar.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `parentIndex` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
| `location` | List\<[Location](../../models/operations/Location.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `parentYear` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2010 |
|
| `guids` | List\<[Guids](../../models/operations/Guids.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
| `collection` | List\<[Collection](../../models/operations/Collection.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `parentTheme` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
# GetRecentlyAddedOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GetRecentlyAddedOptimizedForStreaming1
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `ZERO` | 0 |
|
||||||
|
| `ONE` | 1 |
|
||||||
@@ -41,7 +41,7 @@ Logged in user details
|
|||||||
| `services` | List\<[Services](../../models/operations/Services.md)> | :heavy_check_mark: | N/A | |
|
| `services` | List\<[Services](../../models/operations/Services.md)> | :heavy_check_mark: | N/A | |
|
||||||
| `subscription` | [Subscription](../../models/operations/Subscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
|
| `subscription` | [Subscription](../../models/operations/Subscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
|
||||||
| `subscriptionDescription` | *Optional\<String>* | :heavy_check_mark: | Description of the Plex Pass subscription | |
|
| `subscriptionDescription` | *Optional\<String>* | :heavy_check_mark: | Description of the Plex Pass subscription | |
|
||||||
| `subscriptions` | List\<[GetTokenDetailsSubscription](../../models/operations/GetTokenDetailsSubscription.md)> | :heavy_check_mark: | N/A | |
|
| `subscriptions` | List\<[GetTokenDetailsSubscription](../../models/operations/GetTokenDetailsSubscription.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `thumb` | *String* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101 |
|
| `thumb` | *String* | :heavy_check_mark: | 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 |
|
| `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 | |
|
| `twoFactorEnabled` | *Optional\<Boolean>* | :heavy_minus_sign: | If two-factor authentication is enabled | |
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
# HasThumbnail
|
# HasThumbnail
|
||||||
|
|
||||||
|
Indicates if the part has a thumbnail.
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
|
|||||||
@@ -1,8 +1,10 @@
|
|||||||
# Location
|
# Location
|
||||||
|
|
||||||
|
The folder path for the media item.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||||
| `path` | *Optional\<String>* | :heavy_minus_sign: | N/A | /TV Shows/House |
|
| `path` | *String* | :heavy_check_mark: | N/A | /TV Shows/Clarkson's Farm |
|
||||||
@@ -5,21 +5,22 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||||
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
|
| `id` | *long* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||||
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 25025 |
|
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||||
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 3840 |
|
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||||
| `height` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2072 |
|
| `height` | *Optional\<Integer>* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||||
| `aspectRatio` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 1.85 |
|
| `aspectRatio` | *Optional\<Float>* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||||
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | N/A | dts |
|
| `audioChannels` | *Optional\<Integer>* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||||
| `audioChannels` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 6 |
|
| `displayOffset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 50 |
|
||||||
| `audioCodec` | *Optional\<String>* | :heavy_minus_sign: | N/A | eac3 |
|
| `audioCodec` | *Optional\<String>* | :heavy_minus_sign: | Audio codec used. | eac3 |
|
||||||
| `videoCodec` | *Optional\<String>* | :heavy_minus_sign: | N/A | hevc |
|
| `videoCodec` | *Optional\<String>* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||||
| `videoResolution` | *Optional\<String>* | :heavy_minus_sign: | N/A | 4k |
|
| `videoResolution` | *Optional\<String>* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||||
| `container` | *String* | :heavy_check_mark: | N/A | mkv |
|
| `container` | *Optional\<String>* | :heavy_minus_sign: | File container type. | mkv |
|
||||||
| `videoFrameRate` | *Optional\<String>* | :heavy_minus_sign: | N/A | 24p |
|
| `videoFrameRate` | *Optional\<String>* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||||
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | N/A | main 10 |
|
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||||
| `hasVoiceActivity` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `hasVoiceActivity` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||||
| `optimizedForStreaming` | [Optional\<OptimizedForStreaming>](../../models/operations/OptimizedForStreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
|
| `optimizedForStreaming` | [Optional\<OptimizedForStreaming>](../../models/operations/OptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
| `part` | List\<[Part](../../models/operations/Part.md)> | :heavy_check_mark: | N/A | |
|
| `part` | List\<[Part](../../models/operations/Part.md)> | :heavy_minus_sign: | An array of parts for this media item. | |
|
||||||
@@ -1,9 +1,4 @@
|
|||||||
# OptimizedForStreaming
|
# OptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| --------- | --------- |
|
|
||||||
| `Disable` | 0 |
|
|
||||||
| `Enable` | 1 |
|
|
||||||
@@ -5,16 +5,19 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *int* | :heavy_check_mark: | N/A | 119542 |
|
| `accessible` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
| `exists` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
| `id` | *long* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||||
| `file` | *String* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
| `key` | *String* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||||
| `size` | *long* | :heavy_check_mark: | N/A | 36158371307 |
|
|
||||||
| `container` | *String* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
|
||||||
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | N/A | dts |
|
|
||||||
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `optimizedForStreaming` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | N/A | main 10 |
|
|
||||||
| `indexes` | *Optional\<String>* | :heavy_minus_sign: | N/A | sd |
|
| `indexes` | *Optional\<String>* | :heavy_minus_sign: | N/A | sd |
|
||||||
|
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||||
|
| `file` | *String* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||||
|
| `size` | *long* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
||||||
|
| `packetLength` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 188 |
|
||||||
|
| `container` | *Optional\<String>* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||||
|
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||||
|
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
|
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `optimizedForStreaming` | [Optional\<GetRecentlyAddedOptimizedForStreaming>](../../models/operations/GetRecentlyAddedOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
| `hasThumbnail` | [Optional\<HasThumbnail>](../../models/operations/HasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
| `hasThumbnail` | [Optional\<HasThumbnail>](../../models/operations/HasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `stream` | List\<[Stream](../../models/operations/Stream.md)> | :heavy_minus_sign: | N/A | |
|
| `stream` | List\<[Stream](../../models/operations/Stream.md)> | :heavy_minus_sign: | An array of streams for this part. | |
|
||||||
10
docs/models/operations/PostMediaArtsRequest.md
Normal file
10
docs/models/operations/PostMediaArtsRequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# PostMediaArtsRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||||
|
| `ratingKey` | *long* | :heavy_check_mark: | the id of the library item to return the posters of. | 2268 |
|
||||||
|
| `url` | *Optional\<String>* | :heavy_minus_sign: | The URL of the image, if uploading a remote image | https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b |
|
||||||
|
| `requestBody` | *Optional\<byte[]>* | :heavy_minus_sign: | The contents of the image, if uploading a local file | |
|
||||||
@@ -1,11 +1,10 @@
|
|||||||
# GetOnDeckBadRequest
|
# PostMediaArtsResponse
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | List\<[GetOnDeckErrors](../../models/errors/GetOnDeckErrors.md)> | :heavy_minus_sign: | N/A |
|
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/models/operations/PostMediaPosterRequest.md
Normal file
10
docs/models/operations/PostMediaPosterRequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# PostMediaPosterRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||||
|
| `ratingKey` | *long* | :heavy_check_mark: | the id of the library item to return the posters of. | 2268 |
|
||||||
|
| `url` | *Optional\<String>* | :heavy_minus_sign: | The URL of the image, if uploading a remote image | https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b |
|
||||||
|
| `requestBody` | *Optional\<byte[]>* | :heavy_minus_sign: | The contents of the image, if uploading a local file | |
|
||||||
@@ -1,11 +1,10 @@
|
|||||||
# GetOnDeckUnauthorized
|
# PostMediaPosterResponse
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | List\<[GetOnDeckLibraryErrors](../../models/errors/GetOnDeckLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -41,7 +41,7 @@ Returns the user account data with a valid auth token
|
|||||||
| `services` | List\<[PostUsersSignInDataServices](../../models/operations/PostUsersSignInDataServices.md)> | :heavy_check_mark: | N/A | |
|
| `services` | List\<[PostUsersSignInDataServices](../../models/operations/PostUsersSignInDataServices.md)> | :heavy_check_mark: | N/A | |
|
||||||
| `subscription` | [PostUsersSignInDataSubscription](../../models/operations/PostUsersSignInDataSubscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
|
| `subscription` | [PostUsersSignInDataSubscription](../../models/operations/PostUsersSignInDataSubscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
|
||||||
| `subscriptionDescription` | *Optional\<String>* | :heavy_check_mark: | Description of the Plex Pass subscription | |
|
| `subscriptionDescription` | *Optional\<String>* | :heavy_check_mark: | Description of the Plex Pass subscription | |
|
||||||
| `subscriptions` | List\<[PostUsersSignInDataAuthenticationSubscription](../../models/operations/PostUsersSignInDataAuthenticationSubscription.md)> | :heavy_check_mark: | N/A | |
|
| `subscriptions` | List\<[PostUsersSignInDataAuthenticationSubscription](../../models/operations/PostUsersSignInDataAuthenticationSubscription.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `thumb` | *String* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101 |
|
| `thumb` | *String* | :heavy_check_mark: | 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 |
|
| `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 | |
|
| `twoFactorEnabled` | *Optional\<Boolean>* | :heavy_minus_sign: | If two-factor authentication is enabled | |
|
||||||
|
|||||||
@@ -3,11 +3,10 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||||
| `id` | *long* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
| `id` | *long* | :heavy_check_mark: | Unique identifier for the producer. | 126522 |
|
||||||
| `filter` | *String* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
| `filter` | *String* | :heavy_check_mark: | The filter string used to query this producer. | producer=126522 |
|
||||||
| `tag` | *String* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
| `tag` | *String* | :heavy_check_mark: | The name of the producer | Amelia Knapp |
|
||||||
| `tagKey` | *String* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
| `tagKey` | *Optional\<String>* | :heavy_minus_sign: | A unique key associated with the producer's tag, used for internal identification. | 5d77683d85719b001f3a535e |
|
||||||
| `role` | *Optional\<String>* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | The URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
|
||||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
|
||||||
12
docs/models/operations/Rating.md
Normal file
12
docs/models/operations/Rating.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# Rating
|
||||||
|
|
||||||
|
The type of rating, for example 'audience' or 'critic'.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
||||||
|
| `image` | *String* | :heavy_check_mark: | N/A | imdb://image.rating |
|
||||||
|
| `value` | *double* | :heavy_check_mark: | N/A | 5.1 |
|
||||||
|
| `type` | *String* | :heavy_check_mark: | N/A | audience |
|
||||||
@@ -3,11 +3,11 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *Optional\<Long>* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 |
|
| `id` | *long* | :heavy_check_mark: | Unique identifier for the actor or role. | 126522 |
|
||||||
| `filter` | *Optional\<String>* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 |
|
| `filter` | *String* | :heavy_check_mark: | The filter string used to query this actor. For example, it may indicate that this is an actor with a given key. | actor=126522 |
|
||||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
|
| `tag` | *String* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
|
| `tagKey` | *Optional\<String>* | :heavy_minus_sign: | A unique key associated with the actor's tag, used for internal identification. | 5d77683d85719b001f3a535e |
|
||||||
| `tagKey` | *Optional\<String>* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
|
| `role` | *Optional\<String>* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
|
||||||
| `role` | *Optional\<String>* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |
|
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | The URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
|
||||||
@@ -1,10 +1,12 @@
|
|||||||
# Similar
|
# Similar
|
||||||
|
|
||||||
|
The display tag for the similar item, typically the title.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
|
||||||
| `id` | *long* | :heavy_check_mark: | The unique similar item identifier. | 26 |
|
| `id` | *long* | :heavy_check_mark: | N/A | 259 |
|
||||||
| `filter` | *String* | :heavy_check_mark: | The filter string for similar items. | similar=26 |
|
| `filter` | *String* | :heavy_check_mark: | N/A | similar=259 |
|
||||||
| `tag` | *String* | :heavy_check_mark: | The tag or title of the similar content. | Breaking Bad |
|
| `tag` | *String* | :heavy_check_mark: | N/A | Criss Angel Mindfreak |
|
||||||
@@ -3,43 +3,54 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||||
| `id` | *long* | :heavy_check_mark: | N/A | 272796 |
|
| `id` | *long* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||||
| `streamType` | *long* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
|
| `streamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
|
||||||
| `default_` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this is the default stream | true |
|
| `default_` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||||
| `selected` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream is selected | true |
|
| `codec` | *String* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||||
| `codec` | *String* | :heavy_check_mark: | Codec used by the stream | h264 |
|
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||||
| `index` | *long* | :heavy_check_mark: | The index of the stream | 0 |
|
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||||
| `bitrate` | *Optional\<Long>* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
|
| `language` | *Optional\<String>* | :heavy_minus_sign: | Language of the stream. | English |
|
||||||
| `colorPrimaries` | *Optional\<String>* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
|
| `languageTag` | *Optional\<String>* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||||
| `colorRange` | *Optional\<String>* | :heavy_minus_sign: | The color range of the video stream | tv |
|
| `languageCode` | *Optional\<String>* | :heavy_minus_sign: | ISO language code. | eng |
|
||||||
| `colorSpace` | *Optional\<String>* | :heavy_minus_sign: | The color space of the video stream | bt709 |
|
| `headerCompression` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||||
| `colorTrc` | *Optional\<String>* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
|
| `doviblCompatID` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||||
| `bitDepth` | *Optional\<Long>* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
|
| `doviblPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||||
| `chromaLocation` | *Optional\<String>* | :heavy_minus_sign: | The chroma location of the video stream | left |
|
| `dovielPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||||
| `streamIdentifier` | *Optional\<String>* | :heavy_minus_sign: | The identifier of the video stream | 2 |
|
| `doviLevel` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||||
| `chromaSubsampling` | *Optional\<String>* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
|
| `doviPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||||
| `codedHeight` | *Optional\<Long>* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
|
| `doviProfile` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||||
| `codedWidth` | *Optional\<Long>* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
|
| `dovirpuPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||||
| `frameRate` | *Optional\<Double>* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
|
| `doviVersion` | *Optional\<String>* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||||
| `hasScalingMatrix` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
|
| `bitDepth` | *Optional\<Integer>* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||||
| `hearingImpaired` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `chromaLocation` | *Optional\<String>* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||||
| `closedCaptions` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `chromaSubsampling` | *Optional\<String>* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||||
| `embeddedInVideo` | *Optional\<String>* | :heavy_minus_sign: | N/A | 1 |
|
| `codedHeight` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||||
| `height` | *Optional\<Long>* | :heavy_minus_sign: | The height of the video stream | 1080 |
|
| `codedWidth` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||||
| `level` | *Optional\<Long>* | :heavy_minus_sign: | The level of the video codec | 40 |
|
| `closedCaptions` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||||
| `profile` | *Optional\<String>* | :heavy_minus_sign: | The profile of the video codec | main |
|
| `colorPrimaries` | *Optional\<String>* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||||
| `refFrames` | *Optional\<Long>* | :heavy_minus_sign: | Number of reference frames | 4 |
|
| `colorRange` | *Optional\<String>* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||||
| `scanType` | *Optional\<String>* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
|
| `colorSpace` | *Optional\<String>* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||||
| `width` | *Optional\<Long>* | :heavy_minus_sign: | The width of the video stream | 1920 |
|
| `colorTrc` | *Optional\<String>* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||||
| `displayTitle` | *Optional\<String>* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
|
| `frameRate` | *Optional\<Float>* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||||
| `extendedDisplayTitle` | *Optional\<String>* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
|
| `height` | *Optional\<Integer>* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||||
| `channels` | *Optional\<Long>* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
|
| `level` | *Optional\<Integer>* | :heavy_minus_sign: | Video level. | 150 |
|
||||||
| `language` | *Optional\<String>* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
|
| `original` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||||
| `languageTag` | *Optional\<String>* | :heavy_minus_sign: | Language tag of the stream | en |
|
| `hasScalingMatrix` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
| `languageCode` | *Optional\<String>* | :heavy_minus_sign: | Language code of the stream | eng |
|
| `profile` | *Optional\<String>* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||||
| `audioChannelLayout` | *Optional\<String>* | :heavy_minus_sign: | The audio channel layout | stereo |
|
| `scanType` | *Optional\<String>* | :heavy_minus_sign: | N/A | progressive |
|
||||||
| `samplingRate` | *Optional\<Long>* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
|
| `embeddedInVideo` | *Optional\<String>* | :heavy_minus_sign: | N/A | progressive |
|
||||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
|
| `refFrames` | *Optional\<Integer>* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||||
| `canAutoSync` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |
|
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||||
|
| `displayTitle` | *String* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
|
| `extendedDisplayTitle` | *String* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
|
| `selected` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||||
|
| `forced` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `channels` | *Optional\<Integer>* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||||
|
| `audioChannelLayout` | *Optional\<String>* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||||
|
| `samplingRate` | *Optional\<Integer>* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||||
|
| `canAutoSync` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||||
|
| `hearingImpaired` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||||
|
| `dub` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||||
|
| `title` | *Optional\<String>* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||||
@@ -3,6 +3,9 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | James Cameron |
|
| `id` | *long* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | The filter string used to query this writer. | writer=126522 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
|
||||||
|
| `tagKey` | *Optional\<String>* | :heavy_minus_sign: | A unique key associated with the writers tag, used for internal identification. | 5d77683d85719b001f3a535e |
|
||||||
@@ -26,9 +26,7 @@ package hello.world;
|
|||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.GetTransientTokenBadRequest;
|
import dev.plexapi.sdk.models.errors.GetTransientTokenBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.GetTransientTokenUnauthorized;
|
import dev.plexapi.sdk.models.errors.GetTransientTokenUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.GetTransientTokenQueryParamType;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import dev.plexapi.sdk.models.operations.GetTransientTokenResponse;
|
|
||||||
import dev.plexapi.sdk.models.operations.Scope;
|
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
@@ -183,9 +181,7 @@ package hello.world;
|
|||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.PostUsersSignInDataBadRequest;
|
import dev.plexapi.sdk.models.errors.PostUsersSignInDataBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.PostUsersSignInDataUnauthorized;
|
import dev.plexapi.sdk.models.errors.PostUsersSignInDataUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.PostUsersSignInDataRequest;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import dev.plexapi.sdk.models.operations.PostUsersSignInDataRequestBody;
|
|
||||||
import dev.plexapi.sdk.models.operations.PostUsersSignInDataResponse;
|
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
|
|||||||
@@ -37,7 +37,7 @@ public class Application {
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetGlobalHubsResponse res = sdk.hubs().getGlobalHubs()
|
GetGlobalHubsResponse res = sdk.hubs().getGlobalHubs()
|
||||||
.count(1262.49d)
|
.count(1262.49)
|
||||||
.onlyTransient(OnlyTransient.ONE)
|
.onlyTransient(OnlyTransient.ONE)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
@@ -78,9 +78,7 @@ This endpoint will return the recently added content.
|
|||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.operations.GetRecentlyAddedRequest;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import dev.plexapi.sdk.models.operations.GetRecentlyAddedResponse;
|
|
||||||
import dev.plexapi.sdk.models.operations.Type;
|
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
@@ -150,8 +148,8 @@ public class Application {
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetLibraryHubsResponse res = sdk.hubs().getLibraryHubs()
|
GetLibraryHubsResponse res = sdk.hubs().getLibraryHubs()
|
||||||
.sectionId(6728.76d)
|
.sectionId(6728.76)
|
||||||
.count(6728.76d)
|
.count(6728.76)
|
||||||
.onlyTransient(QueryParamOnlyTransient.ZERO)
|
.onlyTransient(QueryParamOnlyTransient.ZERO)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
|
|||||||
@@ -22,9 +22,12 @@ API Calls interacting with Plex Media Server Libraries
|
|||||||
* [getActorsLibrary](#getactorslibrary) - Get Actors of library media
|
* [getActorsLibrary](#getactorslibrary) - Get Actors of library media
|
||||||
* [getSearchAllLibraries](#getsearchalllibraries) - Search All Libraries
|
* [getSearchAllLibraries](#getsearchalllibraries) - Search All Libraries
|
||||||
* [getMediaMetaData](#getmediametadata) - Get Media Metadata
|
* [getMediaMetaData](#getmediametadata) - Get Media Metadata
|
||||||
|
* [getMediaArts](#getmediaarts) - Get Media Background Artwork
|
||||||
|
* [postMediaArts](#postmediaarts) - Upload Media Background Artwork
|
||||||
|
* [getMediaPosters](#getmediaposters) - Get Media Posters
|
||||||
|
* [postMediaPoster](#postmediaposter) - Upload Media Poster
|
||||||
* [getMetadataChildren](#getmetadatachildren) - Get Items Children
|
* [getMetadataChildren](#getmetadatachildren) - Get Items Children
|
||||||
* [getTopWatchedContent](#gettopwatchedcontent) - Get Top Watched Content
|
* [getTopWatchedContent](#gettopwatchedcontent) - Get Top Watched Content
|
||||||
* [getOnDeck](#getondeck) - Get On Deck
|
|
||||||
|
|
||||||
## getFileHash
|
## getFileHash
|
||||||
|
|
||||||
@@ -51,7 +54,7 @@ public class Application {
|
|||||||
|
|
||||||
GetFileHashResponse res = sdk.library().getFileHash()
|
GetFileHashResponse res = sdk.library().getFileHash()
|
||||||
.url("file://C:\Image.png&type=13")
|
.url("file://C:\Image.png&type=13")
|
||||||
.type(4462.17d)
|
.type(4462.17)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -91,9 +94,7 @@ package hello.world;
|
|||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.GetRecentlyAddedLibraryBadRequest;
|
import dev.plexapi.sdk.models.errors.GetRecentlyAddedLibraryBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.GetRecentlyAddedLibraryUnauthorized;
|
import dev.plexapi.sdk.models.errors.GetRecentlyAddedLibraryUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.GetRecentlyAddedLibraryRequest;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import dev.plexapi.sdk.models.operations.GetRecentlyAddedLibraryResponse;
|
|
||||||
import dev.plexapi.sdk.models.operations.QueryParamType;
|
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
|
|
||||||
@@ -381,10 +382,7 @@ package hello.world;
|
|||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.GetLibraryItemsBadRequest;
|
import dev.plexapi.sdk.models.errors.GetLibraryItemsBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.GetLibraryItemsUnauthorized;
|
import dev.plexapi.sdk.models.errors.GetLibraryItemsUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.GetLibraryItemsQueryParamType;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import dev.plexapi.sdk.models.operations.GetLibraryItemsRequest;
|
|
||||||
import dev.plexapi.sdk.models.operations.GetLibraryItemsResponse;
|
|
||||||
import dev.plexapi.sdk.models.operations.Tag;
|
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
@@ -443,9 +441,7 @@ package hello.world;
|
|||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.GetAllMediaLibraryBadRequest;
|
import dev.plexapi.sdk.models.errors.GetAllMediaLibraryBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.GetAllMediaLibraryUnauthorized;
|
import dev.plexapi.sdk.models.errors.GetAllMediaLibraryUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.GetAllMediaLibraryQueryParamType;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import dev.plexapi.sdk.models.operations.GetAllMediaLibraryRequest;
|
|
||||||
import dev.plexapi.sdk.models.operations.GetAllMediaLibraryResponse;
|
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
@@ -798,9 +794,7 @@ package hello.world;
|
|||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.GetSearchAllLibrariesBadRequest;
|
import dev.plexapi.sdk.models.errors.GetSearchAllLibrariesBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.GetSearchAllLibrariesUnauthorized;
|
import dev.plexapi.sdk.models.errors.GetSearchAllLibrariesUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.GetSearchAllLibrariesRequest;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import dev.plexapi.sdk.models.operations.GetSearchAllLibrariesResponse;
|
|
||||||
import dev.plexapi.sdk.models.operations.SearchTypes;
|
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
|
|
||||||
@@ -919,6 +913,204 @@ public class Application {
|
|||||||
| models/errors/GetMediaMetaDataUnauthorized | 401 | application/json |
|
| models/errors/GetMediaMetaDataUnauthorized | 401 | application/json |
|
||||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||||
|
|
||||||
|
## getMediaArts
|
||||||
|
|
||||||
|
Returns the background artwork for a library item.
|
||||||
|
|
||||||
|
### Example Usage
|
||||||
|
|
||||||
|
```java
|
||||||
|
package hello.world;
|
||||||
|
|
||||||
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
|
import dev.plexapi.sdk.models.operations.GetMediaArtsResponse;
|
||||||
|
import java.lang.Exception;
|
||||||
|
|
||||||
|
public class Application {
|
||||||
|
|
||||||
|
public static void main(String[] args) throws Exception {
|
||||||
|
|
||||||
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
|
.build();
|
||||||
|
|
||||||
|
GetMediaArtsResponse res = sdk.library().getMediaArts()
|
||||||
|
.ratingKey(16099L)
|
||||||
|
.call();
|
||||||
|
|
||||||
|
if (res.object().isPresent()) {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
| Parameter | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
||||||
|
| `ratingKey` | *long* | :heavy_check_mark: | the id of the library item to return the artwork of. | 16099 |
|
||||||
|
|
||||||
|
### Response
|
||||||
|
|
||||||
|
**[GetMediaArtsResponse](../../models/operations/GetMediaArtsResponse.md)**
|
||||||
|
|
||||||
|
### Errors
|
||||||
|
|
||||||
|
| Error Type | Status Code | Content Type |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||||
|
|
||||||
|
## postMediaArts
|
||||||
|
|
||||||
|
Uploads an image to use as the background artwork for a library item, either from a local file or a remote URL
|
||||||
|
|
||||||
|
### Example Usage
|
||||||
|
|
||||||
|
```java
|
||||||
|
package hello.world;
|
||||||
|
|
||||||
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
|
import dev.plexapi.sdk.models.operations.PostMediaArtsResponse;
|
||||||
|
import java.lang.Exception;
|
||||||
|
import java.nio.charset.StandardCharsets;
|
||||||
|
|
||||||
|
public class Application {
|
||||||
|
|
||||||
|
public static void main(String[] args) throws Exception {
|
||||||
|
|
||||||
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
|
.build();
|
||||||
|
|
||||||
|
PostMediaArtsResponse res = sdk.library().postMediaArts()
|
||||||
|
.ratingKey(2268L)
|
||||||
|
.url("https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b")
|
||||||
|
.requestBody("0xee51EFC6De".getBytes(StandardCharsets.UTF_8))
|
||||||
|
.call();
|
||||||
|
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
| Parameter | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||||
|
| `ratingKey` | *long* | :heavy_check_mark: | the id of the library item to return the posters of. | 2268 |
|
||||||
|
| `url` | *Optional\<String>* | :heavy_minus_sign: | The URL of the image, if uploading a remote image | https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b |
|
||||||
|
| `requestBody` | *Optional\<byte[]>* | :heavy_minus_sign: | The contents of the image, if uploading a local file | |
|
||||||
|
|
||||||
|
### Response
|
||||||
|
|
||||||
|
**[PostMediaArtsResponse](../../models/operations/PostMediaArtsResponse.md)**
|
||||||
|
|
||||||
|
### Errors
|
||||||
|
|
||||||
|
| Error Type | Status Code | Content Type |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||||
|
|
||||||
|
## getMediaPosters
|
||||||
|
|
||||||
|
Returns the available posters for a library item.
|
||||||
|
|
||||||
|
### Example Usage
|
||||||
|
|
||||||
|
```java
|
||||||
|
package hello.world;
|
||||||
|
|
||||||
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
|
import dev.plexapi.sdk.models.operations.GetMediaPostersResponse;
|
||||||
|
import java.lang.Exception;
|
||||||
|
|
||||||
|
public class Application {
|
||||||
|
|
||||||
|
public static void main(String[] args) throws Exception {
|
||||||
|
|
||||||
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
|
.build();
|
||||||
|
|
||||||
|
GetMediaPostersResponse res = sdk.library().getMediaPosters()
|
||||||
|
.ratingKey(16099L)
|
||||||
|
.call();
|
||||||
|
|
||||||
|
if (res.object().isPresent()) {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
| Parameter | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
||||||
|
| `ratingKey` | *long* | :heavy_check_mark: | the id of the library item to return the posters of. | 16099 |
|
||||||
|
|
||||||
|
### Response
|
||||||
|
|
||||||
|
**[GetMediaPostersResponse](../../models/operations/GetMediaPostersResponse.md)**
|
||||||
|
|
||||||
|
### Errors
|
||||||
|
|
||||||
|
| Error Type | Status Code | Content Type |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||||
|
|
||||||
|
## postMediaPoster
|
||||||
|
|
||||||
|
Uploads a poster to a library item, either from a local file or a remote URL
|
||||||
|
|
||||||
|
### Example Usage
|
||||||
|
|
||||||
|
```java
|
||||||
|
package hello.world;
|
||||||
|
|
||||||
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
|
import dev.plexapi.sdk.models.operations.PostMediaPosterResponse;
|
||||||
|
import java.lang.Exception;
|
||||||
|
import java.nio.charset.StandardCharsets;
|
||||||
|
|
||||||
|
public class Application {
|
||||||
|
|
||||||
|
public static void main(String[] args) throws Exception {
|
||||||
|
|
||||||
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
|
.build();
|
||||||
|
|
||||||
|
PostMediaPosterResponse res = sdk.library().postMediaPoster()
|
||||||
|
.ratingKey(2268L)
|
||||||
|
.url("https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b")
|
||||||
|
.requestBody("0x7C3d45ad4B".getBytes(StandardCharsets.UTF_8))
|
||||||
|
.call();
|
||||||
|
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
| Parameter | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||||
|
| `ratingKey` | *long* | :heavy_check_mark: | the id of the library item to return the posters of. | 2268 |
|
||||||
|
| `url` | *Optional\<String>* | :heavy_minus_sign: | The URL of the image, if uploading a remote image | https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b |
|
||||||
|
| `requestBody` | *Optional\<byte[]>* | :heavy_minus_sign: | The contents of the image, if uploading a local file | |
|
||||||
|
|
||||||
|
### Response
|
||||||
|
|
||||||
|
**[PostMediaPosterResponse](../../models/operations/PostMediaPosterResponse.md)**
|
||||||
|
|
||||||
|
### Errors
|
||||||
|
|
||||||
|
| Error Type | Status Code | Content Type |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||||
|
|
||||||
## getMetadataChildren
|
## getMetadataChildren
|
||||||
|
|
||||||
This endpoint will return the children of of a library item specified with the ratingKey.
|
This endpoint will return the children of of a library item specified with the ratingKey.
|
||||||
@@ -944,7 +1136,7 @@ public class Application {
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetMetadataChildrenResponse res = sdk.library().getMetadataChildren()
|
GetMetadataChildrenResponse res = sdk.library().getMetadataChildren()
|
||||||
.ratingKey(1539.14d)
|
.ratingKey(1539.14)
|
||||||
.includeElements("Stream")
|
.includeElements("Stream")
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
@@ -1028,50 +1220,4 @@ public class Application {
|
|||||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||||
| models/errors/GetTopWatchedContentBadRequest | 400 | application/json |
|
| models/errors/GetTopWatchedContentBadRequest | 400 | application/json |
|
||||||
| models/errors/GetTopWatchedContentUnauthorized | 401 | application/json |
|
| models/errors/GetTopWatchedContentUnauthorized | 401 | application/json |
|
||||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||||
|
|
||||||
## getOnDeck
|
|
||||||
|
|
||||||
This endpoint will return the on deck content.
|
|
||||||
|
|
||||||
|
|
||||||
### Example Usage
|
|
||||||
|
|
||||||
```java
|
|
||||||
package hello.world;
|
|
||||||
|
|
||||||
import dev.plexapi.sdk.PlexAPI;
|
|
||||||
import dev.plexapi.sdk.models.errors.GetOnDeckBadRequest;
|
|
||||||
import dev.plexapi.sdk.models.errors.GetOnDeckUnauthorized;
|
|
||||||
import dev.plexapi.sdk.models.operations.GetOnDeckResponse;
|
|
||||||
import java.lang.Exception;
|
|
||||||
|
|
||||||
public class Application {
|
|
||||||
|
|
||||||
public static void main(String[] args) throws GetOnDeckBadRequest, GetOnDeckUnauthorized, Exception {
|
|
||||||
|
|
||||||
PlexAPI sdk = PlexAPI.builder()
|
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
|
||||||
.build();
|
|
||||||
|
|
||||||
GetOnDeckResponse res = sdk.library().getOnDeck()
|
|
||||||
.call();
|
|
||||||
|
|
||||||
if (res.object().isPresent()) {
|
|
||||||
// handle response
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Response
|
|
||||||
|
|
||||||
**[GetOnDeckResponse](../../models/operations/GetOnDeckResponse.md)**
|
|
||||||
|
|
||||||
### Errors
|
|
||||||
|
|
||||||
| Error Type | Status Code | Content Type |
|
|
||||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
|
||||||
| models/errors/GetOnDeckBadRequest | 400 | application/json |
|
|
||||||
| models/errors/GetOnDeckUnauthorized | 401 | application/json |
|
|
||||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
|
||||||
@@ -38,7 +38,7 @@ public class Application {
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
MarkPlayedResponse res = sdk.media().markPlayed()
|
MarkPlayedResponse res = sdk.media().markPlayed()
|
||||||
.key(59398d)
|
.key(59398)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -88,7 +88,7 @@ public class Application {
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
MarkUnplayedResponse res = sdk.media().markUnplayed()
|
MarkUnplayedResponse res = sdk.media().markUnplayed()
|
||||||
.key(59398d)
|
.key(59398)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -140,7 +140,7 @@ public class Application {
|
|||||||
|
|
||||||
UpdatePlayProgressResponse res = sdk.media().updatePlayProgress()
|
UpdatePlayProgressResponse res = sdk.media().updatePlayProgress()
|
||||||
.key("<key>")
|
.key("<key>")
|
||||||
.time(90000d)
|
.time(90000)
|
||||||
.state("played")
|
.state("played")
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
|
|||||||
@@ -36,10 +36,7 @@ package hello.world;
|
|||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.CreatePlaylistBadRequest;
|
import dev.plexapi.sdk.models.errors.CreatePlaylistBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.CreatePlaylistUnauthorized;
|
import dev.plexapi.sdk.models.errors.CreatePlaylistUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.CreatePlaylistQueryParamType;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import dev.plexapi.sdk.models.operations.CreatePlaylistRequest;
|
|
||||||
import dev.plexapi.sdk.models.operations.CreatePlaylistResponse;
|
|
||||||
import dev.plexapi.sdk.models.operations.Smart;
|
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
@@ -98,9 +95,7 @@ package hello.world;
|
|||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.GetPlaylistsBadRequest;
|
import dev.plexapi.sdk.models.errors.GetPlaylistsBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.GetPlaylistsUnauthorized;
|
import dev.plexapi.sdk.models.errors.GetPlaylistsUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.GetPlaylistsResponse;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import dev.plexapi.sdk.models.operations.PlaylistType;
|
|
||||||
import dev.plexapi.sdk.models.operations.QueryParamSmart;
|
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
@@ -168,7 +163,7 @@ public class Application {
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetPlaylistResponse res = sdk.playlists().getPlaylist()
|
GetPlaylistResponse res = sdk.playlists().getPlaylist()
|
||||||
.playlistID(4109.48d)
|
.playlistID(4109.48)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
if (res.object().isPresent()) {
|
if (res.object().isPresent()) {
|
||||||
@@ -221,7 +216,7 @@ public class Application {
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
DeletePlaylistResponse res = sdk.playlists().deletePlaylist()
|
DeletePlaylistResponse res = sdk.playlists().deletePlaylist()
|
||||||
.playlistID(216.22d)
|
.playlistID(216.22)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -272,7 +267,7 @@ public class Application {
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
UpdatePlaylistResponse res = sdk.playlists().updatePlaylist()
|
UpdatePlaylistResponse res = sdk.playlists().updatePlaylist()
|
||||||
.playlistID(3915d)
|
.playlistID(3915)
|
||||||
.title("<value>")
|
.title("<value>")
|
||||||
.summary("<value>")
|
.summary("<value>")
|
||||||
.call();
|
.call();
|
||||||
@@ -331,7 +326,7 @@ public class Application {
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetPlaylistContentsResponse res = sdk.playlists().getPlaylistContents()
|
GetPlaylistContentsResponse res = sdk.playlists().getPlaylistContents()
|
||||||
.playlistID(5004.46d)
|
.playlistID(5004.46)
|
||||||
.type(GetPlaylistContentsQueryParamType.TvShow)
|
.type(GetPlaylistContentsQueryParamType.TvShow)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
@@ -386,7 +381,7 @@ public class Application {
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
ClearPlaylistContentsResponse res = sdk.playlists().clearPlaylistContents()
|
ClearPlaylistContentsResponse res = sdk.playlists().clearPlaylistContents()
|
||||||
.playlistID(1893.18d)
|
.playlistID(1893.18)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -438,9 +433,9 @@ public class Application {
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
AddPlaylistContentsResponse res = sdk.playlists().addPlaylistContents()
|
AddPlaylistContentsResponse res = sdk.playlists().addPlaylistContents()
|
||||||
.playlistID(8502.01d)
|
.playlistID(8502.01)
|
||||||
.uri("server://12345/com.plexapp.plugins.library/library/metadata/1")
|
.uri("server://12345/com.plexapp.plugins.library/library/metadata/1")
|
||||||
.playQueueID(123d)
|
.playQueueID(123)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
if (res.object().isPresent()) {
|
if (res.object().isPresent()) {
|
||||||
|
|||||||
@@ -225,10 +225,7 @@ package hello.world;
|
|||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.GetServerResourcesBadRequest;
|
import dev.plexapi.sdk.models.errors.GetServerResourcesBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.GetServerResourcesUnauthorized;
|
import dev.plexapi.sdk.models.errors.GetServerResourcesUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.GetServerResourcesResponse;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import dev.plexapi.sdk.models.operations.IncludeHttps;
|
|
||||||
import dev.plexapi.sdk.models.operations.IncludeIPv6;
|
|
||||||
import dev.plexapi.sdk.models.operations.IncludeRelay;
|
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
|
|||||||
@@ -49,8 +49,8 @@ public class Application {
|
|||||||
|
|
||||||
PerformSearchResponse res = sdk.search().performSearch()
|
PerformSearchResponse res = sdk.search().performSearch()
|
||||||
.query("dylan")
|
.query("dylan")
|
||||||
.sectionId(9487.88d)
|
.sectionId(9487.88)
|
||||||
.limit(5d)
|
.limit(5)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -107,8 +107,8 @@ public class Application {
|
|||||||
|
|
||||||
PerformVoiceSearchResponse res = sdk.search().performVoiceSearch()
|
PerformVoiceSearchResponse res = sdk.search().performVoiceSearch()
|
||||||
.query("dead+poop")
|
.query("dead+poop")
|
||||||
.sectionId(4094.8d)
|
.sectionId(4094.8)
|
||||||
.limit(5d)
|
.limit(5)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
|
|||||||
@@ -298,10 +298,7 @@ package hello.world;
|
|||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.GetResizedPhotoBadRequest;
|
import dev.plexapi.sdk.models.errors.GetResizedPhotoBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.GetResizedPhotoUnauthorized;
|
import dev.plexapi.sdk.models.errors.GetResizedPhotoUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.GetResizedPhotoRequest;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import dev.plexapi.sdk.models.operations.GetResizedPhotoResponse;
|
|
||||||
import dev.plexapi.sdk.models.operations.MinSize;
|
|
||||||
import dev.plexapi.sdk.models.operations.Upscale;
|
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
@@ -313,10 +310,10 @@ public class Application {
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetResizedPhotoRequest req = GetResizedPhotoRequest.builder()
|
GetResizedPhotoRequest req = GetResizedPhotoRequest.builder()
|
||||||
.width(110d)
|
.width(110)
|
||||||
.height(165d)
|
.height(165)
|
||||||
.opacity(100L)
|
.opacity(100L)
|
||||||
.blur(0d)
|
.blur(0)
|
||||||
.minSize(MinSize.ONE)
|
.minSize(MinSize.ONE)
|
||||||
.upscale(Upscale.ONE)
|
.upscale(Upscale.ONE)
|
||||||
.url("/library/metadata/49564/thumb/1654258204")
|
.url("/library/metadata/49564/thumb/1654258204")
|
||||||
|
|||||||
@@ -122,9 +122,7 @@ package hello.world;
|
|||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.ApplyUpdatesBadRequest;
|
import dev.plexapi.sdk.models.errors.ApplyUpdatesBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.ApplyUpdatesUnauthorized;
|
import dev.plexapi.sdk.models.errors.ApplyUpdatesUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.ApplyUpdatesResponse;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import dev.plexapi.sdk.models.operations.Skip;
|
|
||||||
import dev.plexapi.sdk.models.operations.Tonight;
|
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
|
|||||||
@@ -23,9 +23,7 @@ package hello.world;
|
|||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.GetTimelineBadRequest;
|
import dev.plexapi.sdk.models.errors.GetTimelineBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.GetTimelineUnauthorized;
|
import dev.plexapi.sdk.models.errors.GetTimelineUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.GetTimelineRequest;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import dev.plexapi.sdk.models.operations.GetTimelineResponse;
|
|
||||||
import dev.plexapi.sdk.models.operations.State;
|
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
@@ -37,16 +35,16 @@ public class Application {
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetTimelineRequest req = GetTimelineRequest.builder()
|
GetTimelineRequest req = GetTimelineRequest.builder()
|
||||||
.ratingKey(23409d)
|
.ratingKey(23409)
|
||||||
.key("/library/metadata/23409")
|
.key("/library/metadata/23409")
|
||||||
.state(State.PLAYING)
|
.state(State.PLAYING)
|
||||||
.hasMDE(1d)
|
.hasMDE(1)
|
||||||
.time(2000d)
|
.time(2000)
|
||||||
.duration(10000d)
|
.duration(10000)
|
||||||
.context("home:hub.continueWatching")
|
.context("home:hub.continueWatching")
|
||||||
.playQueueItemID(1d)
|
.playQueueItemID(1)
|
||||||
.playBackTime(2000d)
|
.playBackTime(2000)
|
||||||
.row(1d)
|
.row(1)
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetTimelineResponse res = sdk.video().getTimeline()
|
GetTimelineResponse res = sdk.video().getTimeline()
|
||||||
@@ -101,22 +99,22 @@ public class Application {
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
StartUniversalTranscodeRequest req = StartUniversalTranscodeRequest.builder()
|
StartUniversalTranscodeRequest req = StartUniversalTranscodeRequest.builder()
|
||||||
.hasMDE(1d)
|
.hasMDE(1)
|
||||||
.path("/library/metadata/23409")
|
.path("/library/metadata/23409")
|
||||||
.mediaIndex(0d)
|
.mediaIndex(0)
|
||||||
.partIndex(0d)
|
.partIndex(0)
|
||||||
.protocol("hls")
|
.protocol("hls")
|
||||||
.fastSeek(0d)
|
.fastSeek(0)
|
||||||
.directPlay(0d)
|
.directPlay(0)
|
||||||
.directStream(0d)
|
.directStream(0)
|
||||||
.subtitleSize(100d)
|
.subtitleSize(100)
|
||||||
.subtites("burn")
|
.subtites("burn")
|
||||||
.audioBoost(100d)
|
.audioBoost(100)
|
||||||
.location("lan")
|
.location("lan")
|
||||||
.mediaBufferSize(102400d)
|
.mediaBufferSize(102400)
|
||||||
.session("zvcage8b7rkioqcm8f4uns4c")
|
.session("zvcage8b7rkioqcm8f4uns4c")
|
||||||
.addDebugOverlay(0d)
|
.addDebugOverlay(0)
|
||||||
.autoAdjustQuality(0d)
|
.autoAdjustQuality(0)
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
StartUniversalTranscodeResponse res = sdk.video().startUniversalTranscode()
|
StartUniversalTranscodeResponse res = sdk.video().startUniversalTranscode()
|
||||||
|
|||||||
@@ -22,9 +22,7 @@ package hello.world;
|
|||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.GetWatchListBadRequest;
|
import dev.plexapi.sdk.models.errors.GetWatchListBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.GetWatchListUnauthorized;
|
import dev.plexapi.sdk.models.errors.GetWatchListUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.Filter;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import dev.plexapi.sdk.models.operations.GetWatchListRequest;
|
|
||||||
import dev.plexapi.sdk.models.operations.GetWatchListResponse;
|
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
|
|||||||
3
gradle.properties
Normal file
3
gradle.properties
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
groupId=dev.plexapi
|
||||||
|
artifactId=plexapi
|
||||||
|
version=0.14.1
|
||||||
@@ -1,7 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package dev.plexapi.sdk;
|
package dev.plexapi.sdk;
|
||||||
|
|
||||||
import com.fasterxml.jackson.core.type.TypeReference;
|
import com.fasterxml.jackson.core.type.TypeReference;
|
||||||
@@ -29,7 +28,7 @@ import java.lang.String;
|
|||||||
import java.net.http.HttpRequest;
|
import java.net.http.HttpRequest;
|
||||||
import java.net.http.HttpResponse;
|
import java.net.http.HttpResponse;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Activities are awesome. They provide a way to monitor and control asynchronous operations on the server. In order to receive real-time updates for activities, a client would normally subscribe via either EventSource or Websocket endpoints.
|
* Activities are awesome. They provide a way to monitor and control asynchronous operations on the server. In order to receive real-time updates for activities, a client would normally subscribe via either EventSource or Websocket endpoints.
|
||||||
@@ -39,7 +38,6 @@ import java.util.Optional;
|
|||||||
* - They must contain an `type` which is used by clients to distinguish the specific activity.
|
* - They must contain an `type` which is used by clients to distinguish the specific activity.
|
||||||
* - They may contain a `Context` object with attributes which associate the activity with various specific entities (items, libraries, etc.)
|
* - They may contain a `Context` object with attributes which associate the activity with various specific entities (items, libraries, etc.)
|
||||||
* - The may contain a `Response` object which attributes which represent the result of the asynchronous operation.
|
* - The may contain a `Response` object which attributes which represent the result of the asynchronous operation.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public class Activities implements
|
public class Activities implements
|
||||||
MethodCallGetServerActivities,
|
MethodCallGetServerActivities,
|
||||||
@@ -54,7 +52,9 @@ public class Activities implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Server Activities
|
* Get Server Activities
|
||||||
* Get Server Activities
|
*
|
||||||
|
* <p>Get Server Activities
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetServerActivitiesRequestBuilder getServerActivities() {
|
public GetServerActivitiesRequestBuilder getServerActivities() {
|
||||||
@@ -63,7 +63,9 @@ public class Activities implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Server Activities
|
* Get Server Activities
|
||||||
* Get Server Activities
|
*
|
||||||
|
* <p>Get Server Activities
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -87,6 +89,7 @@ public class Activities implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getServerActivities",
|
"getServerActivities",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -98,6 +101,7 @@ public class Activities implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getServerActivities",
|
"getServerActivities",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -107,6 +111,7 @@ public class Activities implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getServerActivities",
|
"getServerActivities",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -116,6 +121,7 @@ public class Activities implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getServerActivities",
|
"getServerActivities",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -209,7 +215,9 @@ public class Activities implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Cancel Server Activities
|
* Cancel Server Activities
|
||||||
* Cancel Server Activities
|
*
|
||||||
|
* <p>Cancel Server Activities
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public CancelServerActivitiesRequestBuilder cancelServerActivities() {
|
public CancelServerActivitiesRequestBuilder cancelServerActivities() {
|
||||||
@@ -218,7 +226,9 @@ public class Activities implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Cancel Server Activities
|
* Cancel Server Activities
|
||||||
* Cancel Server Activities
|
*
|
||||||
|
* <p>Cancel Server Activities
|
||||||
|
*
|
||||||
* @param activityUUID The UUID of the activity to cancel.
|
* @param activityUUID The UUID of the activity to cancel.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
@@ -252,6 +262,7 @@ public class Activities implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"cancelServerActivities",
|
"cancelServerActivities",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -263,6 +274,7 @@ public class Activities implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"cancelServerActivities",
|
"cancelServerActivities",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -272,6 +284,7 @@ public class Activities implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"cancelServerActivities",
|
"cancelServerActivities",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -281,6 +294,7 @@ public class Activities implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"cancelServerActivities",
|
"cancelServerActivities",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package dev.plexapi.sdk;
|
package dev.plexapi.sdk;
|
||||||
|
|
||||||
import com.fasterxml.jackson.core.type.TypeReference;
|
import com.fasterxml.jackson.core.type.TypeReference;
|
||||||
@@ -46,11 +45,10 @@ import java.net.http.HttpRequest;
|
|||||||
import java.net.http.HttpResponse;
|
import java.net.http.HttpResponse;
|
||||||
import java.util.HashMap;
|
import java.util.HashMap;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls regarding authentication for Plex Media Server
|
* API Calls regarding authentication for Plex Media Server
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public class Authentication implements
|
public class Authentication implements
|
||||||
MethodCallGetTransientToken,
|
MethodCallGetTransientToken,
|
||||||
@@ -81,7 +79,8 @@ public class Authentication implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a Transient Token
|
* Get a Transient Token
|
||||||
* This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.
|
*
|
||||||
|
* <p>This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.
|
||||||
*
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
@@ -91,7 +90,8 @@ public class Authentication implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a Transient Token
|
* Get a Transient Token
|
||||||
* This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.
|
*
|
||||||
|
* <p>This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.
|
||||||
*
|
*
|
||||||
* @param type `delegation` - This is the only supported `type` parameter.
|
* @param type `delegation` - This is the only supported `type` parameter.
|
||||||
* @param scope `all` - This is the only supported `scope` parameter.
|
* @param scope `all` - This is the only supported `scope` parameter.
|
||||||
@@ -132,6 +132,7 @@ public class Authentication implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getTransientToken",
|
"getTransientToken",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -143,6 +144,7 @@ public class Authentication implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getTransientToken",
|
"getTransientToken",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -152,6 +154,7 @@ public class Authentication implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getTransientToken",
|
"getTransientToken",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -161,6 +164,7 @@ public class Authentication implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getTransientToken",
|
"getTransientToken",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -243,7 +247,8 @@ public class Authentication implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Source Connection Information
|
* Get Source Connection Information
|
||||||
* If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token.
|
*
|
||||||
|
* <p>If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token.
|
||||||
* Note: requires Plex Media Server >= 1.15.4.
|
* Note: requires Plex Media Server >= 1.15.4.
|
||||||
*
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
@@ -254,7 +259,8 @@ public class Authentication implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Source Connection Information
|
* Get Source Connection Information
|
||||||
* If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token.
|
*
|
||||||
|
* <p>If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token.
|
||||||
* Note: requires Plex Media Server >= 1.15.4.
|
* Note: requires Plex Media Server >= 1.15.4.
|
||||||
*
|
*
|
||||||
* @param source The source identifier with an included prefix.
|
* @param source The source identifier with an included prefix.
|
||||||
@@ -293,6 +299,7 @@ public class Authentication implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getSourceConnectionInformation",
|
"getSourceConnectionInformation",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -304,6 +311,7 @@ public class Authentication implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getSourceConnectionInformation",
|
"getSourceConnectionInformation",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -313,6 +321,7 @@ public class Authentication implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getSourceConnectionInformation",
|
"getSourceConnectionInformation",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -322,6 +331,7 @@ public class Authentication implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getSourceConnectionInformation",
|
"getSourceConnectionInformation",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -404,7 +414,9 @@ public class Authentication implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Token Details
|
* Get Token Details
|
||||||
* Get the User data from the provided X-Plex-Token
|
*
|
||||||
|
* <p>Get the User data from the provided X-Plex-Token
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetTokenDetailsRequestBuilder getTokenDetails() {
|
public GetTokenDetailsRequestBuilder getTokenDetails() {
|
||||||
@@ -413,7 +425,9 @@ public class Authentication implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Token Details
|
* Get Token Details
|
||||||
* Get the User data from the provided X-Plex-Token
|
*
|
||||||
|
* <p>Get the User data from the provided X-Plex-Token
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -423,16 +437,20 @@ public class Authentication implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Token Details
|
* Get Token Details
|
||||||
* Get the User data from the provided X-Plex-Token
|
*
|
||||||
|
* <p>Get the User data from the provided X-Plex-Token
|
||||||
|
*
|
||||||
* @param serverURL Overrides the server URL.
|
* @param serverURL Overrides the server URL.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
public GetTokenDetailsResponse getTokenDetails(
|
public GetTokenDetailsResponse getTokenDetails(
|
||||||
Optional<String> serverURL) throws Exception {
|
Optional<String> serverURL) throws Exception {
|
||||||
String _baseUrl = Utils.templateUrl(GET_TOKEN_DETAILS_SERVERS[0], new HashMap<String, String>());
|
final String _baseUrl;
|
||||||
if (serverURL.isPresent() && !serverURL.get().isBlank()) {
|
if (serverURL.isPresent() && !serverURL.get().isBlank()) {
|
||||||
_baseUrl = serverURL.get();
|
_baseUrl = serverURL.get();
|
||||||
|
} else {
|
||||||
|
_baseUrl = Utils.templateUrl(GET_TOKEN_DETAILS_SERVERS[0], new HashMap<String, String>());
|
||||||
}
|
}
|
||||||
String _url = Utils.generateURL(
|
String _url = Utils.generateURL(
|
||||||
_baseUrl,
|
_baseUrl,
|
||||||
@@ -451,6 +469,7 @@ public class Authentication implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getTokenDetails",
|
"getTokenDetails",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -462,6 +481,7 @@ public class Authentication implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getTokenDetails",
|
"getTokenDetails",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -471,6 +491,7 @@ public class Authentication implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getTokenDetails",
|
"getTokenDetails",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -480,6 +501,7 @@ public class Authentication implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getTokenDetails",
|
"getTokenDetails",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -573,7 +595,9 @@ public class Authentication implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get User Sign In Data
|
* Get User Sign In Data
|
||||||
* Sign in user with username and password and return user data with Plex authentication token
|
*
|
||||||
|
* <p>Sign in user with username and password and return user data with Plex authentication token
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public PostUsersSignInDataRequestBuilder postUsersSignInData() {
|
public PostUsersSignInDataRequestBuilder postUsersSignInData() {
|
||||||
@@ -582,7 +606,9 @@ public class Authentication implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get User Sign In Data
|
* Get User Sign In Data
|
||||||
* Sign in user with username and password and return user data with Plex authentication token
|
*
|
||||||
|
* <p>Sign in user with username and password and return user data with Plex authentication token
|
||||||
|
*
|
||||||
* @param request The request object containing all of the parameters for the API call.
|
* @param request The request object containing all of the parameters for the API call.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
@@ -594,7 +620,9 @@ public class Authentication implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get User Sign In Data
|
* Get User Sign In Data
|
||||||
* Sign in user with username and password and return user data with Plex authentication token
|
*
|
||||||
|
* <p>Sign in user with username and password and return user data with Plex authentication token
|
||||||
|
*
|
||||||
* @param request The request object containing all of the parameters for the API call.
|
* @param request The request object containing all of the parameters for the API call.
|
||||||
* @param serverURL Overrides the server URL.
|
* @param serverURL Overrides the server URL.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
@@ -603,9 +631,11 @@ public class Authentication implements
|
|||||||
public PostUsersSignInDataResponse postUsersSignInData(
|
public PostUsersSignInDataResponse postUsersSignInData(
|
||||||
PostUsersSignInDataRequest request,
|
PostUsersSignInDataRequest request,
|
||||||
Optional<String> serverURL) throws Exception {
|
Optional<String> serverURL) throws Exception {
|
||||||
String _baseUrl = Utils.templateUrl(POST_USERS_SIGN_IN_DATA_SERVERS[0], new HashMap<String, String>());
|
final String _baseUrl;
|
||||||
if (serverURL.isPresent() && !serverURL.get().isBlank()) {
|
if (serverURL.isPresent() && !serverURL.get().isBlank()) {
|
||||||
_baseUrl = serverURL.get();
|
_baseUrl = serverURL.get();
|
||||||
|
} else {
|
||||||
|
_baseUrl = Utils.templateUrl(POST_USERS_SIGN_IN_DATA_SERVERS[0], new HashMap<String, String>());
|
||||||
}
|
}
|
||||||
String _url = Utils.generateURL(
|
String _url = Utils.generateURL(
|
||||||
_baseUrl,
|
_baseUrl,
|
||||||
@@ -632,6 +662,7 @@ public class Authentication implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"post-users-sign-in-data",
|
"post-users-sign-in-data",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -643,6 +674,7 @@ public class Authentication implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"post-users-sign-in-data",
|
"post-users-sign-in-data",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -652,6 +684,7 @@ public class Authentication implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"post-users-sign-in-data",
|
"post-users-sign-in-data",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -661,6 +694,7 @@ public class Authentication implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"post-users-sign-in-data",
|
"post-users-sign-in-data",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package dev.plexapi.sdk;
|
package dev.plexapi.sdk;
|
||||||
|
|
||||||
import com.fasterxml.jackson.core.type.TypeReference;
|
import com.fasterxml.jackson.core.type.TypeReference;
|
||||||
@@ -44,11 +43,10 @@ import java.lang.String;
|
|||||||
import java.net.http.HttpRequest;
|
import java.net.http.HttpRequest;
|
||||||
import java.net.http.HttpResponse;
|
import java.net.http.HttpResponse;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Butler is the task manager of the Plex Media Server Ecosystem.
|
* Butler is the task manager of the Plex Media Server Ecosystem.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public class Butler implements
|
public class Butler implements
|
||||||
MethodCallGetButlerTasks,
|
MethodCallGetButlerTasks,
|
||||||
@@ -66,7 +64,9 @@ public class Butler implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Butler tasks
|
* Get Butler tasks
|
||||||
* Returns a list of butler tasks
|
*
|
||||||
|
* <p>Returns a list of butler tasks
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetButlerTasksRequestBuilder getButlerTasks() {
|
public GetButlerTasksRequestBuilder getButlerTasks() {
|
||||||
@@ -75,7 +75,9 @@ public class Butler implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Butler tasks
|
* Get Butler tasks
|
||||||
* Returns a list of butler tasks
|
*
|
||||||
|
* <p>Returns a list of butler tasks
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -99,6 +101,7 @@ public class Butler implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getButlerTasks",
|
"getButlerTasks",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -110,6 +113,7 @@ public class Butler implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getButlerTasks",
|
"getButlerTasks",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -119,6 +123,7 @@ public class Butler implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getButlerTasks",
|
"getButlerTasks",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -128,6 +133,7 @@ public class Butler implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getButlerTasks",
|
"getButlerTasks",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -221,7 +227,8 @@ public class Butler implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Start all Butler tasks
|
* Start all Butler tasks
|
||||||
* This endpoint will attempt to start all Butler tasks that are enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
|
*
|
||||||
|
* <p>This endpoint will attempt to start all Butler tasks that are enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
|
||||||
* 1. Any tasks not scheduled to run on the current day will be skipped.
|
* 1. Any tasks not scheduled to run on the current day will be skipped.
|
||||||
* 2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
|
* 2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
|
||||||
* 3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
|
* 3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
|
||||||
@@ -235,7 +242,8 @@ public class Butler implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Start all Butler tasks
|
* Start all Butler tasks
|
||||||
* This endpoint will attempt to start all Butler tasks that are enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
|
*
|
||||||
|
* <p>This endpoint will attempt to start all Butler tasks that are enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
|
||||||
* 1. Any tasks not scheduled to run on the current day will be skipped.
|
* 1. Any tasks not scheduled to run on the current day will be skipped.
|
||||||
* 2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
|
* 2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
|
||||||
* 3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
|
* 3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
|
||||||
@@ -264,6 +272,7 @@ public class Butler implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"startAllTasks",
|
"startAllTasks",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -275,6 +284,7 @@ public class Butler implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"startAllTasks",
|
"startAllTasks",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -284,6 +294,7 @@ public class Butler implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"startAllTasks",
|
"startAllTasks",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -293,6 +304,7 @@ public class Butler implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"startAllTasks",
|
"startAllTasks",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -375,7 +387,8 @@ public class Butler implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Stop all Butler tasks
|
* Stop all Butler tasks
|
||||||
* This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.
|
*
|
||||||
|
* <p>This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.
|
||||||
*
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
@@ -385,7 +398,8 @@ public class Butler implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Stop all Butler tasks
|
* Stop all Butler tasks
|
||||||
* This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.
|
*
|
||||||
|
* <p>This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.
|
||||||
*
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
@@ -410,6 +424,7 @@ public class Butler implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"stopAllTasks",
|
"stopAllTasks",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -421,6 +436,7 @@ public class Butler implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"stopAllTasks",
|
"stopAllTasks",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -430,6 +446,7 @@ public class Butler implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"stopAllTasks",
|
"stopAllTasks",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -439,6 +456,7 @@ public class Butler implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"stopAllTasks",
|
"stopAllTasks",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -521,7 +539,8 @@ public class Butler implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Start a single Butler task
|
* Start a single Butler task
|
||||||
* This endpoint will attempt to start a single Butler task that is enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
|
*
|
||||||
|
* <p>This endpoint will attempt to start a single Butler task that is enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
|
||||||
* 1. Any tasks not scheduled to run on the current day will be skipped.
|
* 1. Any tasks not scheduled to run on the current day will be skipped.
|
||||||
* 2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
|
* 2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
|
||||||
* 3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
|
* 3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
|
||||||
@@ -535,7 +554,8 @@ public class Butler implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Start a single Butler task
|
* Start a single Butler task
|
||||||
* This endpoint will attempt to start a single Butler task that is enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
|
*
|
||||||
|
* <p>This endpoint will attempt to start a single Butler task that is enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
|
||||||
* 1. Any tasks not scheduled to run on the current day will be skipped.
|
* 1. Any tasks not scheduled to run on the current day will be skipped.
|
||||||
* 2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
|
* 2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
|
||||||
* 3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
|
* 3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
|
||||||
@@ -574,6 +594,7 @@ public class Butler implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"startTask",
|
"startTask",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -585,6 +606,7 @@ public class Butler implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"startTask",
|
"startTask",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -594,6 +616,7 @@ public class Butler implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"startTask",
|
"startTask",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -603,6 +626,7 @@ public class Butler implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"startTask",
|
"startTask",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -685,7 +709,8 @@ public class Butler implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Stop a single Butler task
|
* Stop a single Butler task
|
||||||
* This endpoint will stop a currently running task by name, or remove it from the list of scheduled tasks if it exists. See the section above for a list of task names for this endpoint.
|
*
|
||||||
|
* <p>This endpoint will stop a currently running task by name, or remove it from the list of scheduled tasks if it exists. See the section above for a list of task names for this endpoint.
|
||||||
*
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
@@ -695,7 +720,8 @@ public class Butler implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Stop a single Butler task
|
* Stop a single Butler task
|
||||||
* This endpoint will stop a currently running task by name, or remove it from the list of scheduled tasks if it exists. See the section above for a list of task names for this endpoint.
|
*
|
||||||
|
* <p>This endpoint will stop a currently running task by name, or remove it from the list of scheduled tasks if it exists. See the section above for a list of task names for this endpoint.
|
||||||
*
|
*
|
||||||
* @param taskName The name of the task to be started.
|
* @param taskName The name of the task to be started.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
@@ -730,6 +756,7 @@ public class Butler implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"stopTask",
|
"stopTask",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -741,6 +768,7 @@ public class Butler implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"stopTask",
|
"stopTask",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -750,6 +778,7 @@ public class Butler implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"stopTask",
|
"stopTask",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -759,6 +788,7 @@ public class Butler implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"stopTask",
|
"stopTask",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package dev.plexapi.sdk;
|
package dev.plexapi.sdk;
|
||||||
|
|
||||||
import com.fasterxml.jackson.core.type.TypeReference;
|
import com.fasterxml.jackson.core.type.TypeReference;
|
||||||
@@ -38,11 +37,10 @@ import java.lang.String;
|
|||||||
import java.net.http.HttpRequest;
|
import java.net.http.HttpRequest;
|
||||||
import java.net.http.HttpResponse;
|
import java.net.http.HttpResponse;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Hubs are a structured two-dimensional container for media, generally represented by multiple horizontal rows.
|
* Hubs are a structured two-dimensional container for media, generally represented by multiple horizontal rows.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public class Hubs implements
|
public class Hubs implements
|
||||||
MethodCallGetGlobalHubs,
|
MethodCallGetGlobalHubs,
|
||||||
@@ -58,7 +56,9 @@ public class Hubs implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Global Hubs
|
* Get Global Hubs
|
||||||
* Get Global Hubs filtered by the parameters provided.
|
*
|
||||||
|
* <p>Get Global Hubs filtered by the parameters provided.
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetGlobalHubsRequestBuilder getGlobalHubs() {
|
public GetGlobalHubsRequestBuilder getGlobalHubs() {
|
||||||
@@ -67,7 +67,9 @@ public class Hubs implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Global Hubs
|
* Get Global Hubs
|
||||||
* Get Global Hubs filtered by the parameters provided.
|
*
|
||||||
|
* <p>Get Global Hubs filtered by the parameters provided.
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -77,7 +79,9 @@ public class Hubs implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Global Hubs
|
* Get Global Hubs
|
||||||
* Get Global Hubs filtered by the parameters provided.
|
*
|
||||||
|
* <p>Get Global Hubs filtered by the parameters provided.
|
||||||
|
*
|
||||||
* @param count The number of items to return with each hub.
|
* @param count The number of items to return with each hub.
|
||||||
* @param onlyTransient Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added).
|
* @param onlyTransient Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added).
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
@@ -117,6 +121,7 @@ public class Hubs implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getGlobalHubs",
|
"getGlobalHubs",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -128,6 +133,7 @@ public class Hubs implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getGlobalHubs",
|
"getGlobalHubs",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -137,6 +143,7 @@ public class Hubs implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getGlobalHubs",
|
"getGlobalHubs",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -146,6 +153,7 @@ public class Hubs implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getGlobalHubs",
|
"getGlobalHubs",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -239,7 +247,8 @@ public class Hubs implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Recently Added
|
* Get Recently Added
|
||||||
* This endpoint will return the recently added content.
|
*
|
||||||
|
* <p>This endpoint will return the recently added content.
|
||||||
*
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
@@ -249,7 +258,8 @@ public class Hubs implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Recently Added
|
* Get Recently Added
|
||||||
* This endpoint will return the recently added content.
|
*
|
||||||
|
* <p>This endpoint will return the recently added content.
|
||||||
*
|
*
|
||||||
* @param request The request object containing all of the parameters for the API call.
|
* @param request The request object containing all of the parameters for the API call.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
@@ -281,6 +291,7 @@ public class Hubs implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-recently-added",
|
"get-recently-added",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -292,6 +303,7 @@ public class Hubs implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-recently-added",
|
"get-recently-added",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -301,6 +313,7 @@ public class Hubs implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-recently-added",
|
"get-recently-added",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -310,6 +323,7 @@ public class Hubs implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-recently-added",
|
"get-recently-added",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -371,7 +385,8 @@ public class Hubs implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get library specific hubs
|
* Get library specific hubs
|
||||||
* This endpoint will return a list of library specific hubs
|
*
|
||||||
|
* <p>This endpoint will return a list of library specific hubs
|
||||||
*
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
@@ -381,7 +396,8 @@ public class Hubs implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get library specific hubs
|
* Get library specific hubs
|
||||||
* This endpoint will return a list of library specific hubs
|
*
|
||||||
|
* <p>This endpoint will return a list of library specific hubs
|
||||||
*
|
*
|
||||||
* @param sectionId the Id of the library to query
|
* @param sectionId the Id of the library to query
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
@@ -394,7 +410,8 @@ public class Hubs implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get library specific hubs
|
* Get library specific hubs
|
||||||
* This endpoint will return a list of library specific hubs
|
*
|
||||||
|
* <p>This endpoint will return a list of library specific hubs
|
||||||
*
|
*
|
||||||
* @param sectionId the Id of the library to query
|
* @param sectionId the Id of the library to query
|
||||||
* @param count The number of items to return with each hub.
|
* @param count The number of items to return with each hub.
|
||||||
@@ -440,6 +457,7 @@ public class Hubs implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getLibraryHubs",
|
"getLibraryHubs",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -451,6 +469,7 @@ public class Hubs implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getLibraryHubs",
|
"getLibraryHubs",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -460,6 +479,7 @@ public class Hubs implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getLibraryHubs",
|
"getLibraryHubs",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -469,6 +489,7 @@ public class Hubs implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getLibraryHubs",
|
"getLibraryHubs",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -1,7 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package dev.plexapi.sdk;
|
package dev.plexapi.sdk;
|
||||||
|
|
||||||
import com.fasterxml.jackson.core.type.TypeReference;
|
import com.fasterxml.jackson.core.type.TypeReference;
|
||||||
@@ -36,11 +35,10 @@ import java.lang.String;
|
|||||||
import java.net.http.HttpRequest;
|
import java.net.http.HttpRequest;
|
||||||
import java.net.http.HttpResponse;
|
import java.net.http.HttpResponse;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Submit logs to the Log Handler for Plex Media Server
|
* Submit logs to the Log Handler for Plex Media Server
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public class Log implements
|
public class Log implements
|
||||||
MethodCallLogLine,
|
MethodCallLogLine,
|
||||||
@@ -56,7 +54,8 @@ public class Log implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Logging a single line message.
|
* Logging a single line message.
|
||||||
* This endpoint will write a single-line log message, including a level and source to the main Plex Media Server log.
|
*
|
||||||
|
* <p>This endpoint will write a single-line log message, including a level and source to the main Plex Media Server log.
|
||||||
*
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
@@ -66,15 +65,16 @@ public class Log implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Logging a single line message.
|
* Logging a single line message.
|
||||||
* This endpoint will write a single-line log message, including a level and source to the main Plex Media Server log.
|
*
|
||||||
|
* <p>This endpoint will write a single-line log message, including a level and source to the main Plex Media Server log.
|
||||||
*
|
*
|
||||||
* @param level An integer log level to write to the PMS log with.
|
* @param level An integer log level to write to the PMS log with.
|
||||||
0: Error
|
* 0: Error
|
||||||
1: Warning
|
* 1: Warning
|
||||||
2: Info
|
* 2: Info
|
||||||
3: Debug
|
* 3: Debug
|
||||||
4: Verbose
|
* 4: Verbose
|
||||||
|
*
|
||||||
* @param message The text of the message to write to the log.
|
* @param message The text of the message to write to the log.
|
||||||
* @param source a string indicating the source of the message.
|
* @param source a string indicating the source of the message.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
@@ -116,6 +116,7 @@ public class Log implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"logLine",
|
"logLine",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -127,6 +128,7 @@ public class Log implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"logLine",
|
"logLine",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -136,6 +138,7 @@ public class Log implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"logLine",
|
"logLine",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -145,6 +148,7 @@ public class Log implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"logLine",
|
"logLine",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -227,27 +231,28 @@ public class Log implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Logging a multi-line message
|
* Logging a multi-line message
|
||||||
* This endpoint allows for the batch addition of log entries to the main Plex Media Server log.
|
*
|
||||||
|
* <p>This endpoint allows for the batch addition of log entries to the main Plex Media Server log.
|
||||||
* It accepts a text/plain request body, where each line represents a distinct log entry.
|
* It accepts a text/plain request body, where each line represents a distinct log entry.
|
||||||
* Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'.
|
* Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'.
|
||||||
*
|
*
|
||||||
* Log entries are separated by a newline character (`\n`).
|
* <p>Log entries are separated by a newline character (`\n`).
|
||||||
* Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters.
|
* Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters.
|
||||||
* This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests.
|
* This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests.
|
||||||
*
|
*
|
||||||
* The 'level' parameter specifies the log entry's severity or importance, with the following integer values:
|
* <p>The 'level' parameter specifies the log entry's severity or importance, with the following integer values:
|
||||||
* - `0`: Error - Critical issues that require immediate attention.
|
* - `0`: Error - Critical issues that require immediate attention.
|
||||||
* - `1`: Warning - Important events that are not critical but may indicate potential issues.
|
* - `1`: Warning - Important events that are not critical but may indicate potential issues.
|
||||||
* - `2`: Info - General informational messages about system operation.
|
* - `2`: Info - General informational messages about system operation.
|
||||||
* - `3`: Debug - Detailed information useful for debugging purposes.
|
* - `3`: Debug - Detailed information useful for debugging purposes.
|
||||||
* - `4`: Verbose - Highly detailed diagnostic information for in-depth analysis.
|
* - `4`: Verbose - Highly detailed diagnostic information for in-depth analysis.
|
||||||
*
|
*
|
||||||
* The 'message' parameter contains the log text, and 'source' identifies the log message's origin (e.g., an application name or module).
|
* <p>The 'message' parameter contains the log text, and 'source' identifies the log message's origin (e.g., an application name or module).
|
||||||
*
|
*
|
||||||
* Example of a single log entry format:
|
* <p>Example of a single log entry format:
|
||||||
* `level=4&message=Sample%20log%20entry&source=applicationName`
|
* `level=4&message=Sample%20log%20entry&source=applicationName`
|
||||||
*
|
*
|
||||||
* Ensure each parameter is properly URL-encoded to avoid interpretation issues.
|
* <p>Ensure each parameter is properly URL-encoded to avoid interpretation issues.
|
||||||
*
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
@@ -257,27 +262,28 @@ public class Log implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Logging a multi-line message
|
* Logging a multi-line message
|
||||||
* This endpoint allows for the batch addition of log entries to the main Plex Media Server log.
|
*
|
||||||
|
* <p>This endpoint allows for the batch addition of log entries to the main Plex Media Server log.
|
||||||
* It accepts a text/plain request body, where each line represents a distinct log entry.
|
* It accepts a text/plain request body, where each line represents a distinct log entry.
|
||||||
* Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'.
|
* Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'.
|
||||||
*
|
*
|
||||||
* Log entries are separated by a newline character (`\n`).
|
* <p>Log entries are separated by a newline character (`\n`).
|
||||||
* Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters.
|
* Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters.
|
||||||
* This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests.
|
* This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests.
|
||||||
*
|
*
|
||||||
* The 'level' parameter specifies the log entry's severity or importance, with the following integer values:
|
* <p>The 'level' parameter specifies the log entry's severity or importance, with the following integer values:
|
||||||
* - `0`: Error - Critical issues that require immediate attention.
|
* - `0`: Error - Critical issues that require immediate attention.
|
||||||
* - `1`: Warning - Important events that are not critical but may indicate potential issues.
|
* - `1`: Warning - Important events that are not critical but may indicate potential issues.
|
||||||
* - `2`: Info - General informational messages about system operation.
|
* - `2`: Info - General informational messages about system operation.
|
||||||
* - `3`: Debug - Detailed information useful for debugging purposes.
|
* - `3`: Debug - Detailed information useful for debugging purposes.
|
||||||
* - `4`: Verbose - Highly detailed diagnostic information for in-depth analysis.
|
* - `4`: Verbose - Highly detailed diagnostic information for in-depth analysis.
|
||||||
*
|
*
|
||||||
* The 'message' parameter contains the log text, and 'source' identifies the log message's origin (e.g., an application name or module).
|
* <p>The 'message' parameter contains the log text, and 'source' identifies the log message's origin (e.g., an application name or module).
|
||||||
*
|
*
|
||||||
* Example of a single log entry format:
|
* <p>Example of a single log entry format:
|
||||||
* `level=4&message=Sample%20log%20entry&source=applicationName`
|
* `level=4&message=Sample%20log%20entry&source=applicationName`
|
||||||
*
|
*
|
||||||
* Ensure each parameter is properly URL-encoded to avoid interpretation issues.
|
* <p>Ensure each parameter is properly URL-encoded to avoid interpretation issues.
|
||||||
*
|
*
|
||||||
* @param request The request object containing all of the parameters for the API call.
|
* @param request The request object containing all of the parameters for the API call.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
@@ -317,6 +323,7 @@ public class Log implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"logMultiLine",
|
"logMultiLine",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -328,6 +335,7 @@ public class Log implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"logMultiLine",
|
"logMultiLine",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -337,6 +345,7 @@ public class Log implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"logMultiLine",
|
"logMultiLine",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -346,6 +355,7 @@ public class Log implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"logMultiLine",
|
"logMultiLine",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -428,7 +438,8 @@ public class Log implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Enabling Papertrail
|
* Enabling Papertrail
|
||||||
* This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail networked logging site for a period of time.
|
*
|
||||||
|
* <p>This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail networked logging site for a period of time.
|
||||||
*
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
@@ -438,7 +449,8 @@ public class Log implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Enabling Papertrail
|
* Enabling Papertrail
|
||||||
* This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail networked logging site for a period of time.
|
*
|
||||||
|
* <p>This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail networked logging site for a period of time.
|
||||||
*
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
@@ -463,6 +475,7 @@ public class Log implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"enablePaperTrail",
|
"enablePaperTrail",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -474,6 +487,7 @@ public class Log implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"enablePaperTrail",
|
"enablePaperTrail",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -483,6 +497,7 @@ public class Log implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"enablePaperTrail",
|
"enablePaperTrail",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -492,6 +507,7 @@ public class Log implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"enablePaperTrail",
|
"enablePaperTrail",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package dev.plexapi.sdk;
|
package dev.plexapi.sdk;
|
||||||
|
|
||||||
import com.fasterxml.jackson.core.type.TypeReference;
|
import com.fasterxml.jackson.core.type.TypeReference;
|
||||||
@@ -44,11 +43,10 @@ import java.lang.String;
|
|||||||
import java.net.http.HttpRequest;
|
import java.net.http.HttpRequest;
|
||||||
import java.net.http.HttpResponse;
|
import java.net.http.HttpResponse;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls interacting with Plex Media Server Media
|
* API Calls interacting with Plex Media Server Media
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public class Media implements
|
public class Media implements
|
||||||
MethodCallMarkPlayed,
|
MethodCallMarkPlayed,
|
||||||
@@ -66,7 +64,9 @@ public class Media implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Mark Media Played
|
* Mark Media Played
|
||||||
* This will mark the provided media key as Played.
|
*
|
||||||
|
* <p>This will mark the provided media key as Played.
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public MarkPlayedRequestBuilder markPlayed() {
|
public MarkPlayedRequestBuilder markPlayed() {
|
||||||
@@ -75,7 +75,9 @@ public class Media implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Mark Media Played
|
* Mark Media Played
|
||||||
* This will mark the provided media key as Played.
|
*
|
||||||
|
* <p>This will mark the provided media key as Played.
|
||||||
|
*
|
||||||
* @param key The media key to mark as played
|
* @param key The media key to mark as played
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
@@ -112,6 +114,7 @@ public class Media implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"markPlayed",
|
"markPlayed",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -123,6 +126,7 @@ public class Media implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"markPlayed",
|
"markPlayed",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -132,6 +136,7 @@ public class Media implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"markPlayed",
|
"markPlayed",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -141,6 +146,7 @@ public class Media implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"markPlayed",
|
"markPlayed",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -223,7 +229,9 @@ public class Media implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Mark Media Unplayed
|
* Mark Media Unplayed
|
||||||
* This will mark the provided media key as Unplayed.
|
*
|
||||||
|
* <p>This will mark the provided media key as Unplayed.
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public MarkUnplayedRequestBuilder markUnplayed() {
|
public MarkUnplayedRequestBuilder markUnplayed() {
|
||||||
@@ -232,7 +240,9 @@ public class Media implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Mark Media Unplayed
|
* Mark Media Unplayed
|
||||||
* This will mark the provided media key as Unplayed.
|
*
|
||||||
|
* <p>This will mark the provided media key as Unplayed.
|
||||||
|
*
|
||||||
* @param key The media key to mark as Unplayed
|
* @param key The media key to mark as Unplayed
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
@@ -269,6 +279,7 @@ public class Media implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"markUnplayed",
|
"markUnplayed",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -280,6 +291,7 @@ public class Media implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"markUnplayed",
|
"markUnplayed",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -289,6 +301,7 @@ public class Media implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"markUnplayed",
|
"markUnplayed",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -298,6 +311,7 @@ public class Media implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"markUnplayed",
|
"markUnplayed",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -380,7 +394,8 @@ public class Media implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update Media Play Progress
|
* Update Media Play Progress
|
||||||
* This API command can be used to update the play progress of a media item.
|
*
|
||||||
|
* <p>This API command can be used to update the play progress of a media item.
|
||||||
*
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
@@ -390,7 +405,8 @@ public class Media implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update Media Play Progress
|
* Update Media Play Progress
|
||||||
* This API command can be used to update the play progress of a media item.
|
*
|
||||||
|
* <p>This API command can be used to update the play progress of a media item.
|
||||||
*
|
*
|
||||||
* @param key the media key
|
* @param key the media key
|
||||||
* @param time The time, in milliseconds, used to set the media playback progress.
|
* @param time The time, in milliseconds, used to set the media playback progress.
|
||||||
@@ -434,6 +450,7 @@ public class Media implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"updatePlayProgress",
|
"updatePlayProgress",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -445,6 +462,7 @@ public class Media implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"updatePlayProgress",
|
"updatePlayProgress",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -454,6 +472,7 @@ public class Media implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"updatePlayProgress",
|
"updatePlayProgress",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -463,6 +482,7 @@ public class Media implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"updatePlayProgress",
|
"updatePlayProgress",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -545,7 +565,9 @@ public class Media implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Banner Image
|
* Get Banner Image
|
||||||
* Gets the banner image of the media item
|
*
|
||||||
|
* <p>Gets the banner image of the media item
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetBannerImageRequestBuilder getBannerImage() {
|
public GetBannerImageRequestBuilder getBannerImage() {
|
||||||
@@ -554,7 +576,9 @@ public class Media implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Banner Image
|
* Get Banner Image
|
||||||
* Gets the banner image of the media item
|
*
|
||||||
|
* <p>Gets the banner image of the media item
|
||||||
|
*
|
||||||
* @param request The request object containing all of the parameters for the API call.
|
* @param request The request object containing all of the parameters for the API call.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
@@ -588,6 +612,7 @@ public class Media implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-banner-image",
|
"get-banner-image",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -599,6 +624,7 @@ public class Media implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-banner-image",
|
"get-banner-image",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -608,6 +634,7 @@ public class Media implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-banner-image",
|
"get-banner-image",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -617,6 +644,7 @@ public class Media implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-banner-image",
|
"get-banner-image",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -710,7 +738,9 @@ public class Media implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Thumb Image
|
* Get Thumb Image
|
||||||
* Gets the thumbnail image of the media item
|
*
|
||||||
|
* <p>Gets the thumbnail image of the media item
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetThumbImageRequestBuilder getThumbImage() {
|
public GetThumbImageRequestBuilder getThumbImage() {
|
||||||
@@ -719,7 +749,9 @@ public class Media implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Thumb Image
|
* Get Thumb Image
|
||||||
* Gets the thumbnail image of the media item
|
*
|
||||||
|
* <p>Gets the thumbnail image of the media item
|
||||||
|
*
|
||||||
* @param request The request object containing all of the parameters for the API call.
|
* @param request The request object containing all of the parameters for the API call.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
@@ -753,6 +785,7 @@ public class Media implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-thumb-image",
|
"get-thumb-image",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -764,6 +797,7 @@ public class Media implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-thumb-image",
|
"get-thumb-image",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -773,6 +807,7 @@ public class Media implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-thumb-image",
|
"get-thumb-image",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -782,6 +817,7 @@ public class Media implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-thumb-image",
|
"get-thumb-image",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package dev.plexapi.sdk;
|
package dev.plexapi.sdk;
|
||||||
|
|
||||||
import com.fasterxml.jackson.core.type.TypeReference;
|
import com.fasterxml.jackson.core.type.TypeReference;
|
||||||
@@ -74,14 +73,13 @@ import java.lang.String;
|
|||||||
import java.net.http.HttpRequest;
|
import java.net.http.HttpRequest;
|
||||||
import java.net.http.HttpResponse;
|
import java.net.http.HttpResponse;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Playlists are ordered collections of media. They can be dumb (just a list of media) or smart (based on a media query, such as "all albums from 2017").
|
* Playlists are ordered collections of media. They can be dumb (just a list of media) or smart (based on a media query, such as "all albums from 2017").
|
||||||
* They can be organized in (optionally nesting) folders.
|
* They can be organized in (optionally nesting) folders.
|
||||||
* Retrieving a playlist, or its items, will trigger a refresh of its metadata.
|
* Retrieving a playlist, or its items, will trigger a refresh of its metadata.
|
||||||
* This may cause the duration and number of items to change.
|
* This may cause the duration and number of items to change.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public class Playlists implements
|
public class Playlists implements
|
||||||
MethodCallCreatePlaylist,
|
MethodCallCreatePlaylist,
|
||||||
@@ -103,7 +101,8 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a Playlist
|
* Create a Playlist
|
||||||
* Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass:
|
*
|
||||||
|
* <p>Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass:
|
||||||
* - `uri` - The content URI for what we're playing (e.g. `server://1234/com.plexapp.plugins.library/library/metadata/1`).
|
* - `uri` - The content URI for what we're playing (e.g. `server://1234/com.plexapp.plugins.library/library/metadata/1`).
|
||||||
* - `playQueueID` - To create a playlist from an existing play queue.
|
* - `playQueueID` - To create a playlist from an existing play queue.
|
||||||
*
|
*
|
||||||
@@ -115,7 +114,8 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a Playlist
|
* Create a Playlist
|
||||||
* Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass:
|
*
|
||||||
|
* <p>Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass:
|
||||||
* - `uri` - The content URI for what we're playing (e.g. `server://1234/com.plexapp.plugins.library/library/metadata/1`).
|
* - `uri` - The content URI for what we're playing (e.g. `server://1234/com.plexapp.plugins.library/library/metadata/1`).
|
||||||
* - `playQueueID` - To create a playlist from an existing play queue.
|
* - `playQueueID` - To create a playlist from an existing play queue.
|
||||||
*
|
*
|
||||||
@@ -149,6 +149,7 @@ public class Playlists implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"createPlaylist",
|
"createPlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -160,6 +161,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"createPlaylist",
|
"createPlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -169,6 +171,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"createPlaylist",
|
"createPlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -178,6 +181,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"createPlaylist",
|
"createPlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -271,7 +275,9 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get All Playlists
|
* Get All Playlists
|
||||||
* Get All Playlists given the specified filters.
|
*
|
||||||
|
* <p>Get All Playlists given the specified filters.
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetPlaylistsRequestBuilder getPlaylists() {
|
public GetPlaylistsRequestBuilder getPlaylists() {
|
||||||
@@ -280,7 +286,9 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get All Playlists
|
* Get All Playlists
|
||||||
* Get All Playlists given the specified filters.
|
*
|
||||||
|
* <p>Get All Playlists given the specified filters.
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -290,7 +298,9 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get All Playlists
|
* Get All Playlists
|
||||||
* Get All Playlists given the specified filters.
|
*
|
||||||
|
* <p>Get All Playlists given the specified filters.
|
||||||
|
*
|
||||||
* @param playlistType limit to a type of playlist.
|
* @param playlistType limit to a type of playlist.
|
||||||
* @param smart type of playlists to return (default is all).
|
* @param smart type of playlists to return (default is all).
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
@@ -330,6 +340,7 @@ public class Playlists implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getPlaylists",
|
"getPlaylists",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -341,6 +352,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getPlaylists",
|
"getPlaylists",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -350,6 +362,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getPlaylists",
|
"getPlaylists",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -359,6 +372,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getPlaylists",
|
"getPlaylists",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -452,7 +466,8 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve Playlist
|
* Retrieve Playlist
|
||||||
* Gets detailed metadata for a playlist. A playlist for many purposes (rating, editing metadata, tagging), can be treated like a regular metadata item:
|
*
|
||||||
|
* <p>Gets detailed metadata for a playlist. A playlist for many purposes (rating, editing metadata, tagging), can be treated like a regular metadata item:
|
||||||
* Smart playlist details contain the `content` attribute. This is the content URI for the generator. This can then be parsed by a client to provide smart playlist editing.
|
* Smart playlist details contain the `content` attribute. This is the content URI for the generator. This can then be parsed by a client to provide smart playlist editing.
|
||||||
*
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
@@ -463,7 +478,8 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve Playlist
|
* Retrieve Playlist
|
||||||
* Gets detailed metadata for a playlist. A playlist for many purposes (rating, editing metadata, tagging), can be treated like a regular metadata item:
|
*
|
||||||
|
* <p>Gets detailed metadata for a playlist. A playlist for many purposes (rating, editing metadata, tagging), can be treated like a regular metadata item:
|
||||||
* Smart playlist details contain the `content` attribute. This is the content URI for the generator. This can then be parsed by a client to provide smart playlist editing.
|
* Smart playlist details contain the `content` attribute. This is the content URI for the generator. This can then be parsed by a client to provide smart playlist editing.
|
||||||
*
|
*
|
||||||
* @param playlistID the ID of the playlist
|
* @param playlistID the ID of the playlist
|
||||||
@@ -499,6 +515,7 @@ public class Playlists implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getPlaylist",
|
"getPlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -510,6 +527,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getPlaylist",
|
"getPlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -519,6 +537,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getPlaylist",
|
"getPlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -528,6 +547,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getPlaylist",
|
"getPlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -621,7 +641,8 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Deletes a Playlist
|
* Deletes a Playlist
|
||||||
* This endpoint will delete a playlist
|
*
|
||||||
|
* <p>This endpoint will delete a playlist
|
||||||
*
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
@@ -631,7 +652,8 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Deletes a Playlist
|
* Deletes a Playlist
|
||||||
* This endpoint will delete a playlist
|
*
|
||||||
|
* <p>This endpoint will delete a playlist
|
||||||
*
|
*
|
||||||
* @param playlistID the ID of the playlist
|
* @param playlistID the ID of the playlist
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
@@ -666,6 +688,7 @@ public class Playlists implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"deletePlaylist",
|
"deletePlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -677,6 +700,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"deletePlaylist",
|
"deletePlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -686,6 +710,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"deletePlaylist",
|
"deletePlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -695,6 +720,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"deletePlaylist",
|
"deletePlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -777,7 +803,8 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update a Playlist
|
* Update a Playlist
|
||||||
* From PMS version 1.9.1 clients can also edit playlist metadata using this endpoint as they would via `PUT /library/metadata/{playlistID}`
|
*
|
||||||
|
* <p>From PMS version 1.9.1 clients can also edit playlist metadata using this endpoint as they would via `PUT /library/metadata/{playlistID}`
|
||||||
*
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
@@ -787,7 +814,8 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update a Playlist
|
* Update a Playlist
|
||||||
* From PMS version 1.9.1 clients can also edit playlist metadata using this endpoint as they would via `PUT /library/metadata/{playlistID}`
|
*
|
||||||
|
* <p>From PMS version 1.9.1 clients can also edit playlist metadata using this endpoint as they would via `PUT /library/metadata/{playlistID}`
|
||||||
*
|
*
|
||||||
* @param playlistID the ID of the playlist
|
* @param playlistID the ID of the playlist
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
@@ -800,7 +828,8 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update a Playlist
|
* Update a Playlist
|
||||||
* From PMS version 1.9.1 clients can also edit playlist metadata using this endpoint as they would via `PUT /library/metadata/{playlistID}`
|
*
|
||||||
|
* <p>From PMS version 1.9.1 clients can also edit playlist metadata using this endpoint as they would via `PUT /library/metadata/{playlistID}`
|
||||||
*
|
*
|
||||||
* @param playlistID the ID of the playlist
|
* @param playlistID the ID of the playlist
|
||||||
* @param title name of the playlist
|
* @param title name of the playlist
|
||||||
@@ -846,6 +875,7 @@ public class Playlists implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"updatePlaylist",
|
"updatePlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -857,6 +887,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"updatePlaylist",
|
"updatePlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -866,6 +897,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"updatePlaylist",
|
"updatePlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -875,6 +907,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"updatePlaylist",
|
"updatePlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -957,7 +990,8 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve Playlist Contents
|
* Retrieve Playlist Contents
|
||||||
* Gets the contents of a playlist. Should be paged by clients via standard mechanisms.
|
*
|
||||||
|
* <p>Gets the contents of a playlist. Should be paged by clients via standard mechanisms.
|
||||||
* By default leaves are returned (e.g. episodes, movies). In order to return other types you can use the `type` parameter.
|
* By default leaves are returned (e.g. episodes, movies). In order to return other types you can use the `type` parameter.
|
||||||
* For example, you could use this to display a list of recently added albums vis a smart playlist.
|
* For example, you could use this to display a list of recently added albums vis a smart playlist.
|
||||||
* Note that for dumb playlists, items have a `playlistItemID` attribute which is used for deleting or moving items.
|
* Note that for dumb playlists, items have a `playlistItemID` attribute which is used for deleting or moving items.
|
||||||
@@ -970,19 +1004,20 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve Playlist Contents
|
* Retrieve Playlist Contents
|
||||||
* Gets the contents of a playlist. Should be paged by clients via standard mechanisms.
|
*
|
||||||
|
* <p>Gets the contents of a playlist. Should be paged by clients via standard mechanisms.
|
||||||
* By default leaves are returned (e.g. episodes, movies). In order to return other types you can use the `type` parameter.
|
* By default leaves are returned (e.g. episodes, movies). In order to return other types you can use the `type` parameter.
|
||||||
* For example, you could use this to display a list of recently added albums vis a smart playlist.
|
* For example, you could use this to display a list of recently added albums vis a smart playlist.
|
||||||
* Note that for dumb playlists, items have a `playlistItemID` attribute which is used for deleting or moving items.
|
* Note that for dumb playlists, items have a `playlistItemID` attribute which is used for deleting or moving items.
|
||||||
*
|
*
|
||||||
* @param playlistID the ID of the playlist
|
* @param playlistID the ID of the playlist
|
||||||
* @param type The type of media to retrieve or filter by.
|
* @param type The type of media to retrieve or filter by.
|
||||||
1 = movie
|
* 1 = movie
|
||||||
2 = show
|
* 2 = show
|
||||||
3 = season
|
* 3 = season
|
||||||
4 = episode
|
* 4 = episode
|
||||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
* E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -1022,6 +1057,7 @@ public class Playlists implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getPlaylistContents",
|
"getPlaylistContents",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1033,6 +1069,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getPlaylistContents",
|
"getPlaylistContents",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1042,6 +1079,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getPlaylistContents",
|
"getPlaylistContents",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1051,6 +1089,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getPlaylistContents",
|
"getPlaylistContents",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1144,7 +1183,8 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete Playlist Contents
|
* Delete Playlist Contents
|
||||||
* Clears a playlist, only works with dumb playlists. Returns the playlist.
|
*
|
||||||
|
* <p>Clears a playlist, only works with dumb playlists. Returns the playlist.
|
||||||
*
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
@@ -1154,7 +1194,8 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete Playlist Contents
|
* Delete Playlist Contents
|
||||||
* Clears a playlist, only works with dumb playlists. Returns the playlist.
|
*
|
||||||
|
* <p>Clears a playlist, only works with dumb playlists. Returns the playlist.
|
||||||
*
|
*
|
||||||
* @param playlistID the ID of the playlist
|
* @param playlistID the ID of the playlist
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
@@ -1189,6 +1230,7 @@ public class Playlists implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"clearPlaylistContents",
|
"clearPlaylistContents",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1200,6 +1242,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"clearPlaylistContents",
|
"clearPlaylistContents",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1209,6 +1252,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"clearPlaylistContents",
|
"clearPlaylistContents",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1218,6 +1262,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"clearPlaylistContents",
|
"clearPlaylistContents",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1300,7 +1345,8 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Adding to a Playlist
|
* Adding to a Playlist
|
||||||
* Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist.
|
*
|
||||||
|
* <p>Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist.
|
||||||
* With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist.
|
* With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist.
|
||||||
*
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
@@ -1311,7 +1357,8 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Adding to a Playlist
|
* Adding to a Playlist
|
||||||
* Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist.
|
*
|
||||||
|
* <p>Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist.
|
||||||
* With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist.
|
* With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist.
|
||||||
*
|
*
|
||||||
* @param playlistID the ID of the playlist
|
* @param playlistID the ID of the playlist
|
||||||
@@ -1327,7 +1374,8 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Adding to a Playlist
|
* Adding to a Playlist
|
||||||
* Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist.
|
*
|
||||||
|
* <p>Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist.
|
||||||
* With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist.
|
* With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist.
|
||||||
*
|
*
|
||||||
* @param playlistID the ID of the playlist
|
* @param playlistID the ID of the playlist
|
||||||
@@ -1374,6 +1422,7 @@ public class Playlists implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"addPlaylistContents",
|
"addPlaylistContents",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1385,6 +1434,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"addPlaylistContents",
|
"addPlaylistContents",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1394,6 +1444,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"addPlaylistContents",
|
"addPlaylistContents",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1403,6 +1454,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"addPlaylistContents",
|
"addPlaylistContents",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1496,7 +1548,8 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Upload Playlist
|
* Upload Playlist
|
||||||
* Imports m3u playlists by passing a path on the server to scan for m3u-formatted playlist files, or a path to a single playlist file.
|
*
|
||||||
|
* <p>Imports m3u playlists by passing a path on the server to scan for m3u-formatted playlist files, or a path to a single playlist file.
|
||||||
*
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
@@ -1506,20 +1559,21 @@ public class Playlists implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Upload Playlist
|
* Upload Playlist
|
||||||
* Imports m3u playlists by passing a path on the server to scan for m3u-formatted playlist files, or a path to a single playlist file.
|
*
|
||||||
|
* <p>Imports m3u playlists by passing a path on the server to scan for m3u-formatted playlist files, or a path to a single playlist file.
|
||||||
*
|
*
|
||||||
* @param path absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server.
|
* @param path absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server.
|
||||||
If the `path` argument is a directory, that path will be scanned for playlist files to be processed.
|
* If the `path` argument is a directory, that path will be scanned for playlist files to be processed.
|
||||||
Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it.
|
* Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it.
|
||||||
The GUID of each playlist is based on the filename.
|
* The GUID of each playlist is based on the filename.
|
||||||
If the `path` argument is a file, that file will be used to create a new playlist, with the name based on the filename of the file that created it.
|
* If the `path` argument is a file, that file will be used to create a new playlist, with the name based on the filename of the file that created it.
|
||||||
The GUID of each playlist is based on the filename.
|
* The GUID of each playlist is based on the filename.
|
||||||
|
*
|
||||||
* @param force Force overwriting of duplicate playlists.
|
* @param force Force overwriting of duplicate playlists.
|
||||||
By default, a playlist file uploaded with the same path will overwrite the existing playlist.
|
* By default, a playlist file uploaded with the same path will overwrite the existing playlist.
|
||||||
The `force` argument is used to disable overwriting.
|
* The `force` argument is used to disable overwriting.
|
||||||
If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.
|
* If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.
|
||||||
|
*
|
||||||
* @param sectionID Possibly the section ID to upload the playlist to, we are not certain.
|
* @param sectionID Possibly the section ID to upload the playlist to, we are not certain.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
@@ -1560,6 +1614,7 @@ public class Playlists implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"uploadPlaylist",
|
"uploadPlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1571,6 +1626,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"uploadPlaylist",
|
"uploadPlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1580,6 +1636,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"uploadPlaylist",
|
"uploadPlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1589,6 +1646,7 @@ public class Playlists implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"uploadPlaylist",
|
"uploadPlaylist",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package dev.plexapi.sdk;
|
package dev.plexapi.sdk;
|
||||||
|
|
||||||
import com.fasterxml.jackson.core.type.TypeReference;
|
import com.fasterxml.jackson.core.type.TypeReference;
|
||||||
@@ -60,11 +59,10 @@ import java.net.http.HttpRequest;
|
|||||||
import java.net.http.HttpResponse;
|
import java.net.http.HttpResponse;
|
||||||
import java.util.HashMap;
|
import java.util.HashMap;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls that perform operations directly against https://Plex.tv
|
* API Calls that perform operations directly against https://Plex.tv
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public class Plex implements
|
public class Plex implements
|
||||||
MethodCallGetCompanionsData,
|
MethodCallGetCompanionsData,
|
||||||
@@ -126,7 +124,9 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Companions Data
|
* Get Companions Data
|
||||||
* Get Companions Data
|
*
|
||||||
|
* <p>Get Companions Data
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetCompanionsDataRequestBuilder getCompanionsData() {
|
public GetCompanionsDataRequestBuilder getCompanionsData() {
|
||||||
@@ -135,7 +135,9 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Companions Data
|
* Get Companions Data
|
||||||
* Get Companions Data
|
*
|
||||||
|
* <p>Get Companions Data
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -145,16 +147,20 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Companions Data
|
* Get Companions Data
|
||||||
* Get Companions Data
|
*
|
||||||
|
* <p>Get Companions Data
|
||||||
|
*
|
||||||
* @param serverURL Overrides the server URL.
|
* @param serverURL Overrides the server URL.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
public GetCompanionsDataResponse getCompanionsData(
|
public GetCompanionsDataResponse getCompanionsData(
|
||||||
Optional<String> serverURL) throws Exception {
|
Optional<String> serverURL) throws Exception {
|
||||||
String _baseUrl = Utils.templateUrl(GET_COMPANIONS_DATA_SERVERS[0], new HashMap<String, String>());
|
final String _baseUrl;
|
||||||
if (serverURL.isPresent() && !serverURL.get().isBlank()) {
|
if (serverURL.isPresent() && !serverURL.get().isBlank()) {
|
||||||
_baseUrl = serverURL.get();
|
_baseUrl = serverURL.get();
|
||||||
|
} else {
|
||||||
|
_baseUrl = Utils.templateUrl(GET_COMPANIONS_DATA_SERVERS[0], new HashMap<String, String>());
|
||||||
}
|
}
|
||||||
String _url = Utils.generateURL(
|
String _url = Utils.generateURL(
|
||||||
_baseUrl,
|
_baseUrl,
|
||||||
@@ -173,6 +179,7 @@ public class Plex implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getCompanionsData",
|
"getCompanionsData",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -184,6 +191,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getCompanionsData",
|
"getCompanionsData",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -193,6 +201,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getCompanionsData",
|
"getCompanionsData",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -202,6 +211,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getCompanionsData",
|
"getCompanionsData",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -295,7 +305,9 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get list of friends of the user logged in
|
* Get list of friends of the user logged in
|
||||||
* Get friends of provided auth token.
|
*
|
||||||
|
* <p>Get friends of provided auth token.
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetUserFriendsRequestBuilder getUserFriends() {
|
public GetUserFriendsRequestBuilder getUserFriends() {
|
||||||
@@ -304,7 +316,9 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get list of friends of the user logged in
|
* Get list of friends of the user logged in
|
||||||
* Get friends of provided auth token.
|
*
|
||||||
|
* <p>Get friends of provided auth token.
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -314,16 +328,20 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get list of friends of the user logged in
|
* Get list of friends of the user logged in
|
||||||
* Get friends of provided auth token.
|
*
|
||||||
|
* <p>Get friends of provided auth token.
|
||||||
|
*
|
||||||
* @param serverURL Overrides the server URL.
|
* @param serverURL Overrides the server URL.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
public GetUserFriendsResponse getUserFriends(
|
public GetUserFriendsResponse getUserFriends(
|
||||||
Optional<String> serverURL) throws Exception {
|
Optional<String> serverURL) throws Exception {
|
||||||
String _baseUrl = Utils.templateUrl(GET_USER_FRIENDS_SERVERS[0], new HashMap<String, String>());
|
final String _baseUrl;
|
||||||
if (serverURL.isPresent() && !serverURL.get().isBlank()) {
|
if (serverURL.isPresent() && !serverURL.get().isBlank()) {
|
||||||
_baseUrl = serverURL.get();
|
_baseUrl = serverURL.get();
|
||||||
|
} else {
|
||||||
|
_baseUrl = Utils.templateUrl(GET_USER_FRIENDS_SERVERS[0], new HashMap<String, String>());
|
||||||
}
|
}
|
||||||
String _url = Utils.generateURL(
|
String _url = Utils.generateURL(
|
||||||
_baseUrl,
|
_baseUrl,
|
||||||
@@ -342,6 +360,7 @@ public class Plex implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getUserFriends",
|
"getUserFriends",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -353,6 +372,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getUserFriends",
|
"getUserFriends",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -362,6 +382,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getUserFriends",
|
"getUserFriends",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -371,6 +392,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getUserFriends",
|
"getUserFriends",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -464,7 +486,9 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Geo Data
|
* Get Geo Data
|
||||||
* Returns the geolocation and locale data of the caller
|
*
|
||||||
|
* <p>Returns the geolocation and locale data of the caller
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetGeoDataRequestBuilder getGeoData() {
|
public GetGeoDataRequestBuilder getGeoData() {
|
||||||
@@ -473,7 +497,9 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Geo Data
|
* Get Geo Data
|
||||||
* Returns the geolocation and locale data of the caller
|
*
|
||||||
|
* <p>Returns the geolocation and locale data of the caller
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -483,16 +509,20 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Geo Data
|
* Get Geo Data
|
||||||
* Returns the geolocation and locale data of the caller
|
*
|
||||||
|
* <p>Returns the geolocation and locale data of the caller
|
||||||
|
*
|
||||||
* @param serverURL Overrides the server URL.
|
* @param serverURL Overrides the server URL.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
public GetGeoDataResponse getGeoData(
|
public GetGeoDataResponse getGeoData(
|
||||||
Optional<String> serverURL) throws Exception {
|
Optional<String> serverURL) throws Exception {
|
||||||
String _baseUrl = Utils.templateUrl(GET_GEO_DATA_SERVERS[0], new HashMap<String, String>());
|
final String _baseUrl;
|
||||||
if (serverURL.isPresent() && !serverURL.get().isBlank()) {
|
if (serverURL.isPresent() && !serverURL.get().isBlank()) {
|
||||||
_baseUrl = serverURL.get();
|
_baseUrl = serverURL.get();
|
||||||
|
} else {
|
||||||
|
_baseUrl = Utils.templateUrl(GET_GEO_DATA_SERVERS[0], new HashMap<String, String>());
|
||||||
}
|
}
|
||||||
String _url = Utils.generateURL(
|
String _url = Utils.generateURL(
|
||||||
_baseUrl,
|
_baseUrl,
|
||||||
@@ -508,6 +538,7 @@ public class Plex implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getGeoData",
|
"getGeoData",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -519,6 +550,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getGeoData",
|
"getGeoData",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -528,6 +560,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getGeoData",
|
"getGeoData",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -537,6 +570,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getGeoData",
|
"getGeoData",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -630,7 +664,9 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Plex Home Data
|
* Get Plex Home Data
|
||||||
* Retrieves the home data for the authenticated user, including details like home ID, name, guest access information, and subscription status.
|
*
|
||||||
|
* <p>Retrieves the home data for the authenticated user, including details like home ID, name, guest access information, and subscription status.
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetHomeDataRequestBuilder getHomeData() {
|
public GetHomeDataRequestBuilder getHomeData() {
|
||||||
@@ -639,7 +675,9 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Plex Home Data
|
* Get Plex Home Data
|
||||||
* Retrieves the home data for the authenticated user, including details like home ID, name, guest access information, and subscription status.
|
*
|
||||||
|
* <p>Retrieves the home data for the authenticated user, including details like home ID, name, guest access information, and subscription status.
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -663,6 +701,7 @@ public class Plex implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getHomeData",
|
"getHomeData",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -674,6 +713,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getHomeData",
|
"getHomeData",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -683,6 +723,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getHomeData",
|
"getHomeData",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -692,6 +733,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getHomeData",
|
"getHomeData",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -785,7 +827,9 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Server Resources
|
* Get Server Resources
|
||||||
* Get Plex server access tokens and server connections
|
*
|
||||||
|
* <p>Get Plex server access tokens and server connections
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetServerResourcesRequestBuilder getServerResources() {
|
public GetServerResourcesRequestBuilder getServerResources() {
|
||||||
@@ -794,7 +838,9 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Server Resources
|
* Get Server Resources
|
||||||
* Get Plex server access tokens and server connections
|
*
|
||||||
|
* <p>Get Plex server access tokens and server connections
|
||||||
|
*
|
||||||
* @param clientID An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
|
* @param clientID An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
@@ -806,11 +852,13 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Server Resources
|
* Get Server Resources
|
||||||
* Get Plex server access tokens and server connections
|
*
|
||||||
|
* <p>Get Plex server access tokens and server connections
|
||||||
|
*
|
||||||
* @param includeHttps Include Https entries in the results
|
* @param includeHttps Include Https entries in the results
|
||||||
* @param includeRelay Include Relay addresses in the results
|
* @param includeRelay Include Relay addresses in the results
|
||||||
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
|
* E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
|
||||||
|
*
|
||||||
* @param includeIPv6 Include IPv6 entries in the results
|
* @param includeIPv6 Include IPv6 entries in the results
|
||||||
* @param clientID An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
|
* @param clientID An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
|
||||||
* @param serverURL Overrides the server URL.
|
* @param serverURL Overrides the server URL.
|
||||||
@@ -832,9 +880,11 @@ public class Plex implements
|
|||||||
.clientID(clientID)
|
.clientID(clientID)
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
String _baseUrl = Utils.templateUrl(GET_SERVER_RESOURCES_SERVERS[0], new HashMap<String, String>());
|
final String _baseUrl;
|
||||||
if (serverURL.isPresent() && !serverURL.get().isBlank()) {
|
if (serverURL.isPresent() && !serverURL.get().isBlank()) {
|
||||||
_baseUrl = serverURL.get();
|
_baseUrl = serverURL.get();
|
||||||
|
} else {
|
||||||
|
_baseUrl = Utils.templateUrl(GET_SERVER_RESOURCES_SERVERS[0], new HashMap<String, String>());
|
||||||
}
|
}
|
||||||
String _url = Utils.generateURL(
|
String _url = Utils.generateURL(
|
||||||
_baseUrl,
|
_baseUrl,
|
||||||
@@ -859,6 +909,7 @@ public class Plex implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-server-resources",
|
"get-server-resources",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -870,6 +921,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-server-resources",
|
"get-server-resources",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -879,6 +931,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-server-resources",
|
"get-server-resources",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -888,6 +941,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-server-resources",
|
"get-server-resources",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -981,7 +1035,9 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a Pin
|
* Get a Pin
|
||||||
* Retrieve a Pin ID from Plex.tv to use for authentication flows
|
*
|
||||||
|
* <p>Retrieve a Pin ID from Plex.tv to use for authentication flows
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetPinRequestBuilder getPin() {
|
public GetPinRequestBuilder getPin() {
|
||||||
@@ -990,7 +1046,9 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a Pin
|
* Get a Pin
|
||||||
* Retrieve a Pin ID from Plex.tv to use for authentication flows
|
*
|
||||||
|
* <p>Retrieve a Pin ID from Plex.tv to use for authentication flows
|
||||||
|
*
|
||||||
* @param request The request object containing all of the parameters for the API call.
|
* @param request The request object containing all of the parameters for the API call.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
@@ -1002,7 +1060,9 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a Pin
|
* Get a Pin
|
||||||
* Retrieve a Pin ID from Plex.tv to use for authentication flows
|
*
|
||||||
|
* <p>Retrieve a Pin ID from Plex.tv to use for authentication flows
|
||||||
|
*
|
||||||
* @param request The request object containing all of the parameters for the API call.
|
* @param request The request object containing all of the parameters for the API call.
|
||||||
* @param serverURL Overrides the server URL.
|
* @param serverURL Overrides the server URL.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
@@ -1011,9 +1071,11 @@ public class Plex implements
|
|||||||
public GetPinResponse getPin(
|
public GetPinResponse getPin(
|
||||||
GetPinRequest request,
|
GetPinRequest request,
|
||||||
Optional<String> serverURL) throws Exception {
|
Optional<String> serverURL) throws Exception {
|
||||||
String _baseUrl = Utils.templateUrl(GET_PIN_SERVERS[0], new HashMap<String, String>());
|
final String _baseUrl;
|
||||||
if (serverURL.isPresent() && !serverURL.get().isBlank()) {
|
if (serverURL.isPresent() && !serverURL.get().isBlank()) {
|
||||||
_baseUrl = serverURL.get();
|
_baseUrl = serverURL.get();
|
||||||
|
} else {
|
||||||
|
_baseUrl = Utils.templateUrl(GET_PIN_SERVERS[0], new HashMap<String, String>());
|
||||||
}
|
}
|
||||||
String _url = Utils.generateURL(
|
String _url = Utils.generateURL(
|
||||||
_baseUrl,
|
_baseUrl,
|
||||||
@@ -1035,6 +1097,7 @@ public class Plex implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getPin",
|
"getPin",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1046,6 +1109,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getPin",
|
"getPin",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1055,6 +1119,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getPin",
|
"getPin",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1064,6 +1129,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getPin",
|
"getPin",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1141,7 +1207,9 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Access Token by PinId
|
* Get Access Token by PinId
|
||||||
* Retrieve an Access Token from Plex.tv after the Pin has been authenticated
|
*
|
||||||
|
* <p>Retrieve an Access Token from Plex.tv after the Pin has been authenticated
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetTokenByPinIdRequestBuilder getTokenByPinId() {
|
public GetTokenByPinIdRequestBuilder getTokenByPinId() {
|
||||||
@@ -1150,7 +1218,9 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Access Token by PinId
|
* Get Access Token by PinId
|
||||||
* Retrieve an Access Token from Plex.tv after the Pin has been authenticated
|
*
|
||||||
|
* <p>Retrieve an Access Token from Plex.tv after the Pin has been authenticated
|
||||||
|
*
|
||||||
* @param request The request object containing all of the parameters for the API call.
|
* @param request The request object containing all of the parameters for the API call.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
@@ -1162,7 +1232,9 @@ public class Plex implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Access Token by PinId
|
* Get Access Token by PinId
|
||||||
* Retrieve an Access Token from Plex.tv after the Pin has been authenticated
|
*
|
||||||
|
* <p>Retrieve an Access Token from Plex.tv after the Pin has been authenticated
|
||||||
|
*
|
||||||
* @param request The request object containing all of the parameters for the API call.
|
* @param request The request object containing all of the parameters for the API call.
|
||||||
* @param serverURL Overrides the server URL.
|
* @param serverURL Overrides the server URL.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
@@ -1171,9 +1243,11 @@ public class Plex implements
|
|||||||
public GetTokenByPinIdResponse getTokenByPinId(
|
public GetTokenByPinIdResponse getTokenByPinId(
|
||||||
GetTokenByPinIdRequest request,
|
GetTokenByPinIdRequest request,
|
||||||
Optional<String> serverURL) throws Exception {
|
Optional<String> serverURL) throws Exception {
|
||||||
String _baseUrl = Utils.templateUrl(GET_TOKEN_BY_PIN_ID_SERVERS[0], new HashMap<String, String>());
|
final String _baseUrl;
|
||||||
if (serverURL.isPresent() && !serverURL.get().isBlank()) {
|
if (serverURL.isPresent() && !serverURL.get().isBlank()) {
|
||||||
_baseUrl = serverURL.get();
|
_baseUrl = serverURL.get();
|
||||||
|
} else {
|
||||||
|
_baseUrl = Utils.templateUrl(GET_TOKEN_BY_PIN_ID_SERVERS[0], new HashMap<String, String>());
|
||||||
}
|
}
|
||||||
String _url = Utils.generateURL(
|
String _url = Utils.generateURL(
|
||||||
GetTokenByPinIdRequest.class,
|
GetTokenByPinIdRequest.class,
|
||||||
@@ -1192,6 +1266,7 @@ public class Plex implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getTokenByPinId",
|
"getTokenByPinId",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1203,6 +1278,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getTokenByPinId",
|
"getTokenByPinId",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1212,6 +1288,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getTokenByPinId",
|
"getTokenByPinId",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1221,6 +1298,7 @@ public class Plex implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getTokenByPinId",
|
"getTokenByPinId",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package dev.plexapi.sdk;
|
package dev.plexapi.sdk;
|
||||||
|
|
||||||
import com.fasterxml.jackson.annotation.JsonValue;
|
import com.fasterxml.jackson.annotation.JsonValue;
|
||||||
@@ -11,26 +10,28 @@ import dev.plexapi.sdk.utils.SpeakeasyHTTPClient;
|
|||||||
import dev.plexapi.sdk.utils.Utils;
|
import dev.plexapi.sdk.utils.Utils;
|
||||||
import java.lang.String;
|
import java.lang.String;
|
||||||
import java.util.Map;
|
import java.util.Map;
|
||||||
|
import java.util.Objects;
|
||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
import java.util.function.Consumer;
|
import java.util.function.Consumer;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
* Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
||||||
* # Plex Media Server OpenAPI Specification
|
|
||||||
*
|
*
|
||||||
* An Open Source OpenAPI Specification for Plex Media Server
|
* <p># Plex Media Server OpenAPI Specification
|
||||||
*
|
*
|
||||||
* Automation and SDKs provided by [Speakeasy](https://speakeasyapi.dev/)
|
* <p>An Open Source OpenAPI Specification for Plex Media Server
|
||||||
*
|
*
|
||||||
* ## Documentation
|
* <p>Automation and SDKs provided by [Speakeasy](https://speakeasyapi.dev/)
|
||||||
*
|
*
|
||||||
* [API Documentation](https://plexapi.dev)
|
* <p>## Documentation
|
||||||
*
|
*
|
||||||
* ## SDKs
|
* <p>[API Documentation](https://plexapi.dev)
|
||||||
*
|
*
|
||||||
* The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the [main specification Repository](https://github.com/LukeHagar/plex-api-spec).
|
* <p>## SDKs
|
||||||
*
|
*
|
||||||
* | Language | Repository | Releases | Other |
|
* <p>The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the [main specification Repository](https://github.com/LukeHagar/plex-api-spec).
|
||||||
|
*
|
||||||
|
* <p>| Language | Repository | Releases | Other |
|
||||||
* | --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
|
* | --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
|
||||||
* | Python | [GitHub](https://github.com/LukeHagar/plexpy) | [PyPI](https://pypi.org/project/plex-api-client/) | - |
|
* | Python | [GitHub](https://github.com/LukeHagar/plexpy) | [PyPI](https://pypi.org/project/plex-api-client/) | - |
|
||||||
* | JavaScript/TypeScript | [GitHub](https://github.com/LukeHagar/plexjs) | [NPM](https://www.npmjs.com/package/@lukehagar/plexjs) \ [JSR](https://jsr.io/@lukehagar/plexjs) | - |
|
* | JavaScript/TypeScript | [GitHub](https://github.com/LukeHagar/plexjs) | [NPM](https://www.npmjs.com/package/@lukehagar/plexjs) \ [JSR](https://jsr.io/@lukehagar/plexjs) | - |
|
||||||
@@ -40,7 +41,6 @@ import java.util.function.Consumer;
|
|||||||
* | PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - |
|
* | PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - |
|
||||||
* | Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - |
|
* | Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - |
|
||||||
* | C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -
|
* | C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public class PlexAPI {
|
public class PlexAPI {
|
||||||
|
|
||||||
@@ -57,19 +57,16 @@ public class PlexAPI {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Operations against the Plex Media Server System.
|
* Operations against the Plex Media Server System.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
private final Server server;
|
private final Server server;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls interacting with Plex Media Server Media
|
* API Calls interacting with Plex Media Server Media
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
private final Media media;
|
private final Media media;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls that perform operations with Plex Media Server Videos
|
* API Calls that perform operations with Plex Media Server Videos
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
private final Video video;
|
private final Video video;
|
||||||
|
|
||||||
@@ -81,49 +78,41 @@ public class PlexAPI {
|
|||||||
* - They must contain an `type` which is used by clients to distinguish the specific activity.
|
* - They must contain an `type` which is used by clients to distinguish the specific activity.
|
||||||
* - They may contain a `Context` object with attributes which associate the activity with various specific entities (items, libraries, etc.)
|
* - They may contain a `Context` object with attributes which associate the activity with various specific entities (items, libraries, etc.)
|
||||||
* - The may contain a `Response` object which attributes which represent the result of the asynchronous operation.
|
* - The may contain a `Response` object which attributes which represent the result of the asynchronous operation.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
private final Activities activities;
|
private final Activities activities;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Butler is the task manager of the Plex Media Server Ecosystem.
|
* Butler is the task manager of the Plex Media Server Ecosystem.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
private final Butler butler;
|
private final Butler butler;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls that perform operations directly against https://Plex.tv
|
* API Calls that perform operations directly against https://Plex.tv
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
private final Plex plex;
|
private final Plex plex;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Hubs are a structured two-dimensional container for media, generally represented by multiple horizontal rows.
|
* Hubs are a structured two-dimensional container for media, generally represented by multiple horizontal rows.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
private final Hubs hubs;
|
private final Hubs hubs;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls that perform search operations with Plex Media Server
|
* API Calls that perform search operations with Plex Media Server
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
private final Search search;
|
private final Search search;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls interacting with Plex Media Server Libraries
|
* API Calls interacting with Plex Media Server Libraries
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
private final Library library;
|
private final Library library;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls that perform operations with Plex Media Server Watchlists
|
* API Calls that perform operations with Plex Media Server Watchlists
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
private final Watchlist watchlist;
|
private final Watchlist watchlist;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Submit logs to the Log Handler for Plex Media Server
|
* Submit logs to the Log Handler for Plex Media Server
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
private final Log log;
|
private final Log log;
|
||||||
|
|
||||||
@@ -132,32 +121,27 @@ public class PlexAPI {
|
|||||||
* They can be organized in (optionally nesting) folders.
|
* They can be organized in (optionally nesting) folders.
|
||||||
* Retrieving a playlist, or its items, will trigger a refresh of its metadata.
|
* Retrieving a playlist, or its items, will trigger a refresh of its metadata.
|
||||||
* This may cause the duration and number of items to change.
|
* This may cause the duration and number of items to change.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
private final Playlists playlists;
|
private final Playlists playlists;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls regarding authentication for Plex Media Server
|
* API Calls regarding authentication for Plex Media Server
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
private final Authentication authentication;
|
private final Authentication authentication;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls that perform operations with Plex Media Server Statistics
|
* API Calls that perform operations with Plex Media Server Statistics
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
private final Statistics statistics;
|
private final Statistics statistics;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls that perform search operations with Plex Media Server Sessions
|
* API Calls that perform search operations with Plex Media Server Sessions
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
private final Sessions sessions;
|
private final Sessions sessions;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This describes the API for searching and applying updates to the Plex Media Server.
|
* This describes the API for searching and applying updates to the Plex Media Server.
|
||||||
* Updates to the status can be observed via the Event API.
|
* Updates to the status can be observed via the Event API.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
private final Updater updater;
|
private final Updater updater;
|
||||||
|
|
||||||
@@ -165,7 +149,6 @@ public class PlexAPI {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Operations against the Plex Media Server System.
|
* Operations against the Plex Media Server System.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public Server server() {
|
public Server server() {
|
||||||
return server;
|
return server;
|
||||||
@@ -173,7 +156,6 @@ public class PlexAPI {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls interacting with Plex Media Server Media
|
* API Calls interacting with Plex Media Server Media
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public Media media() {
|
public Media media() {
|
||||||
return media;
|
return media;
|
||||||
@@ -181,7 +163,6 @@ public class PlexAPI {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls that perform operations with Plex Media Server Videos
|
* API Calls that perform operations with Plex Media Server Videos
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public Video video() {
|
public Video video() {
|
||||||
return video;
|
return video;
|
||||||
@@ -195,7 +176,6 @@ public class PlexAPI {
|
|||||||
* - They must contain an `type` which is used by clients to distinguish the specific activity.
|
* - They must contain an `type` which is used by clients to distinguish the specific activity.
|
||||||
* - They may contain a `Context` object with attributes which associate the activity with various specific entities (items, libraries, etc.)
|
* - They may contain a `Context` object with attributes which associate the activity with various specific entities (items, libraries, etc.)
|
||||||
* - The may contain a `Response` object which attributes which represent the result of the asynchronous operation.
|
* - The may contain a `Response` object which attributes which represent the result of the asynchronous operation.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public Activities activities() {
|
public Activities activities() {
|
||||||
return activities;
|
return activities;
|
||||||
@@ -203,7 +183,6 @@ public class PlexAPI {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Butler is the task manager of the Plex Media Server Ecosystem.
|
* Butler is the task manager of the Plex Media Server Ecosystem.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public Butler butler() {
|
public Butler butler() {
|
||||||
return butler;
|
return butler;
|
||||||
@@ -211,7 +190,6 @@ public class PlexAPI {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls that perform operations directly against https://Plex.tv
|
* API Calls that perform operations directly against https://Plex.tv
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public Plex plex() {
|
public Plex plex() {
|
||||||
return plex;
|
return plex;
|
||||||
@@ -219,7 +197,6 @@ public class PlexAPI {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Hubs are a structured two-dimensional container for media, generally represented by multiple horizontal rows.
|
* Hubs are a structured two-dimensional container for media, generally represented by multiple horizontal rows.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public Hubs hubs() {
|
public Hubs hubs() {
|
||||||
return hubs;
|
return hubs;
|
||||||
@@ -227,7 +204,6 @@ public class PlexAPI {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls that perform search operations with Plex Media Server
|
* API Calls that perform search operations with Plex Media Server
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public Search search() {
|
public Search search() {
|
||||||
return search;
|
return search;
|
||||||
@@ -235,7 +211,6 @@ public class PlexAPI {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls interacting with Plex Media Server Libraries
|
* API Calls interacting with Plex Media Server Libraries
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public Library library() {
|
public Library library() {
|
||||||
return library;
|
return library;
|
||||||
@@ -243,7 +218,6 @@ public class PlexAPI {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls that perform operations with Plex Media Server Watchlists
|
* API Calls that perform operations with Plex Media Server Watchlists
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public Watchlist watchlist() {
|
public Watchlist watchlist() {
|
||||||
return watchlist;
|
return watchlist;
|
||||||
@@ -251,7 +225,6 @@ public class PlexAPI {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Submit logs to the Log Handler for Plex Media Server
|
* Submit logs to the Log Handler for Plex Media Server
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public Log log() {
|
public Log log() {
|
||||||
return log;
|
return log;
|
||||||
@@ -262,7 +235,6 @@ public class PlexAPI {
|
|||||||
* They can be organized in (optionally nesting) folders.
|
* They can be organized in (optionally nesting) folders.
|
||||||
* Retrieving a playlist, or its items, will trigger a refresh of its metadata.
|
* Retrieving a playlist, or its items, will trigger a refresh of its metadata.
|
||||||
* This may cause the duration and number of items to change.
|
* This may cause the duration and number of items to change.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public Playlists playlists() {
|
public Playlists playlists() {
|
||||||
return playlists;
|
return playlists;
|
||||||
@@ -270,7 +242,6 @@ public class PlexAPI {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls regarding authentication for Plex Media Server
|
* API Calls regarding authentication for Plex Media Server
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public Authentication authentication() {
|
public Authentication authentication() {
|
||||||
return authentication;
|
return authentication;
|
||||||
@@ -278,7 +249,6 @@ public class PlexAPI {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls that perform operations with Plex Media Server Statistics
|
* API Calls that perform operations with Plex Media Server Statistics
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public Statistics statistics() {
|
public Statistics statistics() {
|
||||||
return statistics;
|
return statistics;
|
||||||
@@ -286,7 +256,6 @@ public class PlexAPI {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls that perform search operations with Plex Media Server Sessions
|
* API Calls that perform search operations with Plex Media Server Sessions
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public Sessions sessions() {
|
public Sessions sessions() {
|
||||||
return sessions;
|
return sessions;
|
||||||
@@ -295,7 +264,6 @@ public class PlexAPI {
|
|||||||
/**
|
/**
|
||||||
* This describes the API for searching and applying updates to the Plex Media Server.
|
* This describes the API for searching and applying updates to the Plex Media Server.
|
||||||
* Updates to the status can be observed via the Event API.
|
* Updates to the status can be observed via the Event API.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public Updater updater() {
|
public Updater updater() {
|
||||||
return updater;
|
return updater;
|
||||||
@@ -342,6 +310,7 @@ public class PlexAPI {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Configures the SDK to use a custom security source.
|
* Configures the SDK to use a custom security source.
|
||||||
|
*
|
||||||
* @param securitySource The security source to use for all requests.
|
* @param securitySource The security source to use for all requests.
|
||||||
* @return The builder instance.
|
* @return The builder instance.
|
||||||
*/
|
*/
|
||||||
@@ -396,7 +365,9 @@ public class PlexAPI {
|
|||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* ServerProtocol - The protocol to use for the server connection
|
* ServerProtocol
|
||||||
|
*
|
||||||
|
* <p>The protocol to use for the server connection
|
||||||
*/
|
*/
|
||||||
public enum ServerProtocol {
|
public enum ServerProtocol {
|
||||||
HTTP("http"),
|
HTTP("http"),
|
||||||
@@ -412,6 +383,15 @@ public class PlexAPI {
|
|||||||
public String value() {
|
public String value() {
|
||||||
return value;
|
return value;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public static Optional<ServerProtocol> fromValue(String value) {
|
||||||
|
for (ServerProtocol o: ServerProtocol.values()) {
|
||||||
|
if (Objects.deepEquals(o.value, value)) {
|
||||||
|
return Optional.of(o);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return Optional.empty();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* Sets the protocol variable for url substitution.
|
* Sets the protocol variable for url substitution.
|
||||||
@@ -478,6 +458,7 @@ public class PlexAPI {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Builds a new instance of the SDK.
|
* Builds a new instance of the SDK.
|
||||||
|
*
|
||||||
* @return The SDK instance.
|
* @return The SDK instance.
|
||||||
*/
|
*/
|
||||||
public PlexAPI build() {
|
public PlexAPI build() {
|
||||||
@@ -500,6 +481,7 @@ public class PlexAPI {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a new instance of the SDK builder to configure a new instance of the SDK.
|
* Get a new instance of the SDK builder to configure a new instance of the SDK.
|
||||||
|
*
|
||||||
* @return The SDK builder instance.
|
* @return The SDK builder instance.
|
||||||
*/
|
*/
|
||||||
public static Builder builder() {
|
public static Builder builder() {
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package dev.plexapi.sdk;
|
package dev.plexapi.sdk;
|
||||||
|
|
||||||
import dev.plexapi.sdk.hooks.SDKHooks;
|
import dev.plexapi.sdk.hooks.SDKHooks;
|
||||||
@@ -43,11 +42,11 @@ class SDKConfiguration {
|
|||||||
} };
|
} };
|
||||||
private static final String LANGUAGE = "java";
|
private static final String LANGUAGE = "java";
|
||||||
public static final String OPENAPI_DOC_VERSION = "0.0.3";
|
public static final String OPENAPI_DOC_VERSION = "0.0.3";
|
||||||
public static final String SDK_VERSION = "0.12.0";
|
public static final String SDK_VERSION = "0.14.1";
|
||||||
public static final String GEN_VERSION = "2.506.0";
|
public static final String GEN_VERSION = "2.565.1";
|
||||||
private static final String BASE_PACKAGE = "dev.plexapi.sdk";
|
private static final String BASE_PACKAGE = "dev.plexapi.sdk";
|
||||||
public static final String USER_AGENT =
|
public static final String USER_AGENT =
|
||||||
String.format("speakeasy-sdk/%s %s %s %s %s",
|
String.format("speakeasy-sdk/%s %s %s %s %s",
|
||||||
LANGUAGE, SDK_VERSION, GEN_VERSION, OPENAPI_DOC_VERSION, BASE_PACKAGE);
|
LANGUAGE, SDK_VERSION, GEN_VERSION, OPENAPI_DOC_VERSION, BASE_PACKAGE);
|
||||||
|
|
||||||
private Hooks _hooks = createHooks();
|
private Hooks _hooks = createHooks();
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package dev.plexapi.sdk;
|
package dev.plexapi.sdk;
|
||||||
|
|
||||||
import com.fasterxml.jackson.core.type.TypeReference;
|
import com.fasterxml.jackson.core.type.TypeReference;
|
||||||
@@ -36,11 +35,10 @@ import java.lang.String;
|
|||||||
import java.net.http.HttpRequest;
|
import java.net.http.HttpRequest;
|
||||||
import java.net.http.HttpResponse;
|
import java.net.http.HttpResponse;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls that perform search operations with Plex Media Server
|
* API Calls that perform search operations with Plex Media Server
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public class Search implements
|
public class Search implements
|
||||||
MethodCallPerformSearch,
|
MethodCallPerformSearch,
|
||||||
@@ -56,18 +54,19 @@ public class Search implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Perform a search
|
* Perform a search
|
||||||
* This endpoint performs a search across all library sections, or a single section, and returns matches as hubs, split up by type. It performs spell checking, looks for partial matches, and orders the hubs based on quality of results. In addition, based on matches, it will return other related matches (e.g. for a genre match, it may return movies in that genre, or for an actor match, movies with that actor).
|
|
||||||
*
|
*
|
||||||
* In the response's items, the following extra attributes are returned to further describe or disambiguate the result:
|
* <p>This endpoint performs a search across all library sections, or a single section, and returns matches as hubs, split up by type. It performs spell checking, looks for partial matches, and orders the hubs based on quality of results. In addition, based on matches, it will return other related matches (e.g. for a genre match, it may return movies in that genre, or for an actor match, movies with that actor).
|
||||||
*
|
*
|
||||||
* - `reason`: The reason for the result, if not because of a direct search term match; can be either:
|
* <p>In the response's items, the following extra attributes are returned to further describe or disambiguate the result:
|
||||||
|
*
|
||||||
|
* <p>- `reason`: The reason for the result, if not because of a direct search term match; can be either:
|
||||||
* - `section`: There are multiple identical results from different sections.
|
* - `section`: There are multiple identical results from different sections.
|
||||||
* - `originalTitle`: There was a search term match from the original title field (sometimes those can be very different or in a foreign language).
|
* - `originalTitle`: There was a search term match from the original title field (sometimes those can be very different or in a foreign language).
|
||||||
* - `<hub identifier>`: If the reason for the result is due to a result in another hub, the source hub identifier is returned. For example, if the search is for "dylan" then Bob Dylan may be returned as an artist result, an a few of his albums returned as album results with a reason code of `artist` (the identifier of that particular hub). Or if the search is for "arnold", there might be movie results returned with a reason of `actor`
|
* - `<hub identifier>`: If the reason for the result is due to a result in another hub, the source hub identifier is returned. For example, if the search is for "dylan" then Bob Dylan may be returned as an artist result, an a few of his albums returned as album results with a reason code of `artist` (the identifier of that particular hub). Or if the search is for "arnold", there might be movie results returned with a reason of `actor`
|
||||||
* - `reasonTitle`: The string associated with the reason code. For a section reason, it'll be the section name; For a hub identifier, it'll be a string associated with the match (e.g. `Arnold Schwarzenegger` for movies which were returned because the search was for "arnold").
|
* - `reasonTitle`: The string associated with the reason code. For a section reason, it'll be the section name; For a hub identifier, it'll be a string associated with the match (e.g. `Arnold Schwarzenegger` for movies which were returned because the search was for "arnold").
|
||||||
* - `reasonID`: The ID of the item associated with the reason for the result. This might be a section ID, a tag ID, an artist ID, or a show ID.
|
* - `reasonID`: The ID of the item associated with the reason for the result. This might be a section ID, a tag ID, an artist ID, or a show ID.
|
||||||
*
|
*
|
||||||
* This request is intended to be very fast, and called as the user types.
|
* <p>This request is intended to be very fast, and called as the user types.
|
||||||
*
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
@@ -77,18 +76,19 @@ public class Search implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Perform a search
|
* Perform a search
|
||||||
* This endpoint performs a search across all library sections, or a single section, and returns matches as hubs, split up by type. It performs spell checking, looks for partial matches, and orders the hubs based on quality of results. In addition, based on matches, it will return other related matches (e.g. for a genre match, it may return movies in that genre, or for an actor match, movies with that actor).
|
|
||||||
*
|
*
|
||||||
* In the response's items, the following extra attributes are returned to further describe or disambiguate the result:
|
* <p>This endpoint performs a search across all library sections, or a single section, and returns matches as hubs, split up by type. It performs spell checking, looks for partial matches, and orders the hubs based on quality of results. In addition, based on matches, it will return other related matches (e.g. for a genre match, it may return movies in that genre, or for an actor match, movies with that actor).
|
||||||
*
|
*
|
||||||
* - `reason`: The reason for the result, if not because of a direct search term match; can be either:
|
* <p>In the response's items, the following extra attributes are returned to further describe or disambiguate the result:
|
||||||
|
*
|
||||||
|
* <p>- `reason`: The reason for the result, if not because of a direct search term match; can be either:
|
||||||
* - `section`: There are multiple identical results from different sections.
|
* - `section`: There are multiple identical results from different sections.
|
||||||
* - `originalTitle`: There was a search term match from the original title field (sometimes those can be very different or in a foreign language).
|
* - `originalTitle`: There was a search term match from the original title field (sometimes those can be very different or in a foreign language).
|
||||||
* - `<hub identifier>`: If the reason for the result is due to a result in another hub, the source hub identifier is returned. For example, if the search is for "dylan" then Bob Dylan may be returned as an artist result, an a few of his albums returned as album results with a reason code of `artist` (the identifier of that particular hub). Or if the search is for "arnold", there might be movie results returned with a reason of `actor`
|
* - `<hub identifier>`: If the reason for the result is due to a result in another hub, the source hub identifier is returned. For example, if the search is for "dylan" then Bob Dylan may be returned as an artist result, an a few of his albums returned as album results with a reason code of `artist` (the identifier of that particular hub). Or if the search is for "arnold", there might be movie results returned with a reason of `actor`
|
||||||
* - `reasonTitle`: The string associated with the reason code. For a section reason, it'll be the section name; For a hub identifier, it'll be a string associated with the match (e.g. `Arnold Schwarzenegger` for movies which were returned because the search was for "arnold").
|
* - `reasonTitle`: The string associated with the reason code. For a section reason, it'll be the section name; For a hub identifier, it'll be a string associated with the match (e.g. `Arnold Schwarzenegger` for movies which were returned because the search was for "arnold").
|
||||||
* - `reasonID`: The ID of the item associated with the reason for the result. This might be a section ID, a tag ID, an artist ID, or a show ID.
|
* - `reasonID`: The ID of the item associated with the reason for the result. This might be a section ID, a tag ID, an artist ID, or a show ID.
|
||||||
*
|
*
|
||||||
* This request is intended to be very fast, and called as the user types.
|
* <p>This request is intended to be very fast, and called as the user types.
|
||||||
*
|
*
|
||||||
* @param query The query term
|
* @param query The query term
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
@@ -101,18 +101,19 @@ public class Search implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Perform a search
|
* Perform a search
|
||||||
* This endpoint performs a search across all library sections, or a single section, and returns matches as hubs, split up by type. It performs spell checking, looks for partial matches, and orders the hubs based on quality of results. In addition, based on matches, it will return other related matches (e.g. for a genre match, it may return movies in that genre, or for an actor match, movies with that actor).
|
|
||||||
*
|
*
|
||||||
* In the response's items, the following extra attributes are returned to further describe or disambiguate the result:
|
* <p>This endpoint performs a search across all library sections, or a single section, and returns matches as hubs, split up by type. It performs spell checking, looks for partial matches, and orders the hubs based on quality of results. In addition, based on matches, it will return other related matches (e.g. for a genre match, it may return movies in that genre, or for an actor match, movies with that actor).
|
||||||
*
|
*
|
||||||
* - `reason`: The reason for the result, if not because of a direct search term match; can be either:
|
* <p>In the response's items, the following extra attributes are returned to further describe or disambiguate the result:
|
||||||
|
*
|
||||||
|
* <p>- `reason`: The reason for the result, if not because of a direct search term match; can be either:
|
||||||
* - `section`: There are multiple identical results from different sections.
|
* - `section`: There are multiple identical results from different sections.
|
||||||
* - `originalTitle`: There was a search term match from the original title field (sometimes those can be very different or in a foreign language).
|
* - `originalTitle`: There was a search term match from the original title field (sometimes those can be very different or in a foreign language).
|
||||||
* - `<hub identifier>`: If the reason for the result is due to a result in another hub, the source hub identifier is returned. For example, if the search is for "dylan" then Bob Dylan may be returned as an artist result, an a few of his albums returned as album results with a reason code of `artist` (the identifier of that particular hub). Or if the search is for "arnold", there might be movie results returned with a reason of `actor`
|
* - `<hub identifier>`: If the reason for the result is due to a result in another hub, the source hub identifier is returned. For example, if the search is for "dylan" then Bob Dylan may be returned as an artist result, an a few of his albums returned as album results with a reason code of `artist` (the identifier of that particular hub). Or if the search is for "arnold", there might be movie results returned with a reason of `actor`
|
||||||
* - `reasonTitle`: The string associated with the reason code. For a section reason, it'll be the section name; For a hub identifier, it'll be a string associated with the match (e.g. `Arnold Schwarzenegger` for movies which were returned because the search was for "arnold").
|
* - `reasonTitle`: The string associated with the reason code. For a section reason, it'll be the section name; For a hub identifier, it'll be a string associated with the match (e.g. `Arnold Schwarzenegger` for movies which were returned because the search was for "arnold").
|
||||||
* - `reasonID`: The ID of the item associated with the reason for the result. This might be a section ID, a tag ID, an artist ID, or a show ID.
|
* - `reasonID`: The ID of the item associated with the reason for the result. This might be a section ID, a tag ID, an artist ID, or a show ID.
|
||||||
*
|
*
|
||||||
* This request is intended to be very fast, and called as the user types.
|
* <p>This request is intended to be very fast, and called as the user types.
|
||||||
*
|
*
|
||||||
* @param query The query term
|
* @param query The query term
|
||||||
* @param sectionId This gives context to the search, and can result in re-ordering of search result hubs
|
* @param sectionId This gives context to the search, and can result in re-ordering of search result hubs
|
||||||
@@ -156,6 +157,7 @@ public class Search implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"performSearch",
|
"performSearch",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -167,6 +169,7 @@ public class Search implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"performSearch",
|
"performSearch",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -176,6 +179,7 @@ public class Search implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"performSearch",
|
"performSearch",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -185,6 +189,7 @@ public class Search implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"performSearch",
|
"performSearch",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -267,7 +272,8 @@ public class Search implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Perform a voice search
|
* Perform a voice search
|
||||||
* This endpoint performs a search specifically tailored towards voice or other imprecise input which may work badly with the substring and spell-checking heuristics used by the `/hubs/search` endpoint.
|
*
|
||||||
|
* <p>This endpoint performs a search specifically tailored towards voice or other imprecise input which may work badly with the substring and spell-checking heuristics used by the `/hubs/search` endpoint.
|
||||||
* It uses a [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) heuristic to search titles, and as such is much slower than the other search endpoint.
|
* It uses a [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) heuristic to search titles, and as such is much slower than the other search endpoint.
|
||||||
* Whenever possible, clients should limit the search to the appropriate type.
|
* Whenever possible, clients should limit the search to the appropriate type.
|
||||||
* Results, as well as their containing per-type hubs, contain a `distance` attribute which can be used to judge result quality.
|
* Results, as well as their containing per-type hubs, contain a `distance` attribute which can be used to judge result quality.
|
||||||
@@ -280,7 +286,8 @@ public class Search implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Perform a voice search
|
* Perform a voice search
|
||||||
* This endpoint performs a search specifically tailored towards voice or other imprecise input which may work badly with the substring and spell-checking heuristics used by the `/hubs/search` endpoint.
|
*
|
||||||
|
* <p>This endpoint performs a search specifically tailored towards voice or other imprecise input which may work badly with the substring and spell-checking heuristics used by the `/hubs/search` endpoint.
|
||||||
* It uses a [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) heuristic to search titles, and as such is much slower than the other search endpoint.
|
* It uses a [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) heuristic to search titles, and as such is much slower than the other search endpoint.
|
||||||
* Whenever possible, clients should limit the search to the appropriate type.
|
* Whenever possible, clients should limit the search to the appropriate type.
|
||||||
* Results, as well as their containing per-type hubs, contain a `distance` attribute which can be used to judge result quality.
|
* Results, as well as their containing per-type hubs, contain a `distance` attribute which can be used to judge result quality.
|
||||||
@@ -296,7 +303,8 @@ public class Search implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Perform a voice search
|
* Perform a voice search
|
||||||
* This endpoint performs a search specifically tailored towards voice or other imprecise input which may work badly with the substring and spell-checking heuristics used by the `/hubs/search` endpoint.
|
*
|
||||||
|
* <p>This endpoint performs a search specifically tailored towards voice or other imprecise input which may work badly with the substring and spell-checking heuristics used by the `/hubs/search` endpoint.
|
||||||
* It uses a [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) heuristic to search titles, and as such is much slower than the other search endpoint.
|
* It uses a [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) heuristic to search titles, and as such is much slower than the other search endpoint.
|
||||||
* Whenever possible, clients should limit the search to the appropriate type.
|
* Whenever possible, clients should limit the search to the appropriate type.
|
||||||
* Results, as well as their containing per-type hubs, contain a `distance` attribute which can be used to judge result quality.
|
* Results, as well as their containing per-type hubs, contain a `distance` attribute which can be used to judge result quality.
|
||||||
@@ -343,6 +351,7 @@ public class Search implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"performVoiceSearch",
|
"performVoiceSearch",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -354,6 +363,7 @@ public class Search implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"performVoiceSearch",
|
"performVoiceSearch",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -363,6 +373,7 @@ public class Search implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"performVoiceSearch",
|
"performVoiceSearch",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -372,6 +383,7 @@ public class Search implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"performVoiceSearch",
|
"performVoiceSearch",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -454,7 +466,9 @@ public class Search implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Search Results
|
* Get Search Results
|
||||||
* This will search the database for the string provided.
|
*
|
||||||
|
* <p>This will search the database for the string provided.
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetSearchResultsRequestBuilder getSearchResults() {
|
public GetSearchResultsRequestBuilder getSearchResults() {
|
||||||
@@ -463,7 +477,9 @@ public class Search implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Search Results
|
* Get Search Results
|
||||||
* This will search the database for the string provided.
|
*
|
||||||
|
* <p>This will search the database for the string provided.
|
||||||
|
*
|
||||||
* @param query The search query string to use
|
* @param query The search query string to use
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
@@ -500,6 +516,7 @@ public class Search implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getSearchResults",
|
"getSearchResults",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -511,6 +528,7 @@ public class Search implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getSearchResults",
|
"getSearchResults",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -520,6 +538,7 @@ public class Search implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getSearchResults",
|
"getSearchResults",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -529,6 +548,7 @@ public class Search implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getSearchResults",
|
"getSearchResults",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
|
|||||||
@@ -1,27 +1,26 @@
|
|||||||
/*
|
/*
|
||||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package dev.plexapi.sdk;
|
package dev.plexapi.sdk;
|
||||||
|
|
||||||
import dev.plexapi.sdk.models.shared.Security;
|
import dev.plexapi.sdk.utils.HasSecurity;
|
||||||
|
|
||||||
public interface SecuritySource {
|
public interface SecuritySource {
|
||||||
|
|
||||||
Security getSecurity();
|
HasSecurity getSecurity();
|
||||||
|
|
||||||
public static SecuritySource of(Security security) {
|
public static SecuritySource of(HasSecurity security) {
|
||||||
return new DefaultSecuritySource(security);
|
return new DefaultSecuritySource(security);
|
||||||
}
|
}
|
||||||
|
|
||||||
public static class DefaultSecuritySource implements SecuritySource {
|
public static class DefaultSecuritySource implements SecuritySource {
|
||||||
private Security security;
|
private HasSecurity security;
|
||||||
|
|
||||||
public DefaultSecuritySource(Security security) {
|
public DefaultSecuritySource(HasSecurity security) {
|
||||||
this.security = security;
|
this.security = security;
|
||||||
}
|
}
|
||||||
|
|
||||||
public Security getSecurity() {
|
public HasSecurity getSecurity() {
|
||||||
return security;
|
return security;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package dev.plexapi.sdk;
|
package dev.plexapi.sdk;
|
||||||
|
|
||||||
import com.fasterxml.jackson.core.type.TypeReference;
|
import com.fasterxml.jackson.core.type.TypeReference;
|
||||||
@@ -64,11 +63,10 @@ import java.lang.String;
|
|||||||
import java.net.http.HttpRequest;
|
import java.net.http.HttpRequest;
|
||||||
import java.net.http.HttpResponse;
|
import java.net.http.HttpResponse;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Operations against the Plex Media Server System.
|
* Operations against the Plex Media Server System.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public class Server implements
|
public class Server implements
|
||||||
MethodCallGetServerCapabilities,
|
MethodCallGetServerCapabilities,
|
||||||
@@ -90,7 +88,9 @@ public class Server implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Server Capabilities
|
* Get Server Capabilities
|
||||||
* Get Server Capabilities
|
*
|
||||||
|
* <p>Get Server Capabilities
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetServerCapabilitiesRequestBuilder getServerCapabilities() {
|
public GetServerCapabilitiesRequestBuilder getServerCapabilities() {
|
||||||
@@ -99,7 +99,9 @@ public class Server implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Server Capabilities
|
* Get Server Capabilities
|
||||||
* Get Server Capabilities
|
*
|
||||||
|
* <p>Get Server Capabilities
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -123,6 +125,7 @@ public class Server implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getServerCapabilities",
|
"getServerCapabilities",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -134,6 +137,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getServerCapabilities",
|
"getServerCapabilities",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -143,6 +147,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getServerCapabilities",
|
"getServerCapabilities",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -152,6 +157,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getServerCapabilities",
|
"getServerCapabilities",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -245,7 +251,9 @@ public class Server implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Server Preferences
|
* Get Server Preferences
|
||||||
* Get Server Preferences
|
*
|
||||||
|
* <p>Get Server Preferences
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetServerPreferencesRequestBuilder getServerPreferences() {
|
public GetServerPreferencesRequestBuilder getServerPreferences() {
|
||||||
@@ -254,7 +262,9 @@ public class Server implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Server Preferences
|
* Get Server Preferences
|
||||||
* Get Server Preferences
|
*
|
||||||
|
* <p>Get Server Preferences
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -278,6 +288,7 @@ public class Server implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getServerPreferences",
|
"getServerPreferences",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -289,6 +300,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getServerPreferences",
|
"getServerPreferences",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -298,6 +310,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getServerPreferences",
|
"getServerPreferences",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -307,6 +320,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getServerPreferences",
|
"getServerPreferences",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -400,7 +414,9 @@ public class Server implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Available Clients
|
* Get Available Clients
|
||||||
* Get Available Clients
|
*
|
||||||
|
* <p>Get Available Clients
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetAvailableClientsRequestBuilder getAvailableClients() {
|
public GetAvailableClientsRequestBuilder getAvailableClients() {
|
||||||
@@ -409,7 +425,9 @@ public class Server implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Available Clients
|
* Get Available Clients
|
||||||
* Get Available Clients
|
*
|
||||||
|
* <p>Get Available Clients
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -433,6 +451,7 @@ public class Server implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getAvailableClients",
|
"getAvailableClients",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -444,6 +463,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getAvailableClients",
|
"getAvailableClients",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -453,6 +473,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getAvailableClients",
|
"getAvailableClients",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -462,6 +483,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getAvailableClients",
|
"getAvailableClients",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -555,7 +577,9 @@ public class Server implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Devices
|
* Get Devices
|
||||||
* Get Devices
|
*
|
||||||
|
* <p>Get Devices
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetDevicesRequestBuilder getDevices() {
|
public GetDevicesRequestBuilder getDevices() {
|
||||||
@@ -564,7 +588,9 @@ public class Server implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Devices
|
* Get Devices
|
||||||
* Get Devices
|
*
|
||||||
|
* <p>Get Devices
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -588,6 +614,7 @@ public class Server implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getDevices",
|
"getDevices",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -599,6 +626,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getDevices",
|
"getDevices",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -608,6 +636,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getDevices",
|
"getDevices",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -617,6 +646,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getDevices",
|
"getDevices",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -710,7 +740,9 @@ public class Server implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Server Identity
|
* Get Server Identity
|
||||||
* This request is useful to determine if the server is online or offline
|
*
|
||||||
|
* <p>This request is useful to determine if the server is online or offline
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetServerIdentityRequestBuilder getServerIdentity() {
|
public GetServerIdentityRequestBuilder getServerIdentity() {
|
||||||
@@ -719,7 +751,9 @@ public class Server implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Server Identity
|
* Get Server Identity
|
||||||
* This request is useful to determine if the server is online or offline
|
*
|
||||||
|
* <p>This request is useful to determine if the server is online or offline
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -740,6 +774,7 @@ public class Server implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-server-identity",
|
"get-server-identity",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -751,6 +786,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-server-identity",
|
"get-server-identity",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -760,6 +796,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-server-identity",
|
"get-server-identity",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -769,6 +806,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-server-identity",
|
"get-server-identity",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -846,7 +884,9 @@ public class Server implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get MyPlex Account
|
* Get MyPlex Account
|
||||||
* Returns MyPlex Account Information
|
*
|
||||||
|
* <p>Returns MyPlex Account Information
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetMyPlexAccountRequestBuilder getMyPlexAccount() {
|
public GetMyPlexAccountRequestBuilder getMyPlexAccount() {
|
||||||
@@ -855,7 +895,9 @@ public class Server implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get MyPlex Account
|
* Get MyPlex Account
|
||||||
* Returns MyPlex Account Information
|
*
|
||||||
|
* <p>Returns MyPlex Account Information
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -879,6 +921,7 @@ public class Server implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getMyPlexAccount",
|
"getMyPlexAccount",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -890,6 +933,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getMyPlexAccount",
|
"getMyPlexAccount",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -899,6 +943,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getMyPlexAccount",
|
"getMyPlexAccount",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -908,6 +953,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getMyPlexAccount",
|
"getMyPlexAccount",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1001,7 +1047,8 @@ public class Server implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a Resized Photo
|
* Get a Resized Photo
|
||||||
* Plex's Photo transcoder is used throughout the service to serve images at specified sizes.
|
*
|
||||||
|
* <p>Plex's Photo transcoder is used throughout the service to serve images at specified sizes.
|
||||||
*
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
@@ -1011,7 +1058,8 @@ public class Server implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a Resized Photo
|
* Get a Resized Photo
|
||||||
* Plex's Photo transcoder is used throughout the service to serve images at specified sizes.
|
*
|
||||||
|
* <p>Plex's Photo transcoder is used throughout the service to serve images at specified sizes.
|
||||||
*
|
*
|
||||||
* @param request The request object containing all of the parameters for the API call.
|
* @param request The request object containing all of the parameters for the API call.
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
@@ -1043,6 +1091,7 @@ public class Server implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getResizedPhoto",
|
"getResizedPhoto",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1054,6 +1103,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getResizedPhoto",
|
"getResizedPhoto",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1063,6 +1113,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getResizedPhoto",
|
"getResizedPhoto",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1072,6 +1123,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getResizedPhoto",
|
"getResizedPhoto",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1154,7 +1206,9 @@ public class Server implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Media Providers
|
* Get Media Providers
|
||||||
* Retrieves media providers and their features from the Plex server.
|
*
|
||||||
|
* <p>Retrieves media providers and their features from the Plex server.
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetMediaProvidersRequestBuilder getMediaProviders() {
|
public GetMediaProvidersRequestBuilder getMediaProviders() {
|
||||||
@@ -1163,7 +1217,9 @@ public class Server implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Media Providers
|
* Get Media Providers
|
||||||
* Retrieves media providers and their features from the Plex server.
|
*
|
||||||
|
* <p>Retrieves media providers and their features from the Plex server.
|
||||||
|
*
|
||||||
* @param xPlexToken An authentication token, obtained from plex.tv
|
* @param xPlexToken An authentication token, obtained from plex.tv
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
@@ -1196,6 +1252,7 @@ public class Server implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-media-providers",
|
"get-media-providers",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1207,6 +1264,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-media-providers",
|
"get-media-providers",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1216,6 +1274,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-media-providers",
|
"get-media-providers",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1225,6 +1284,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"get-media-providers",
|
"get-media-providers",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1318,7 +1378,9 @@ public class Server implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Server List
|
* Get Server List
|
||||||
* Get Server List
|
*
|
||||||
|
* <p>Get Server List
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetServerListRequestBuilder getServerList() {
|
public GetServerListRequestBuilder getServerList() {
|
||||||
@@ -1327,7 +1389,9 @@ public class Server implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Server List
|
* Get Server List
|
||||||
* Get Server List
|
*
|
||||||
|
* <p>Get Server List
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -1351,6 +1415,7 @@ public class Server implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getServerList",
|
"getServerList",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1362,6 +1427,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getServerList",
|
"getServerList",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1371,6 +1437,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getServerList",
|
"getServerList",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -1380,6 +1447,7 @@ public class Server implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getServerList",
|
"getServerList",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package dev.plexapi.sdk;
|
package dev.plexapi.sdk;
|
||||||
|
|
||||||
import com.fasterxml.jackson.core.type.TypeReference;
|
import com.fasterxml.jackson.core.type.TypeReference;
|
||||||
@@ -42,11 +41,10 @@ import java.lang.String;
|
|||||||
import java.net.http.HttpRequest;
|
import java.net.http.HttpRequest;
|
||||||
import java.net.http.HttpResponse;
|
import java.net.http.HttpResponse;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls that perform search operations with Plex Media Server Sessions
|
* API Calls that perform search operations with Plex Media Server Sessions
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public class Sessions implements
|
public class Sessions implements
|
||||||
MethodCallGetSessions,
|
MethodCallGetSessions,
|
||||||
@@ -63,7 +61,9 @@ public class Sessions implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Active Sessions
|
* Get Active Sessions
|
||||||
* This will retrieve the "Now Playing" Information of the PMS.
|
*
|
||||||
|
* <p>This will retrieve the "Now Playing" Information of the PMS.
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetSessionsRequestBuilder getSessions() {
|
public GetSessionsRequestBuilder getSessions() {
|
||||||
@@ -72,7 +72,9 @@ public class Sessions implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Active Sessions
|
* Get Active Sessions
|
||||||
* This will retrieve the "Now Playing" Information of the PMS.
|
*
|
||||||
|
* <p>This will retrieve the "Now Playing" Information of the PMS.
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -96,6 +98,7 @@ public class Sessions implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getSessions",
|
"getSessions",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -107,6 +110,7 @@ public class Sessions implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getSessions",
|
"getSessions",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -116,6 +120,7 @@ public class Sessions implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getSessions",
|
"getSessions",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -125,6 +130,7 @@ public class Sessions implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getSessions",
|
"getSessions",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -218,7 +224,9 @@ public class Sessions implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Session History
|
* Get Session History
|
||||||
* This will Retrieve a listing of all history views.
|
*
|
||||||
|
* <p>This will Retrieve a listing of all history views.
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetSessionHistoryRequestBuilder getSessionHistory() {
|
public GetSessionHistoryRequestBuilder getSessionHistory() {
|
||||||
@@ -227,7 +235,9 @@ public class Sessions implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Session History
|
* Get Session History
|
||||||
* This will Retrieve a listing of all history views.
|
*
|
||||||
|
* <p>This will Retrieve a listing of all history views.
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -237,16 +247,18 @@ public class Sessions implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Session History
|
* Get Session History
|
||||||
* This will Retrieve a listing of all history views.
|
*
|
||||||
|
* <p>This will Retrieve a listing of all history views.
|
||||||
|
*
|
||||||
* @param sort Sorts the results by the specified field followed by the direction (asc, desc)
|
* @param sort Sorts the results by the specified field followed by the direction (asc, desc)
|
||||||
|
*
|
||||||
* @param accountId Filter results by those that are related to a specific users id
|
* @param accountId Filter results by those that are related to a specific users id
|
||||||
|
*
|
||||||
* @param filter Filters content by field and direction/equality
|
* @param filter Filters content by field and direction/equality
|
||||||
(Unknown if viewedAt is the only supported column)
|
* (Unknown if viewedAt is the only supported column)
|
||||||
|
*
|
||||||
* @param librarySectionID Filters the results based on the id of a valid library section
|
* @param librarySectionID Filters the results based on the id of a valid library section
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -288,6 +300,7 @@ public class Sessions implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getSessionHistory",
|
"getSessionHistory",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -299,6 +312,7 @@ public class Sessions implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getSessionHistory",
|
"getSessionHistory",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -308,6 +322,7 @@ public class Sessions implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getSessionHistory",
|
"getSessionHistory",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -317,6 +332,7 @@ public class Sessions implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getSessionHistory",
|
"getSessionHistory",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -410,7 +426,9 @@ public class Sessions implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Transcode Sessions
|
* Get Transcode Sessions
|
||||||
* Get Transcode Sessions
|
*
|
||||||
|
* <p>Get Transcode Sessions
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetTranscodeSessionsRequestBuilder getTranscodeSessions() {
|
public GetTranscodeSessionsRequestBuilder getTranscodeSessions() {
|
||||||
@@ -419,7 +437,9 @@ public class Sessions implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Transcode Sessions
|
* Get Transcode Sessions
|
||||||
* Get Transcode Sessions
|
*
|
||||||
|
* <p>Get Transcode Sessions
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -443,6 +463,7 @@ public class Sessions implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getTranscodeSessions",
|
"getTranscodeSessions",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -454,6 +475,7 @@ public class Sessions implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getTranscodeSessions",
|
"getTranscodeSessions",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -463,6 +485,7 @@ public class Sessions implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getTranscodeSessions",
|
"getTranscodeSessions",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -472,6 +495,7 @@ public class Sessions implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getTranscodeSessions",
|
"getTranscodeSessions",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -565,7 +589,9 @@ public class Sessions implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Stop a Transcode Session
|
* Stop a Transcode Session
|
||||||
* Stop a Transcode Session
|
*
|
||||||
|
* <p>Stop a Transcode Session
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public StopTranscodeSessionRequestBuilder stopTranscodeSession() {
|
public StopTranscodeSessionRequestBuilder stopTranscodeSession() {
|
||||||
@@ -574,7 +600,9 @@ public class Sessions implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Stop a Transcode Session
|
* Stop a Transcode Session
|
||||||
* Stop a Transcode Session
|
*
|
||||||
|
* <p>Stop a Transcode Session
|
||||||
|
*
|
||||||
* @param sessionKey the Key of the transcode session to stop
|
* @param sessionKey the Key of the transcode session to stop
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
@@ -608,6 +636,7 @@ public class Sessions implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"stopTranscodeSession",
|
"stopTranscodeSession",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -619,6 +648,7 @@ public class Sessions implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"stopTranscodeSession",
|
"stopTranscodeSession",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -628,6 +658,7 @@ public class Sessions implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"stopTranscodeSession",
|
"stopTranscodeSession",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -637,6 +668,7 @@ public class Sessions implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"stopTranscodeSession",
|
"stopTranscodeSession",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package dev.plexapi.sdk;
|
package dev.plexapi.sdk;
|
||||||
|
|
||||||
import com.fasterxml.jackson.core.type.TypeReference;
|
import com.fasterxml.jackson.core.type.TypeReference;
|
||||||
@@ -38,11 +37,10 @@ import java.lang.String;
|
|||||||
import java.net.http.HttpRequest;
|
import java.net.http.HttpRequest;
|
||||||
import java.net.http.HttpResponse;
|
import java.net.http.HttpResponse;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* API Calls that perform operations with Plex Media Server Statistics
|
* API Calls that perform operations with Plex Media Server Statistics
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public class Statistics implements
|
public class Statistics implements
|
||||||
MethodCallGetStatistics,
|
MethodCallGetStatistics,
|
||||||
@@ -58,7 +56,9 @@ public class Statistics implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Media Statistics
|
* Get Media Statistics
|
||||||
* This will return the media statistics for the server
|
*
|
||||||
|
* <p>This will return the media statistics for the server
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetStatisticsRequestBuilder getStatistics() {
|
public GetStatisticsRequestBuilder getStatistics() {
|
||||||
@@ -67,7 +67,9 @@ public class Statistics implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Media Statistics
|
* Get Media Statistics
|
||||||
* This will return the media statistics for the server
|
*
|
||||||
|
* <p>This will return the media statistics for the server
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -77,10 +79,12 @@ public class Statistics implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Media Statistics
|
* Get Media Statistics
|
||||||
* This will return the media statistics for the server
|
*
|
||||||
|
* <p>This will return the media statistics for the server
|
||||||
|
*
|
||||||
* @param timespan The timespan to retrieve statistics for
|
* @param timespan The timespan to retrieve statistics for
|
||||||
the exact meaning of this parameter is not known
|
* the exact meaning of this parameter is not known
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -116,6 +120,7 @@ public class Statistics implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getStatistics",
|
"getStatistics",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -127,6 +132,7 @@ public class Statistics implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getStatistics",
|
"getStatistics",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -136,6 +142,7 @@ public class Statistics implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getStatistics",
|
"getStatistics",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -145,6 +152,7 @@ public class Statistics implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getStatistics",
|
"getStatistics",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -238,7 +246,9 @@ public class Statistics implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Resources Statistics
|
* Get Resources Statistics
|
||||||
* This will return the resources for the server
|
*
|
||||||
|
* <p>This will return the resources for the server
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetResourcesStatisticsRequestBuilder getResourcesStatistics() {
|
public GetResourcesStatisticsRequestBuilder getResourcesStatistics() {
|
||||||
@@ -247,7 +257,9 @@ public class Statistics implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Resources Statistics
|
* Get Resources Statistics
|
||||||
* This will return the resources for the server
|
*
|
||||||
|
* <p>This will return the resources for the server
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -257,10 +269,12 @@ public class Statistics implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Resources Statistics
|
* Get Resources Statistics
|
||||||
* This will return the resources for the server
|
*
|
||||||
|
* <p>This will return the resources for the server
|
||||||
|
*
|
||||||
* @param timespan The timespan to retrieve statistics for
|
* @param timespan The timespan to retrieve statistics for
|
||||||
the exact meaning of this parameter is not known
|
* the exact meaning of this parameter is not known
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -296,6 +310,7 @@ public class Statistics implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getResourcesStatistics",
|
"getResourcesStatistics",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -307,6 +322,7 @@ public class Statistics implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getResourcesStatistics",
|
"getResourcesStatistics",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -316,6 +332,7 @@ public class Statistics implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getResourcesStatistics",
|
"getResourcesStatistics",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -325,6 +342,7 @@ public class Statistics implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getResourcesStatistics",
|
"getResourcesStatistics",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -418,7 +436,9 @@ public class Statistics implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Bandwidth Statistics
|
* Get Bandwidth Statistics
|
||||||
* This will return the bandwidth statistics for the server
|
*
|
||||||
|
* <p>This will return the bandwidth statistics for the server
|
||||||
|
*
|
||||||
* @return The call builder
|
* @return The call builder
|
||||||
*/
|
*/
|
||||||
public GetBandwidthStatisticsRequestBuilder getBandwidthStatistics() {
|
public GetBandwidthStatisticsRequestBuilder getBandwidthStatistics() {
|
||||||
@@ -427,7 +447,9 @@ public class Statistics implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Bandwidth Statistics
|
* Get Bandwidth Statistics
|
||||||
* This will return the bandwidth statistics for the server
|
*
|
||||||
|
* <p>This will return the bandwidth statistics for the server
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -437,10 +459,12 @@ public class Statistics implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get Bandwidth Statistics
|
* Get Bandwidth Statistics
|
||||||
* This will return the bandwidth statistics for the server
|
*
|
||||||
|
* <p>This will return the bandwidth statistics for the server
|
||||||
|
*
|
||||||
* @param timespan The timespan to retrieve statistics for
|
* @param timespan The timespan to retrieve statistics for
|
||||||
the exact meaning of this parameter is not known
|
* the exact meaning of this parameter is not known
|
||||||
|
*
|
||||||
* @return The response from the API call
|
* @return The response from the API call
|
||||||
* @throws Exception if the API call fails
|
* @throws Exception if the API call fails
|
||||||
*/
|
*/
|
||||||
@@ -476,6 +500,7 @@ public class Statistics implements
|
|||||||
sdkConfiguration.hooks()
|
sdkConfiguration.hooks()
|
||||||
.beforeRequest(
|
.beforeRequest(
|
||||||
new BeforeRequestContextImpl(
|
new BeforeRequestContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getBandwidthStatistics",
|
"getBandwidthStatistics",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -487,6 +512,7 @@ public class Statistics implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getBandwidthStatistics",
|
"getBandwidthStatistics",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -496,6 +522,7 @@ public class Statistics implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterSuccess(
|
.afterSuccess(
|
||||||
new AfterSuccessContextImpl(
|
new AfterSuccessContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getBandwidthStatistics",
|
"getBandwidthStatistics",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
@@ -505,6 +532,7 @@ public class Statistics implements
|
|||||||
_httpRes = sdkConfiguration.hooks()
|
_httpRes = sdkConfiguration.hooks()
|
||||||
.afterError(
|
.afterError(
|
||||||
new AfterErrorContextImpl(
|
new AfterErrorContextImpl(
|
||||||
|
_baseUrl,
|
||||||
"getBandwidthStatistics",
|
"getBandwidthStatistics",
|
||||||
Optional.of(List.of()),
|
Optional.of(List.of()),
|
||||||
_hookSecuritySource),
|
_hookSecuritySource),
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user