mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 12:37:47 +00:00
Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
dd781d1e27 | ||
|
|
dcdcafc044 | ||
|
|
04db2979db | ||
|
|
c2eeb488c4 | ||
|
|
8194abfa99 |
3
.gitattributes
vendored
3
.gitattributes
vendored
@@ -8,5 +8,4 @@
|
||||
*.bat text eol=crlf
|
||||
|
||||
# This allows generated code to be indexed correctly
|
||||
*.java linguist-generated=false
|
||||
|
||||
*.java linguist-generated=false
|
||||
File diff suppressed because one or more lines are too long
@@ -15,7 +15,7 @@ generation:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
oAuth2PasswordEnabled: false
|
||||
java:
|
||||
version: 0.13.0
|
||||
version: 0.14.2
|
||||
additionalDependencies: []
|
||||
additionalPlugins: []
|
||||
artifactID: plexapi
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.513.2
|
||||
speakeasyVersion: 1.529.1
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
@@ -8,19 +8,19 @@ sources:
|
||||
- latest
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:bf7001af017ce5072c503bfbaf60793f94549163b517489dc53e4f7b685659c0
|
||||
sourceBlobDigest: sha256:ed2b29043c84f32d2efa92a126083fd9a81644a7ce9c6ac86d9aeb3493cbd6f8
|
||||
sourceRevisionDigest: sha256:ea508e3da23b283f47aeb4384d6b3ab374a27bdffb8d8d8376cedbad3ad77a06
|
||||
sourceBlobDigest: sha256:c210adbd02b0213b9e6f95ffc27f60ec38f8f9040137d55ccf2b650d92ab0ff5
|
||||
tags:
|
||||
- latest
|
||||
- speakeasy-sdk-regen-1741307253
|
||||
- speakeasy-sdk-regen-1743899436
|
||||
targets:
|
||||
plexjava:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:bf7001af017ce5072c503bfbaf60793f94549163b517489dc53e4f7b685659c0
|
||||
sourceBlobDigest: sha256:ed2b29043c84f32d2efa92a126083fd9a81644a7ce9c6ac86d9aeb3493cbd6f8
|
||||
sourceRevisionDigest: sha256:ea508e3da23b283f47aeb4384d6b3ab374a27bdffb8d8d8376cedbad3ad77a06
|
||||
sourceBlobDigest: sha256:c210adbd02b0213b9e6f95ffc27f60ec38f8f9040137d55ccf2b650d92ab0ff5
|
||||
codeSamplesNamespace: code-samples-java-plexjava
|
||||
codeSamplesRevisionDigest: sha256:867c2c5221857129302871ef35dc9c448a467474c29768830e2d291749d164c1
|
||||
codeSamplesRevisionDigest: sha256:c7bc64aee5441f09dae1f6b15a89c94f6b6065f2e25f5528e849e5ddf2f50d8c
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
@@ -42,3 +42,5 @@ workflow:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
|
||||
labelOverride:
|
||||
fixedValue: PlexJava
|
||||
|
||||
@@ -18,3 +18,5 @@ targets:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
|
||||
labelOverride:
|
||||
fixedValue: PlexJava
|
||||
|
||||
12
README.md
12
README.md
@@ -69,7 +69,7 @@ The samples below show how a published SDK artifact is used:
|
||||
|
||||
Gradle:
|
||||
```groovy
|
||||
implementation 'dev.plexapi:plexapi:0.13.0'
|
||||
implementation 'dev.plexapi:plexapi:0.14.2'
|
||||
```
|
||||
|
||||
Maven:
|
||||
@@ -77,7 +77,7 @@ Maven:
|
||||
<dependency>
|
||||
<groupId>dev.plexapi</groupId>
|
||||
<artifactId>plexapi</artifactId>
|
||||
<version>0.13.0</version>
|
||||
<version>0.14.2</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
@@ -177,9 +177,12 @@ public class Application {
|
||||
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
|
||||
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||
* [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
|
||||
* [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)
|
||||
|
||||
@@ -333,6 +336,7 @@ The default server `{protocol}://{ip}:{port}` contains variables and is set to `
|
||||
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;
|
||||
@@ -343,7 +347,7 @@ public class Application {
|
||||
public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.protocol("https")
|
||||
.protocol(ServerProtocol.HTTPS)
|
||||
.ip("e0c3:bcc0:6bac:dccc:c4ec:34b1:ca98:4cb9")
|
||||
.port("40311")
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
|
||||
42
RELEASES.md
42
RELEASES.md
@@ -268,4 +268,44 @@ Based on:
|
||||
### Generated
|
||||
- [java v0.13.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.13.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.13.0 - .
|
||||
- [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 - .
|
||||
|
||||
## 2025-04-06 00:30:19
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.529.1 (2.566.5) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.14.2] .
|
||||
### Releases
|
||||
- [Maven Central v0.14.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.14.2 - .
|
||||
26
build.gradle
26
build.gradle
@@ -39,9 +39,12 @@ model {
|
||||
}
|
||||
}
|
||||
|
||||
version = "${version}"
|
||||
group = "${groupId}"
|
||||
|
||||
jar {
|
||||
dependsOn(":generatePomFileForMavenPublication")
|
||||
archiveBaseName = "plexapi"
|
||||
archiveBaseName = "${artifactId}"
|
||||
|
||||
into("META-INF/maven/dev.plexapi/plexapi") {
|
||||
from("$buildDir/pom.xml")
|
||||
@@ -62,15 +65,12 @@ tasks.withType(Javadoc) {
|
||||
options.addStringOption('Xdoclint:none', '-quiet')
|
||||
}
|
||||
|
||||
group = "dev.plexapi"
|
||||
version = "0.13.0"
|
||||
|
||||
sourcesJar {
|
||||
archiveBaseName = "plexapi"
|
||||
archiveBaseName = "${artifactId}"
|
||||
}
|
||||
|
||||
javadocJar {
|
||||
archiveBaseName = "plexapi"
|
||||
archiveBaseName = "${artifactId}"
|
||||
}
|
||||
sonatypeCentralUpload {
|
||||
// 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)
|
||||
archives = files(
|
||||
"$buildDir/libs/plexapi-${version}.jar",
|
||||
"$buildDir/libs/plexapi-${version}-sources.jar",
|
||||
"$buildDir/libs/plexapi-${version}-javadoc.jar"
|
||||
"$buildDir/libs/${artifactId}-${version}.jar",
|
||||
"$buildDir/libs/${artifactId}-${version}-sources.jar",
|
||||
"$buildDir/libs/${artifactId}-${version}-javadoc.jar"
|
||||
)
|
||||
|
||||
// This is the pom file to upload. This is required by central
|
||||
@@ -99,9 +99,11 @@ publishing {
|
||||
|
||||
publications {
|
||||
maven(MavenPublication) {
|
||||
groupId = 'dev.plexapi'
|
||||
artifactId = 'plexapi'
|
||||
version = '0.13.0'
|
||||
// note that properties can't yet be used below!
|
||||
// https://github.com/gradle/gradle/issues/18619
|
||||
groupId = "dev.plexapi"
|
||||
artifactId = "plexapi"
|
||||
version = "0.14.2"
|
||||
|
||||
from components.java
|
||||
|
||||
|
||||
1094
codeSamples.yaml
1094
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
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| `tag` | *String* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||
@@ -1,8 +1,12 @@
|
||||
# Country
|
||||
|
||||
The filter query string for country media items.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | United States of America |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `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
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||
| `tag` | *String* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||
@@ -1,8 +1,12 @@
|
||||
# Genre
|
||||
|
||||
The filter query string for similar items.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | Adventure |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `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 |
|
||||
@@ -5,24 +5,24 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `art` | *String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `composite` | *String* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
|
||||
| `filters` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `refreshing` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `thumb` | *String* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
||||
| `key` | *String* | :heavy_check_mark: | N/A | 1 |
|
||||
| `type` | *String* | :heavy_check_mark: | N/A | movie |
|
||||
| `title` | *String* | :heavy_check_mark: | N/A | Movies |
|
||||
| `agent` | *String* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
|
||||
| `scanner` | *String* | :heavy_check_mark: | N/A | Plex Movie |
|
||||
| `language` | *String* | :heavy_check_mark: | N/A | en-US |
|
||||
| `uuid` | *String* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `art` | *String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||
| `composite` | *String* | :heavy_check_mark: | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
|
||||
| `filters` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `refreshing` | *boolean* | :heavy_check_mark: | Indicates whether the library is currently being refreshed or updated | true |
|
||||
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `key` | *String* | :heavy_check_mark: | The library key representing the unique identifier | 1 |
|
||||
| `type` | [GetAllLibrariesType](../../models/operations/GetAllLibrariesType.md) | :heavy_check_mark: | N/A | movie |
|
||||
| `title` | *String* | :heavy_check_mark: | The title of the library | Movies |
|
||||
| `agent` | *String* | :heavy_check_mark: | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
|
||||
| `scanner` | *String* | :heavy_check_mark: | UNKNOWN | Plex Movie |
|
||||
| `language` | *String* | :heavy_check_mark: | The Plex library language that has been set | en-US |
|
||||
| `uuid` | *String* | :heavy_check_mark: | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-01e7d3cc34d6 |
|
||||
| `updatedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `createdAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `createdAt` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1556281940 |
|
||||
| `scannedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `content` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `directory` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `contentChangedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `hidden` | *int* | :heavy_check_mark: | N/A | 0 |
|
||||
| `content` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `directory` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `contentChangedAt` | *int* | :heavy_check_mark: | The number of seconds since the content was last changed relative to now. | 9173960 |
|
||||
| `hidden` | [Optional\<Hidden>](../../models/operations/Hidden.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `location` | List\<[GetAllLibrariesLocation](../../models/operations/GetAllLibrariesLocation.md)> | :heavy_check_mark: | N/A | |
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 1 |
|
||||
| `path` | *String* | :heavy_check_mark: | N/A | /movies |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | The ID of the location. | 1 |
|
||||
| `path` | *String* | :heavy_check_mark: | The path to the media item. | /Movies |
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| `size` | *int* | :heavy_check_mark: | N/A | 5 |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `title1` | *String* | :heavy_check_mark: | N/A | Plex Library |
|
||||
| `directory` | List\<[GetAllLibrariesDirectory](../../models/operations/GetAllLibrariesDirectory.md)> | :heavy_check_mark: | N/A | |
|
||||
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `title1` | *String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||
| `directory` | List\<[GetAllLibrariesDirectory](../../models/operations/GetAllLibrariesDirectory.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -5,6 +5,6 @@ The libraries available on the Server
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [GetAllLibrariesMediaContainer](../../models/operations/GetAllLibrariesMediaContainer.md) | :heavy_check_mark: | N/A |
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [Optional\<GetAllLibrariesMediaContainer>](../../models/operations/GetAllLibrariesMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
15
docs/models/operations/GetAllLibrariesType.md
Normal file
15
docs/models/operations/GetAllLibrariesType.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# GetAllLibrariesType
|
||||
|
||||
The library type
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
@@ -3,6 +3,6 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `tag` | *String* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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/> |
|
||||
| `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 |
|
||||
| `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. |
|
||||
| `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 |
|
||||
@@ -70,5 +70,5 @@ Unknown
|
||||
| `director` | List\<[GetAllMediaLibraryDirector](../../models/operations/GetAllMediaLibraryDirector.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 | |
|
||||
| `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 | |
|
||||
@@ -3,6 +3,6 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `tag` | *String* | :heavy_check_mark: | The name of the actor for this role | Danny Boyle |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| `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 |
|
||||
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *String* | :heavy_check_mark: | Language of the stream. | English |
|
||||
| `languageTag` | *String* | :heavy_check_mark: | Language tag (e.g., en). | en |
|
||||
| `languageCode` | *String* | :heavy_check_mark: | ISO language code. | eng |
|
||||
| `language` | *Optional\<String>* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `languageTag` | *Optional\<String>* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
| `languageCode` | *Optional\<String>* | :heavy_minus_sign: | ISO language code. | eng |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `codedHeight` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `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 |
|
||||
| `colorRange` | *Optional\<String>* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `colorSpace` | *Optional\<String>* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
@@ -39,6 +40,7 @@
|
||||
| `hasScalingMatrix` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `profile` | *Optional\<String>* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `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 |
|
||||
| `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) |
|
||||
|
||||
@@ -5,4 +5,4 @@
|
||||
|
||||
| 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 |
|
||||
| `seasonCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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\<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\<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\<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 |
|
||||
| `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 |
|
||||
@@ -55,9 +55,9 @@
|
||||
| `collection` | List\<[GetLibraryItemsCollection](../../models/operations/GetLibraryItemsCollection.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | List\<[GetLibraryItemsRole](../../models/operations/GetLibraryItemsRole.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `location` | List\<[GetLibraryItemsLocation](../../models/operations/GetLibraryItemsLocation.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `mediaGuid` | List\<[GetLibraryItemsMediaGuid](../../models/operations/GetLibraryItemsMediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||
| `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 | |
|
||||
| `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 | |
|
||||
| `titleSort` | *Optional\<String>* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `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
|
||||
@@ -8,4 +8,4 @@
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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. | |
|
||||
| `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. | |
|
||||
| `producer` | List\<[Producer](../../models/operations/Producer.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. | |
|
||||
| `producer` | List\<[GetMediaMetaDataProducer](../../models/operations/GetMediaMetaDataProducer.md)> | :heavy_minus_sign: | An array of Writer roles. | |
|
||||
| `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. | |
|
||||
@@ -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 |
|
||||
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *String* | :heavy_check_mark: | Language of the stream. | English |
|
||||
| `languageTag` | *String* | :heavy_check_mark: | Language tag (e.g., en). | en |
|
||||
| `languageCode` | *String* | :heavy_check_mark: | ISO language code. | eng |
|
||||
| `language` | *Optional\<String>* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `languageTag` | *Optional\<String>* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
| `languageCode` | *Optional\<String>* | :heavy_minus_sign: | ISO language code. | eng |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `codedHeight` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `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 |
|
||||
| `colorRange` | *Optional\<String>* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `colorSpace` | *Optional\<String>* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
@@ -39,6 +40,7 @@
|
||||
| `hasScalingMatrix` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `profile` | *Optional\<String>* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `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 |
|
||||
| `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) |
|
||||
|
||||
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 |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `size` | *long* | :heavy_check_mark: | N/A | 50 |
|
||||
| `offset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | |
|
||||
| `totalSize` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | |
|
||||
| `identifier` | *Optional\<String>* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `allowSync` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `totalSize` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
||||
| `offset` | *long* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | 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/> | |
|
||||
| `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
|
||||
|
||||
Unknown
|
||||
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ratingKey` | *String* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
|
||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/metadata/58683 |
|
||||
| `guid` | *String* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `studio` | *Optional\<String>* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||
| `skipChildren` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `librarySectionID` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `librarySectionTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `librarySectionKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||
| `type` | [GetRecentlyAddedHubsType](../../models/operations/GetRecentlyAddedHubsType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
||||
| `title` | *String* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||
| `slug` | *Optional\<String>* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *String* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
||||
| `rating` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 7.6 |
|
||||
| `audienceRating` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 9.2 |
|
||||
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `seasonCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `tagline` | *Optional\<String>* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||
| `flattenSeasons` | [Optional\<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\<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\<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\<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 |
|
||||
| `art` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `banner` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
||||
| `addedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `audienceRatingImage` | *Optional\<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `chapterSource` | *Optional\<String>* | :heavy_minus_sign: | N/A | media |
|
||||
| `primaryExtraKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||
| `ratingImage` | *Optional\<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | 66 |
|
||||
| `grandparentGuid` | *Optional\<String>* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `parentSlug` | *Optional\<String>* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `grandparentSlug` | *Optional\<String>* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||
| `grandparentTheme` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| `media` | List\<[Media](../../models/operations/Media.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
||||
| `genre` | List\<[Genre](../../models/operations/Genre.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `country` | List\<[Country](../../models/operations/Country.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `director` | List\<[Director](../../models/operations/Director.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | List\<[Writer](../../models/operations/Writer.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | List\<[Collection](../../models/operations/Collection.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | List\<[Role](../../models/operations/Role.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `location` | List\<[Location](../../models/operations/Location.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `mediaGuid` | List\<[MediaGuid](../../models/operations/MediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||
| `ultraBlurColors` | [Optional\<UltraBlurColors>](../../models/operations/UltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `metaDataRating` | List\<[MetaDataRating](../../models/operations/MetaDataRating.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `image` | List\<[GetRecentlyAddedImage](../../models/operations/GetRecentlyAddedImage.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `titleSort` | *Optional\<String>* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `viewCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `lastViewedAt` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||
| `originalTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `viewOffset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 5222500 |
|
||||
| `skipCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `index` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `theme` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
||||
| `leafCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 14 |
|
||||
| `viewedLeafCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `childCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `hasPremiumExtras` | *Optional\<String>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `hasPremiumPrimaryExtra` | *Optional\<String>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
||||
| `parentGuid` | *Optional\<String>* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `parentStudio` | *Optional\<String>* | :heavy_minus_sign: | N/A | UCP |
|
||||
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `parentIndex` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parentYear` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2010 |
|
||||
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `parentTheme` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `addedAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `art` | *String* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||
| `audienceRatingImage` | *Optional\<String>* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||
| `audienceRating` | *double* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||
| `chapterSource` | *Optional\<String>* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||||
| `childCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||||
| `grandparentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||||
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||||
| `grandparentSlug` | *Optional\<String>* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||||
| `grandparentTheme` | *Optional\<String>* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||||
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||||
| `guid` | *String* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||||
| `key` | *String* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
|
||||
| `lastRatedAt` | *Optional\<Long>* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||
| `lastViewedAt` | *Optional\<Integer>* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||
| `leafCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||
| `librarySectionID` | *long* | :heavy_check_mark: | The identifier for the library section. | 1 |
|
||||
| `librarySectionKey` | *String* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `librarySectionTitle` | *String* | :heavy_check_mark: | The title of the library section. | Movies |
|
||||
| `originalTitle` | *Optional\<String>* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `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 |
|
||||
| `parentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `parentIndex` | *Optional\<Integer>* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||||
| `parentSlug` | *Optional\<String>* | :heavy_minus_sign: | The slug for the parent media item. | alice-in-borderland-2020 |
|
||||
| `parentStudio` | *String* | :heavy_check_mark: | The studio of the parent media item. | UCP |
|
||||
| `parentTheme` | *String* | :heavy_check_mark: | The theme URL for the parent media item. | /library/metadata/66/theme/1705716261 |
|
||||
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||||
| `parentYear` | *Optional\<Integer>* | :heavy_minus_sign: | The release year of the parent media item. | 2010 |
|
||||
| `primaryExtraKey` | *Optional\<String>* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||||
| `ratingImage` | *Optional\<String>* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||||
| `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 |
|
||||
| `rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||||
| `seasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||
| `skipCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||||
| `slug` | *String* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
||||
| `studio` | *Optional\<String>* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
||||
| `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 |
|
||||
| `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/> |
|
||||
| `tagline` | *String* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||
| `theme` | *String* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
|
||||
| `thumb` | *String* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||
| `titleSort` | *String* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
||||
| `title` | *String* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||
| `type` | [GetRecentlyAddedHubsType](../../models/operations/GetRecentlyAddedHubsType.md) | :heavy_check_mark: | N/A | movie |
|
||||
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `userRating` | *Optional\<Float>* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||
| `viewCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||||
| `viewOffset` | *Optional\<Integer>* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||
| `viewedLeafCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||
| `image` | List\<[GetRecentlyAddedImage](../../models/operations/GetRecentlyAddedImage.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `ultraBlurColors` | [Optional\<UltraBlurColors>](../../models/operations/UltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `media` | List\<[Media](../../models/operations/Media.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | List\<[Genre](../../models/operations/Genre.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `country` | List\<[Country](../../models/operations/Country.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `director` | List\<[Director](../../models/operations/Director.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | List\<[Writer](../../models/operations/Writer.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | List\<[Role](../../models/operations/Role.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `producer` | List\<[Producer](../../models/operations/Producer.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `rating1` | List\<[Rating](../../models/operations/Rating.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `similar` | List\<[Similar](../../models/operations/Similar.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `location` | List\<[Location](../../models/operations/Location.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | List\<[Guids](../../models/operations/Guids.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | List\<[Collection](../../models/operations/Collection.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -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 |
|
||||
@@ -1,5 +1,7 @@
|
||||
# HasThumbnail
|
||||
|
||||
Indicates if the part has a thumbnail.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
|
||||
11
docs/models/operations/Hidden.md
Normal file
11
docs/models/operations/Hidden.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Hidden
|
||||
|
||||
UNKNOWN
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
@@ -1,8 +1,10 @@
|
||||
# Location
|
||||
|
||||
The folder path for the media item.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
||||
| `path` | *Optional\<String>* | :heavy_minus_sign: | N/A | /TV Shows/House |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `path` | *String* | :heavy_check_mark: | N/A | /TV Shows/Clarkson's Farm |
|
||||
@@ -5,21 +5,22 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
|
||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 25025 |
|
||||
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 3840 |
|
||||
| `height` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2072 |
|
||||
| `aspectRatio` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 1.85 |
|
||||
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | N/A | dts |
|
||||
| `audioChannels` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `audioCodec` | *Optional\<String>* | :heavy_minus_sign: | N/A | eac3 |
|
||||
| `videoCodec` | *Optional\<String>* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `videoResolution` | *Optional\<String>* | :heavy_minus_sign: | N/A | 4k |
|
||||
| `container` | *String* | :heavy_check_mark: | N/A | mkv |
|
||||
| `videoFrameRate` | *Optional\<String>* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `hasVoiceActivity` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | [Optional\<OptimizedForStreaming>](../../models/operations/OptimizedForStreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `id` | *long* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||
| `height` | *Optional\<Integer>* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||
| `aspectRatio` | *Optional\<Float>* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||
| `audioChannels` | *Optional\<Integer>* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||
| `displayOffset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 50 |
|
||||
| `audioCodec` | *Optional\<String>* | :heavy_minus_sign: | Audio codec used. | eac3 |
|
||||
| `videoCodec` | *Optional\<String>* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||
| `videoResolution` | *Optional\<String>* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||
| `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 |
|
||||
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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
|
||||
|
||||
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 |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 119542 |
|
||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `file` | *String* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `size` | *long* | :heavy_check_mark: | N/A | 36158371307 |
|
||||
| `container` | *String* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
||||
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | N/A | dts |
|
||||
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `accessible` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||
| `exists` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||
| `id` | *long* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||
| `key` | *String* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||
| `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 |
|
||||
| `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
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
# PostMediaArtsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetOnDeckErrors](../../models/errors/GetOnDeckErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `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 |
|
||||
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
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
# PostMediaPosterResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetOnDeckLibraryErrors](../../models/errors/GetOnDeckLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `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 |
|
||||
@@ -3,11 +3,10 @@
|
||||
|
||||
## 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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `id` | *long* | :heavy_check_mark: | Unique identifier for the producer. | 126522 |
|
||||
| `filter` | *String* | :heavy_check_mark: | The filter string used to query this producer. | producer=126522 |
|
||||
| `tag` | *String* | :heavy_check_mark: | The name of the producer | Amelia Knapp |
|
||||
| `tagKey` | *Optional\<String>* | :heavy_minus_sign: | A unique key associated with the producer's tag, used for internal identification. | 5d77683d85719b001f3a535e |
|
||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | The URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.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
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *Optional\<Long>* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 |
|
||||
| `filter` | *Optional\<String>* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 |
|
||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
|
||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
|
||||
| `tagKey` | *Optional\<String>* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
|
||||
| `role` | *Optional\<String>* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *long* | :heavy_check_mark: | Unique identifier for the actor or role. | 126522 |
|
||||
| `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 |
|
||||
| `tag` | *String* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
|
||||
| `tagKey` | *Optional\<String>* | :heavy_minus_sign: | A unique key associated with the actor's tag, used for internal identification. | 5d77683d85719b001f3a535e |
|
||||
| `role` | *Optional\<String>* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
|
||||
| `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
|
||||
|
||||
The display tag for the similar item, typically the title.
|
||||
|
||||
|
||||
## 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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
|
||||
| `id` | *long* | :heavy_check_mark: | N/A | 259 |
|
||||
| `filter` | *String* | :heavy_check_mark: | N/A | similar=259 |
|
||||
| `tag` | *String* | :heavy_check_mark: | N/A | Criss Angel Mindfreak |
|
||||
@@ -3,43 +3,54 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `id` | *long* | :heavy_check_mark: | N/A | 272796 |
|
||||
| `streamType` | *long* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
|
||||
| `default_` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this is the default stream | true |
|
||||
| `selected` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream is selected | true |
|
||||
| `codec` | *String* | :heavy_check_mark: | Codec used by the stream | h264 |
|
||||
| `index` | *long* | :heavy_check_mark: | The index of the stream | 0 |
|
||||
| `bitrate` | *Optional\<Long>* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
|
||||
| `colorPrimaries` | *Optional\<String>* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
|
||||
| `colorRange` | *Optional\<String>* | :heavy_minus_sign: | The color range of the video stream | tv |
|
||||
| `colorSpace` | *Optional\<String>* | :heavy_minus_sign: | The color space of the video stream | bt709 |
|
||||
| `colorTrc` | *Optional\<String>* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
|
||||
| `bitDepth` | *Optional\<Long>* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
|
||||
| `chromaLocation` | *Optional\<String>* | :heavy_minus_sign: | The chroma location of the video stream | left |
|
||||
| `streamIdentifier` | *Optional\<String>* | :heavy_minus_sign: | The identifier of the video stream | 2 |
|
||||
| `chromaSubsampling` | *Optional\<String>* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
|
||||
| `codedHeight` | *Optional\<Long>* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
|
||||
| `codedWidth` | *Optional\<Long>* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
|
||||
| `frameRate` | *Optional\<Double>* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
|
||||
| `hasScalingMatrix` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
|
||||
| `hearingImpaired` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `closedCaptions` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `embeddedInVideo` | *Optional\<String>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `height` | *Optional\<Long>* | :heavy_minus_sign: | The height of the video stream | 1080 |
|
||||
| `level` | *Optional\<Long>* | :heavy_minus_sign: | The level of the video codec | 40 |
|
||||
| `profile` | *Optional\<String>* | :heavy_minus_sign: | The profile of the video codec | main |
|
||||
| `refFrames` | *Optional\<Long>* | :heavy_minus_sign: | Number of reference frames | 4 |
|
||||
| `scanType` | *Optional\<String>* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
|
||||
| `width` | *Optional\<Long>* | :heavy_minus_sign: | The width of the video stream | 1920 |
|
||||
| `displayTitle` | *Optional\<String>* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
|
||||
| `extendedDisplayTitle` | *Optional\<String>* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
|
||||
| `channels` | *Optional\<Long>* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
|
||||
| `language` | *Optional\<String>* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
|
||||
| `languageTag` | *Optional\<String>* | :heavy_minus_sign: | Language tag of the stream | en |
|
||||
| `languageCode` | *Optional\<String>* | :heavy_minus_sign: | Language code of the stream | eng |
|
||||
| `audioChannelLayout` | *Optional\<String>* | :heavy_minus_sign: | The audio channel layout | stereo |
|
||||
| `samplingRate` | *Optional\<Long>* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
|
||||
| `canAutoSync` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `id` | *long* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||
| `streamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
|
||||
| `default_` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *String* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *Optional\<String>* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `languageTag` | *Optional\<String>* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
| `languageCode` | *Optional\<String>* | :heavy_minus_sign: | ISO language code. | eng |
|
||||
| `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 |
|
||||
| `doviblPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||
| `dovielPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `doviLevel` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `doviPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `doviProfile` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpuPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `doviVersion` | *Optional\<String>* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bitDepth` | *Optional\<Integer>* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||
| `chromaLocation` | *Optional\<String>* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||
| `chromaSubsampling` | *Optional\<String>* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||
| `codedHeight` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `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 |
|
||||
| `colorRange` | *Optional\<String>* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `colorSpace` | *Optional\<String>* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
| `colorTrc` | *Optional\<String>* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frameRate` | *Optional\<Float>* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `height` | *Optional\<Integer>* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *Optional\<Integer>* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `hasScalingMatrix` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `profile` | *Optional\<String>* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `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 |
|
||||
| `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
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
||||
| `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.models.errors.GetTransientTokenBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetTransientTokenUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetTransientTokenQueryParamType;
|
||||
import dev.plexapi.sdk.models.operations.GetTransientTokenResponse;
|
||||
import dev.plexapi.sdk.models.operations.Scope;
|
||||
import dev.plexapi.sdk.models.operations.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -183,9 +181,7 @@ package hello.world;
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.PostUsersSignInDataBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.PostUsersSignInDataUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.PostUsersSignInDataRequest;
|
||||
import dev.plexapi.sdk.models.operations.PostUsersSignInDataRequestBody;
|
||||
import dev.plexapi.sdk.models.operations.PostUsersSignInDataResponse;
|
||||
import dev.plexapi.sdk.models.operations.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
|
||||
@@ -25,7 +25,6 @@ import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetGlobalHubsBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetGlobalHubsUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetGlobalHubsResponse;
|
||||
import dev.plexapi.sdk.models.operations.OnlyTransient;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -37,8 +36,6 @@ public class Application {
|
||||
.build();
|
||||
|
||||
GetGlobalHubsResponse res = sdk.hubs().getGlobalHubs()
|
||||
.count(1262.49d)
|
||||
.onlyTransient(OnlyTransient.ONE)
|
||||
.call();
|
||||
|
||||
if (res.object().isPresent()) {
|
||||
@@ -78,9 +75,7 @@ This endpoint will return the recently added content.
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.operations.GetRecentlyAddedRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetRecentlyAddedResponse;
|
||||
import dev.plexapi.sdk.models.operations.Type;
|
||||
import dev.plexapi.sdk.models.operations.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -138,7 +133,6 @@ import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetLibraryHubsBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetLibraryHubsUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetLibraryHubsResponse;
|
||||
import dev.plexapi.sdk.models.operations.QueryParamOnlyTransient;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -150,9 +144,7 @@ public class Application {
|
||||
.build();
|
||||
|
||||
GetLibraryHubsResponse res = sdk.hubs().getLibraryHubs()
|
||||
.sectionId(6728.76d)
|
||||
.count(6728.76d)
|
||||
.onlyTransient(QueryParamOnlyTransient.ZERO)
|
||||
.sectionId(6728.76)
|
||||
.call();
|
||||
|
||||
if (res.object().isPresent()) {
|
||||
|
||||
@@ -22,9 +22,12 @@ API Calls interacting with Plex Media Server Libraries
|
||||
* [getActorsLibrary](#getactorslibrary) - Get Actors of library media
|
||||
* [getSearchAllLibraries](#getsearchalllibraries) - Search All Libraries
|
||||
* [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
|
||||
* [getTopWatchedContent](#gettopwatchedcontent) - Get Top Watched Content
|
||||
* [getOnDeck](#getondeck) - Get On Deck
|
||||
|
||||
## getFileHash
|
||||
|
||||
@@ -51,7 +54,6 @@ public class Application {
|
||||
|
||||
GetFileHashResponse res = sdk.library().getFileHash()
|
||||
.url("file://C:\Image.png&type=13")
|
||||
.type(4462.17d)
|
||||
.call();
|
||||
|
||||
// handle response
|
||||
@@ -91,9 +93,7 @@ package hello.world;
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetRecentlyAddedLibraryBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetRecentlyAddedLibraryUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetRecentlyAddedLibraryRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetRecentlyAddedLibraryResponse;
|
||||
import dev.plexapi.sdk.models.operations.QueryParamType;
|
||||
import dev.plexapi.sdk.models.operations.*;
|
||||
import java.lang.Exception;
|
||||
import java.util.List;
|
||||
|
||||
@@ -256,7 +256,6 @@ import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetLibraryDetailsBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetLibraryDetailsUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetLibraryDetailsResponse;
|
||||
import dev.plexapi.sdk.models.operations.IncludeDetails;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -268,7 +267,6 @@ public class Application {
|
||||
.build();
|
||||
|
||||
GetLibraryDetailsResponse res = sdk.library().getLibraryDetails()
|
||||
.includeDetails(IncludeDetails.ZERO)
|
||||
.sectionKey(9518)
|
||||
.call();
|
||||
|
||||
@@ -381,10 +379,7 @@ package hello.world;
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetLibraryItemsBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetLibraryItemsUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetLibraryItemsQueryParamType;
|
||||
import dev.plexapi.sdk.models.operations.GetLibraryItemsRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetLibraryItemsResponse;
|
||||
import dev.plexapi.sdk.models.operations.Tag;
|
||||
import dev.plexapi.sdk.models.operations.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -443,9 +438,7 @@ package hello.world;
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetAllMediaLibraryBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetAllMediaLibraryUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetAllMediaLibraryQueryParamType;
|
||||
import dev.plexapi.sdk.models.operations.GetAllMediaLibraryRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetAllMediaLibraryResponse;
|
||||
import dev.plexapi.sdk.models.operations.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -798,9 +791,7 @@ package hello.world;
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetSearchAllLibrariesBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetSearchAllLibrariesUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetSearchAllLibrariesRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetSearchAllLibrariesResponse;
|
||||
import dev.plexapi.sdk.models.operations.SearchTypes;
|
||||
import dev.plexapi.sdk.models.operations.*;
|
||||
import java.lang.Exception;
|
||||
import java.util.List;
|
||||
|
||||
@@ -919,6 +910,200 @@ public class Application {
|
||||
| models/errors/GetMediaMetaDataUnauthorized | 401 | application/json |
|
||||
| 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;
|
||||
|
||||
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")
|
||||
.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;
|
||||
|
||||
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")
|
||||
.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
|
||||
|
||||
This endpoint will return the children of of a library item specified with the ratingKey.
|
||||
@@ -944,7 +1129,7 @@ public class Application {
|
||||
.build();
|
||||
|
||||
GetMetadataChildrenResponse res = sdk.library().getMetadataChildren()
|
||||
.ratingKey(1539.14d)
|
||||
.ratingKey(1539.14)
|
||||
.includeElements("Stream")
|
||||
.call();
|
||||
|
||||
@@ -1028,50 +1213,4 @@ public class Application {
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| models/errors/GetTopWatchedContentBadRequest | 400 | application/json |
|
||||
| models/errors/GetTopWatchedContentUnauthorized | 401 | application/json |
|
||||
| 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 | \*/\* |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
@@ -38,7 +38,7 @@ public class Application {
|
||||
.build();
|
||||
|
||||
MarkPlayedResponse res = sdk.media().markPlayed()
|
||||
.key(59398d)
|
||||
.key(59398)
|
||||
.call();
|
||||
|
||||
// handle response
|
||||
@@ -88,7 +88,7 @@ public class Application {
|
||||
.build();
|
||||
|
||||
MarkUnplayedResponse res = sdk.media().markUnplayed()
|
||||
.key(59398d)
|
||||
.key(59398)
|
||||
.call();
|
||||
|
||||
// handle response
|
||||
@@ -140,7 +140,7 @@ public class Application {
|
||||
|
||||
UpdatePlayProgressResponse res = sdk.media().updatePlayProgress()
|
||||
.key("<key>")
|
||||
.time(90000d)
|
||||
.time(90000)
|
||||
.state("played")
|
||||
.call();
|
||||
|
||||
|
||||
@@ -36,10 +36,7 @@ package hello.world;
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.CreatePlaylistBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.CreatePlaylistUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.CreatePlaylistQueryParamType;
|
||||
import dev.plexapi.sdk.models.operations.CreatePlaylistRequest;
|
||||
import dev.plexapi.sdk.models.operations.CreatePlaylistResponse;
|
||||
import dev.plexapi.sdk.models.operations.Smart;
|
||||
import dev.plexapi.sdk.models.operations.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -99,8 +96,6 @@ import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetPlaylistsBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetPlaylistsUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetPlaylistsResponse;
|
||||
import dev.plexapi.sdk.models.operations.PlaylistType;
|
||||
import dev.plexapi.sdk.models.operations.QueryParamSmart;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -112,8 +107,6 @@ public class Application {
|
||||
.build();
|
||||
|
||||
GetPlaylistsResponse res = sdk.playlists().getPlaylists()
|
||||
.playlistType(PlaylistType.AUDIO)
|
||||
.smart(QueryParamSmart.ZERO)
|
||||
.call();
|
||||
|
||||
if (res.object().isPresent()) {
|
||||
@@ -168,7 +161,7 @@ public class Application {
|
||||
.build();
|
||||
|
||||
GetPlaylistResponse res = sdk.playlists().getPlaylist()
|
||||
.playlistID(4109.48d)
|
||||
.playlistID(4109.48)
|
||||
.call();
|
||||
|
||||
if (res.object().isPresent()) {
|
||||
@@ -221,7 +214,7 @@ public class Application {
|
||||
.build();
|
||||
|
||||
DeletePlaylistResponse res = sdk.playlists().deletePlaylist()
|
||||
.playlistID(216.22d)
|
||||
.playlistID(216.22)
|
||||
.call();
|
||||
|
||||
// handle response
|
||||
@@ -272,9 +265,7 @@ public class Application {
|
||||
.build();
|
||||
|
||||
UpdatePlaylistResponse res = sdk.playlists().updatePlaylist()
|
||||
.playlistID(3915d)
|
||||
.title("<value>")
|
||||
.summary("<value>")
|
||||
.playlistID(3915)
|
||||
.call();
|
||||
|
||||
// handle response
|
||||
@@ -331,7 +322,7 @@ public class Application {
|
||||
.build();
|
||||
|
||||
GetPlaylistContentsResponse res = sdk.playlists().getPlaylistContents()
|
||||
.playlistID(5004.46d)
|
||||
.playlistID(5004.46)
|
||||
.type(GetPlaylistContentsQueryParamType.TvShow)
|
||||
.call();
|
||||
|
||||
@@ -386,7 +377,7 @@ public class Application {
|
||||
.build();
|
||||
|
||||
ClearPlaylistContentsResponse res = sdk.playlists().clearPlaylistContents()
|
||||
.playlistID(1893.18d)
|
||||
.playlistID(1893.18)
|
||||
.call();
|
||||
|
||||
// handle response
|
||||
@@ -438,9 +429,9 @@ public class Application {
|
||||
.build();
|
||||
|
||||
AddPlaylistContentsResponse res = sdk.playlists().addPlaylistContents()
|
||||
.playlistID(8502.01d)
|
||||
.playlistID(8502.01)
|
||||
.uri("server://12345/com.plexapp.plugins.library/library/metadata/1")
|
||||
.playQueueID(123d)
|
||||
.playQueueID(123)
|
||||
.call();
|
||||
|
||||
if (res.object().isPresent()) {
|
||||
|
||||
@@ -226,9 +226,6 @@ import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetServerResourcesBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetServerResourcesUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetServerResourcesResponse;
|
||||
import dev.plexapi.sdk.models.operations.IncludeHttps;
|
||||
import dev.plexapi.sdk.models.operations.IncludeIPv6;
|
||||
import dev.plexapi.sdk.models.operations.IncludeRelay;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -240,9 +237,6 @@ public class Application {
|
||||
.build();
|
||||
|
||||
GetServerResourcesResponse res = sdk.plex().getServerResources()
|
||||
.includeHttps(IncludeHttps.Enable)
|
||||
.includeRelay(IncludeRelay.Enable)
|
||||
.includeIPv6(IncludeIPv6.Enable)
|
||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||
.call();
|
||||
|
||||
|
||||
@@ -49,8 +49,6 @@ public class Application {
|
||||
|
||||
PerformSearchResponse res = sdk.search().performSearch()
|
||||
.query("dylan")
|
||||
.sectionId(9487.88d)
|
||||
.limit(5d)
|
||||
.call();
|
||||
|
||||
// handle response
|
||||
@@ -107,8 +105,6 @@ public class Application {
|
||||
|
||||
PerformVoiceSearchResponse res = sdk.search().performVoiceSearch()
|
||||
.query("dead+poop")
|
||||
.sectionId(4094.8d)
|
||||
.limit(5d)
|
||||
.call();
|
||||
|
||||
// handle response
|
||||
|
||||
@@ -298,10 +298,7 @@ package hello.world;
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetResizedPhotoBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetResizedPhotoUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetResizedPhotoRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetResizedPhotoResponse;
|
||||
import dev.plexapi.sdk.models.operations.MinSize;
|
||||
import dev.plexapi.sdk.models.operations.Upscale;
|
||||
import dev.plexapi.sdk.models.operations.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -313,10 +310,10 @@ public class Application {
|
||||
.build();
|
||||
|
||||
GetResizedPhotoRequest req = GetResizedPhotoRequest.builder()
|
||||
.width(110d)
|
||||
.height(165d)
|
||||
.width(110)
|
||||
.height(165)
|
||||
.opacity(100L)
|
||||
.blur(0d)
|
||||
.blur(0)
|
||||
.minSize(MinSize.ONE)
|
||||
.upscale(Upscale.ONE)
|
||||
.url("/library/metadata/49564/thumb/1654258204")
|
||||
|
||||
@@ -122,9 +122,7 @@ package hello.world;
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.ApplyUpdatesBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.ApplyUpdatesUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.ApplyUpdatesResponse;
|
||||
import dev.plexapi.sdk.models.operations.Skip;
|
||||
import dev.plexapi.sdk.models.operations.Tonight;
|
||||
import dev.plexapi.sdk.models.operations.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
|
||||
@@ -23,9 +23,7 @@ package hello.world;
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetTimelineBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetTimelineUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetTimelineRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetTimelineResponse;
|
||||
import dev.plexapi.sdk.models.operations.State;
|
||||
import dev.plexapi.sdk.models.operations.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -37,16 +35,16 @@ public class Application {
|
||||
.build();
|
||||
|
||||
GetTimelineRequest req = GetTimelineRequest.builder()
|
||||
.ratingKey(23409d)
|
||||
.ratingKey(23409)
|
||||
.key("/library/metadata/23409")
|
||||
.state(State.PLAYING)
|
||||
.hasMDE(1d)
|
||||
.time(2000d)
|
||||
.duration(10000d)
|
||||
.hasMDE(1)
|
||||
.time(2000)
|
||||
.duration(10000)
|
||||
.context("home:hub.continueWatching")
|
||||
.playQueueItemID(1d)
|
||||
.playBackTime(2000d)
|
||||
.row(1d)
|
||||
.playQueueItemID(1)
|
||||
.playBackTime(2000)
|
||||
.row(1)
|
||||
.build();
|
||||
|
||||
GetTimelineResponse res = sdk.video().getTimeline()
|
||||
@@ -101,22 +99,22 @@ public class Application {
|
||||
.build();
|
||||
|
||||
StartUniversalTranscodeRequest req = StartUniversalTranscodeRequest.builder()
|
||||
.hasMDE(1d)
|
||||
.hasMDE(1)
|
||||
.path("/library/metadata/23409")
|
||||
.mediaIndex(0d)
|
||||
.partIndex(0d)
|
||||
.mediaIndex(0)
|
||||
.partIndex(0)
|
||||
.protocol("hls")
|
||||
.fastSeek(0d)
|
||||
.directPlay(0d)
|
||||
.directStream(0d)
|
||||
.subtitleSize(100d)
|
||||
.fastSeek(0)
|
||||
.directPlay(0)
|
||||
.directStream(0)
|
||||
.subtitleSize(100)
|
||||
.subtites("burn")
|
||||
.audioBoost(100d)
|
||||
.audioBoost(100)
|
||||
.location("lan")
|
||||
.mediaBufferSize(102400d)
|
||||
.mediaBufferSize(102400)
|
||||
.session("zvcage8b7rkioqcm8f4uns4c")
|
||||
.addDebugOverlay(0d)
|
||||
.autoAdjustQuality(0d)
|
||||
.addDebugOverlay(0)
|
||||
.autoAdjustQuality(0)
|
||||
.build();
|
||||
|
||||
StartUniversalTranscodeResponse res = sdk.video().startUniversalTranscode()
|
||||
|
||||
@@ -22,9 +22,7 @@ package hello.world;
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetWatchListBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetWatchListUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.Filter;
|
||||
import dev.plexapi.sdk.models.operations.GetWatchListRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetWatchListResponse;
|
||||
import dev.plexapi.sdk.models.operations.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
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.2
|
||||
@@ -1,7 +1,6 @@
|
||||
/*
|
||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
*/
|
||||
|
||||
package dev.plexapi.sdk;
|
||||
|
||||
import com.fasterxml.jackson.core.type.TypeReference;
|
||||
@@ -29,7 +28,7 @@ import java.lang.String;
|
||||
import java.net.http.HttpRequest;
|
||||
import java.net.http.HttpResponse;
|
||||
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.
|
||||
@@ -39,7 +38,6 @@ import java.util.Optional;
|
||||
* - 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.)
|
||||
* - The may contain a `Response` object which attributes which represent the result of the asynchronous operation.
|
||||
*
|
||||
*/
|
||||
public class Activities implements
|
||||
MethodCallGetServerActivities,
|
||||
@@ -54,7 +52,9 @@ public class Activities implements
|
||||
|
||||
/**
|
||||
* Get Server Activities
|
||||
* Get Server Activities
|
||||
*
|
||||
* <p>Get Server Activities
|
||||
*
|
||||
* @return The call builder
|
||||
*/
|
||||
public GetServerActivitiesRequestBuilder getServerActivities() {
|
||||
@@ -63,7 +63,9 @@ public class Activities implements
|
||||
|
||||
/**
|
||||
* Get Server Activities
|
||||
* Get Server Activities
|
||||
*
|
||||
* <p>Get Server Activities
|
||||
*
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
*/
|
||||
@@ -87,6 +89,7 @@ public class Activities implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"getServerActivities",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -98,6 +101,7 @@ public class Activities implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getServerActivities",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -107,6 +111,7 @@ public class Activities implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"getServerActivities",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -116,6 +121,7 @@ public class Activities implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getServerActivities",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -209,7 +215,9 @@ public class Activities implements
|
||||
|
||||
/**
|
||||
* Cancel Server Activities
|
||||
* Cancel Server Activities
|
||||
*
|
||||
* <p>Cancel Server Activities
|
||||
*
|
||||
* @return The call builder
|
||||
*/
|
||||
public CancelServerActivitiesRequestBuilder cancelServerActivities() {
|
||||
@@ -218,7 +226,9 @@ public class Activities implements
|
||||
|
||||
/**
|
||||
* Cancel Server Activities
|
||||
* Cancel Server Activities
|
||||
*
|
||||
* <p>Cancel Server Activities
|
||||
*
|
||||
* @param activityUUID The UUID of the activity to cancel.
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
@@ -252,6 +262,7 @@ public class Activities implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"cancelServerActivities",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -263,6 +274,7 @@ public class Activities implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"cancelServerActivities",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -272,6 +284,7 @@ public class Activities implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"cancelServerActivities",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -281,6 +294,7 @@ public class Activities implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"cancelServerActivities",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
/*
|
||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
*/
|
||||
|
||||
package dev.plexapi.sdk;
|
||||
|
||||
import com.fasterxml.jackson.core.type.TypeReference;
|
||||
@@ -46,11 +45,10 @@ import java.net.http.HttpRequest;
|
||||
import java.net.http.HttpResponse;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Optional;
|
||||
import java.util.Optional;
|
||||
|
||||
/**
|
||||
* API Calls regarding authentication for Plex Media Server
|
||||
*
|
||||
*/
|
||||
public class Authentication implements
|
||||
MethodCallGetTransientToken,
|
||||
@@ -81,7 +79,8 @@ public class Authentication implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
@@ -91,7 +90,8 @@ public class Authentication implements
|
||||
|
||||
/**
|
||||
* 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 scope `all` - This is the only supported `scope` parameter.
|
||||
@@ -132,6 +132,7 @@ public class Authentication implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"getTransientToken",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -143,6 +144,7 @@ public class Authentication implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getTransientToken",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -152,6 +154,7 @@ public class Authentication implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"getTransientToken",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -161,6 +164,7 @@ public class Authentication implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getTransientToken",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -243,7 +247,8 @@ public class Authentication implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @return The call builder
|
||||
@@ -254,7 +259,8 @@ public class Authentication implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @param source The source identifier with an included prefix.
|
||||
@@ -293,6 +299,7 @@ public class Authentication implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"getSourceConnectionInformation",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -304,6 +311,7 @@ public class Authentication implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getSourceConnectionInformation",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -313,6 +321,7 @@ public class Authentication implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"getSourceConnectionInformation",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -322,6 +331,7 @@ public class Authentication implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getSourceConnectionInformation",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -404,7 +414,9 @@ public class Authentication implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
public GetTokenDetailsRequestBuilder getTokenDetails() {
|
||||
@@ -413,7 +425,9 @@ public class Authentication implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @throws Exception if the API call fails
|
||||
*/
|
||||
@@ -423,16 +437,20 @@ public class Authentication implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
*/
|
||||
public GetTokenDetailsResponse getTokenDetails(
|
||||
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()) {
|
||||
_baseUrl = serverURL.get();
|
||||
} else {
|
||||
_baseUrl = Utils.templateUrl(GET_TOKEN_DETAILS_SERVERS[0], new HashMap<String, String>());
|
||||
}
|
||||
String _url = Utils.generateURL(
|
||||
_baseUrl,
|
||||
@@ -451,6 +469,7 @@ public class Authentication implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"getTokenDetails",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -462,6 +481,7 @@ public class Authentication implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getTokenDetails",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -471,6 +491,7 @@ public class Authentication implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"getTokenDetails",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -480,6 +501,7 @@ public class Authentication implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getTokenDetails",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -573,7 +595,9 @@ public class Authentication implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
public PostUsersSignInDataRequestBuilder postUsersSignInData() {
|
||||
@@ -582,7 +606,9 @@ public class Authentication implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
@@ -594,7 +620,9 @@ public class Authentication implements
|
||||
|
||||
/**
|
||||
* 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 serverURL Overrides the server URL.
|
||||
* @return The response from the API call
|
||||
@@ -603,9 +631,11 @@ public class Authentication implements
|
||||
public PostUsersSignInDataResponse postUsersSignInData(
|
||||
PostUsersSignInDataRequest request,
|
||||
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()) {
|
||||
_baseUrl = serverURL.get();
|
||||
} else {
|
||||
_baseUrl = Utils.templateUrl(POST_USERS_SIGN_IN_DATA_SERVERS[0], new HashMap<String, String>());
|
||||
}
|
||||
String _url = Utils.generateURL(
|
||||
_baseUrl,
|
||||
@@ -632,6 +662,7 @@ public class Authentication implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"post-users-sign-in-data",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -643,6 +674,7 @@ public class Authentication implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"post-users-sign-in-data",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -652,6 +684,7 @@ public class Authentication implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"post-users-sign-in-data",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -661,6 +694,7 @@ public class Authentication implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"post-users-sign-in-data",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
/*
|
||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
*/
|
||||
|
||||
package dev.plexapi.sdk;
|
||||
|
||||
import com.fasterxml.jackson.core.type.TypeReference;
|
||||
@@ -44,11 +43,10 @@ import java.lang.String;
|
||||
import java.net.http.HttpRequest;
|
||||
import java.net.http.HttpResponse;
|
||||
import java.util.List;
|
||||
import java.util.Optional;
|
||||
import java.util.Optional;
|
||||
|
||||
/**
|
||||
* Butler is the task manager of the Plex Media Server Ecosystem.
|
||||
*
|
||||
*/
|
||||
public class Butler implements
|
||||
MethodCallGetButlerTasks,
|
||||
@@ -66,7 +64,9 @@ public class Butler implements
|
||||
|
||||
/**
|
||||
* Get Butler tasks
|
||||
* Returns a list of butler tasks
|
||||
*
|
||||
* <p>Returns a list of butler tasks
|
||||
*
|
||||
* @return The call builder
|
||||
*/
|
||||
public GetButlerTasksRequestBuilder getButlerTasks() {
|
||||
@@ -75,7 +75,9 @@ public class Butler implements
|
||||
|
||||
/**
|
||||
* Get Butler tasks
|
||||
* Returns a list of butler tasks
|
||||
*
|
||||
* <p>Returns a list of butler tasks
|
||||
*
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
*/
|
||||
@@ -99,6 +101,7 @@ public class Butler implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"getButlerTasks",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -110,6 +113,7 @@ public class Butler implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getButlerTasks",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -119,6 +123,7 @@ public class Butler implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"getButlerTasks",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -128,6 +133,7 @@ public class Butler implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getButlerTasks",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -221,7 +227,8 @@ public class Butler implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -235,7 +242,8 @@ public class Butler implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -264,6 +272,7 @@ public class Butler implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"startAllTasks",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -275,6 +284,7 @@ public class Butler implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"startAllTasks",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -284,6 +294,7 @@ public class Butler implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"startAllTasks",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -293,6 +304,7 @@ public class Butler implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"startAllTasks",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -375,7 +387,8 @@ public class Butler implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
@@ -385,7 +398,8 @@ public class Butler implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @throws Exception if the API call fails
|
||||
@@ -410,6 +424,7 @@ public class Butler implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"stopAllTasks",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -421,6 +436,7 @@ public class Butler implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"stopAllTasks",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -430,6 +446,7 @@ public class Butler implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"stopAllTasks",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -439,6 +456,7 @@ public class Butler implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"stopAllTasks",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -521,7 +539,8 @@ public class Butler implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -535,7 +554,8 @@ public class Butler implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -574,6 +594,7 @@ public class Butler implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"startTask",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -585,6 +606,7 @@ public class Butler implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"startTask",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -594,6 +616,7 @@ public class Butler implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"startTask",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -603,6 +626,7 @@ public class Butler implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"startTask",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -685,7 +709,8 @@ public class Butler implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
@@ -695,7 +720,8 @@ public class Butler implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* @return The response from the API call
|
||||
@@ -730,6 +756,7 @@ public class Butler implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"stopTask",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -741,6 +768,7 @@ public class Butler implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"stopTask",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -750,6 +778,7 @@ public class Butler implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"stopTask",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -759,6 +788,7 @@ public class Butler implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"stopTask",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
/*
|
||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
*/
|
||||
|
||||
package dev.plexapi.sdk;
|
||||
|
||||
import com.fasterxml.jackson.core.type.TypeReference;
|
||||
@@ -38,11 +37,10 @@ import java.lang.String;
|
||||
import java.net.http.HttpRequest;
|
||||
import java.net.http.HttpResponse;
|
||||
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.
|
||||
*
|
||||
*/
|
||||
public class Hubs implements
|
||||
MethodCallGetGlobalHubs,
|
||||
@@ -58,7 +56,9 @@ public class Hubs implements
|
||||
|
||||
/**
|
||||
* Get Global Hubs
|
||||
* Get Global Hubs filtered by the parameters provided.
|
||||
*
|
||||
* <p>Get Global Hubs filtered by the parameters provided.
|
||||
*
|
||||
* @return The call builder
|
||||
*/
|
||||
public GetGlobalHubsRequestBuilder getGlobalHubs() {
|
||||
@@ -67,7 +67,9 @@ public class Hubs implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @throws Exception if the API call fails
|
||||
*/
|
||||
@@ -77,7 +79,9 @@ public class Hubs implements
|
||||
|
||||
/**
|
||||
* 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 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
|
||||
@@ -117,6 +121,7 @@ public class Hubs implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"getGlobalHubs",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -128,6 +133,7 @@ public class Hubs implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getGlobalHubs",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -137,6 +143,7 @@ public class Hubs implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"getGlobalHubs",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -146,6 +153,7 @@ public class Hubs implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getGlobalHubs",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -239,7 +247,8 @@ public class Hubs implements
|
||||
|
||||
/**
|
||||
* Get Recently Added
|
||||
* This endpoint will return the recently added content.
|
||||
*
|
||||
* <p>This endpoint will return the recently added content.
|
||||
*
|
||||
* @return The call builder
|
||||
*/
|
||||
@@ -249,7 +258,8 @@ public class Hubs implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* @return The response from the API call
|
||||
@@ -281,6 +291,7 @@ public class Hubs implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"get-recently-added",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -292,6 +303,7 @@ public class Hubs implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"get-recently-added",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -301,6 +313,7 @@ public class Hubs implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"get-recently-added",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -310,6 +323,7 @@ public class Hubs implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"get-recently-added",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -371,7 +385,8 @@ public class Hubs implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
@@ -381,7 +396,8 @@ public class Hubs implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @return The response from the API call
|
||||
@@ -394,7 +410,8 @@ public class Hubs implements
|
||||
|
||||
/**
|
||||
* 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 count The number of items to return with each hub.
|
||||
@@ -440,6 +457,7 @@ public class Hubs implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"getLibraryHubs",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -451,6 +469,7 @@ public class Hubs implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getLibraryHubs",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -460,6 +479,7 @@ public class Hubs implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"getLibraryHubs",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -469,6 +489,7 @@ public class Hubs implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getLibraryHubs",
|
||||
Optional.of(List.of()),
|
||||
_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.
|
||||
*/
|
||||
|
||||
package dev.plexapi.sdk;
|
||||
|
||||
import com.fasterxml.jackson.core.type.TypeReference;
|
||||
@@ -36,11 +35,10 @@ import java.lang.String;
|
||||
import java.net.http.HttpRequest;
|
||||
import java.net.http.HttpResponse;
|
||||
import java.util.List;
|
||||
import java.util.Optional;
|
||||
import java.util.Optional;
|
||||
|
||||
/**
|
||||
* Submit logs to the Log Handler for Plex Media Server
|
||||
*
|
||||
*/
|
||||
public class Log implements
|
||||
MethodCallLogLine,
|
||||
@@ -56,7 +54,8 @@ public class Log implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
@@ -66,15 +65,16 @@ public class Log implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
0: Error
|
||||
1: Warning
|
||||
2: Info
|
||||
3: Debug
|
||||
4: Verbose
|
||||
|
||||
* 0: Error
|
||||
* 1: Warning
|
||||
* 2: Info
|
||||
* 3: Debug
|
||||
* 4: Verbose
|
||||
*
|
||||
* @param message The text of the message to write to the log.
|
||||
* @param source a string indicating the source of the message.
|
||||
* @return The response from the API call
|
||||
@@ -116,6 +116,7 @@ public class Log implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"logLine",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -127,6 +128,7 @@ public class Log implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"logLine",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -136,6 +138,7 @@ public class Log implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"logLine",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -145,6 +148,7 @@ public class Log implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"logLine",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -227,27 +231,28 @@ public class Log implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
* - `1`: Warning - Important events that are not critical but may indicate potential issues.
|
||||
* - `2`: Info - General informational messages about system operation.
|
||||
* - `3`: Debug - Detailed information useful for debugging purposes.
|
||||
* - `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`
|
||||
*
|
||||
* 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
|
||||
*/
|
||||
@@ -257,27 +262,28 @@ public class Log implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
* - `1`: Warning - Important events that are not critical but may indicate potential issues.
|
||||
* - `2`: Info - General informational messages about system operation.
|
||||
* - `3`: Debug - Detailed information useful for debugging purposes.
|
||||
* - `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`
|
||||
*
|
||||
* 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.
|
||||
* @return The response from the API call
|
||||
@@ -317,6 +323,7 @@ public class Log implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"logMultiLine",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -328,6 +335,7 @@ public class Log implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"logMultiLine",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -337,6 +345,7 @@ public class Log implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"logMultiLine",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -346,6 +355,7 @@ public class Log implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"logMultiLine",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -428,7 +438,8 @@ public class Log implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
@@ -438,7 +449,8 @@ public class Log implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @throws Exception if the API call fails
|
||||
@@ -463,6 +475,7 @@ public class Log implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"enablePaperTrail",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -474,6 +487,7 @@ public class Log implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"enablePaperTrail",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -483,6 +497,7 @@ public class Log implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"enablePaperTrail",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -492,6 +507,7 @@ public class Log implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"enablePaperTrail",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
/*
|
||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
*/
|
||||
|
||||
package dev.plexapi.sdk;
|
||||
|
||||
import com.fasterxml.jackson.core.type.TypeReference;
|
||||
@@ -44,11 +43,10 @@ import java.lang.String;
|
||||
import java.net.http.HttpRequest;
|
||||
import java.net.http.HttpResponse;
|
||||
import java.util.List;
|
||||
import java.util.Optional;
|
||||
import java.util.Optional;
|
||||
|
||||
/**
|
||||
* API Calls interacting with Plex Media Server Media
|
||||
*
|
||||
*/
|
||||
public class Media implements
|
||||
MethodCallMarkPlayed,
|
||||
@@ -66,7 +64,9 @@ public class Media implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
public MarkPlayedRequestBuilder markPlayed() {
|
||||
@@ -75,7 +75,9 @@ public class Media implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
@@ -112,6 +114,7 @@ public class Media implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"markPlayed",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -123,6 +126,7 @@ public class Media implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"markPlayed",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -132,6 +136,7 @@ public class Media implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"markPlayed",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -141,6 +146,7 @@ public class Media implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"markPlayed",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -223,7 +229,9 @@ public class Media implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
public MarkUnplayedRequestBuilder markUnplayed() {
|
||||
@@ -232,7 +240,9 @@ public class Media implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
@@ -269,6 +279,7 @@ public class Media implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"markUnplayed",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -280,6 +291,7 @@ public class Media implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"markUnplayed",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -289,6 +301,7 @@ public class Media implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"markUnplayed",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -298,6 +311,7 @@ public class Media implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"markUnplayed",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -380,7 +394,8 @@ public class Media implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
@@ -390,7 +405,8 @@ public class Media implements
|
||||
|
||||
/**
|
||||
* 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 time The time, in milliseconds, used to set the media playback progress.
|
||||
@@ -434,6 +450,7 @@ public class Media implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"updatePlayProgress",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -445,6 +462,7 @@ public class Media implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"updatePlayProgress",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -454,6 +472,7 @@ public class Media implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"updatePlayProgress",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -463,6 +482,7 @@ public class Media implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"updatePlayProgress",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -545,7 +565,9 @@ public class Media implements
|
||||
|
||||
/**
|
||||
* Get Banner Image
|
||||
* Gets the banner image of the media item
|
||||
*
|
||||
* <p>Gets the banner image of the media item
|
||||
*
|
||||
* @return The call builder
|
||||
*/
|
||||
public GetBannerImageRequestBuilder getBannerImage() {
|
||||
@@ -554,7 +576,9 @@ public class Media implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
@@ -588,6 +612,7 @@ public class Media implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"get-banner-image",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -599,6 +624,7 @@ public class Media implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"get-banner-image",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -608,6 +634,7 @@ public class Media implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"get-banner-image",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -617,6 +644,7 @@ public class Media implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"get-banner-image",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -710,7 +738,9 @@ public class Media implements
|
||||
|
||||
/**
|
||||
* Get Thumb Image
|
||||
* Gets the thumbnail image of the media item
|
||||
*
|
||||
* <p>Gets the thumbnail image of the media item
|
||||
*
|
||||
* @return The call builder
|
||||
*/
|
||||
public GetThumbImageRequestBuilder getThumbImage() {
|
||||
@@ -719,7 +749,9 @@ public class Media implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
@@ -753,6 +785,7 @@ public class Media implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"get-thumb-image",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -764,6 +797,7 @@ public class Media implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"get-thumb-image",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -773,6 +807,7 @@ public class Media implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"get-thumb-image",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -782,6 +817,7 @@ public class Media implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"get-thumb-image",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
/*
|
||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
*/
|
||||
|
||||
package dev.plexapi.sdk;
|
||||
|
||||
import com.fasterxml.jackson.core.type.TypeReference;
|
||||
@@ -74,14 +73,13 @@ import java.lang.String;
|
||||
import java.net.http.HttpRequest;
|
||||
import java.net.http.HttpResponse;
|
||||
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").
|
||||
* They can be organized in (optionally nesting) folders.
|
||||
* Retrieving a playlist, or its items, will trigger a refresh of its metadata.
|
||||
* This may cause the duration and number of items to change.
|
||||
*
|
||||
*/
|
||||
public class Playlists implements
|
||||
MethodCallCreatePlaylist,
|
||||
@@ -103,7 +101,8 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* 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`).
|
||||
* - `playQueueID` - To create a playlist from an existing play queue.
|
||||
*
|
||||
@@ -115,7 +114,8 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* 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`).
|
||||
* - `playQueueID` - To create a playlist from an existing play queue.
|
||||
*
|
||||
@@ -149,6 +149,7 @@ public class Playlists implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"createPlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -160,6 +161,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"createPlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -169,6 +171,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"createPlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -178,6 +181,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"createPlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -271,7 +275,9 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* Get All Playlists
|
||||
* Get All Playlists given the specified filters.
|
||||
*
|
||||
* <p>Get All Playlists given the specified filters.
|
||||
*
|
||||
* @return The call builder
|
||||
*/
|
||||
public GetPlaylistsRequestBuilder getPlaylists() {
|
||||
@@ -280,7 +286,9 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @throws Exception if the API call fails
|
||||
*/
|
||||
@@ -290,7 +298,9 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* 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 smart type of playlists to return (default is all).
|
||||
* @return The response from the API call
|
||||
@@ -330,6 +340,7 @@ public class Playlists implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"getPlaylists",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -341,6 +352,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getPlaylists",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -350,6 +362,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"getPlaylists",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -359,6 +372,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getPlaylists",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -452,7 +466,8 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @return The call builder
|
||||
@@ -463,7 +478,8 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @param playlistID the ID of the playlist
|
||||
@@ -499,6 +515,7 @@ public class Playlists implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"getPlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -510,6 +527,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getPlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -519,6 +537,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"getPlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -528,6 +547,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getPlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -621,7 +641,8 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* Deletes a Playlist
|
||||
* This endpoint will delete a playlist
|
||||
*
|
||||
* <p>This endpoint will delete a playlist
|
||||
*
|
||||
* @return The call builder
|
||||
*/
|
||||
@@ -631,7 +652,8 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* Deletes a Playlist
|
||||
* This endpoint will delete a playlist
|
||||
*
|
||||
* <p>This endpoint will delete a playlist
|
||||
*
|
||||
* @param playlistID the ID of the playlist
|
||||
* @return The response from the API call
|
||||
@@ -666,6 +688,7 @@ public class Playlists implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"deletePlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -677,6 +700,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"deletePlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -686,6 +710,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"deletePlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -695,6 +720,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"deletePlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -777,7 +803,8 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
@@ -787,7 +814,8 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @return The response from the API call
|
||||
@@ -800,7 +828,8 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* 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 title name of the playlist
|
||||
@@ -846,6 +875,7 @@ public class Playlists implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"updatePlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -857,6 +887,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"updatePlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -866,6 +897,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"updatePlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -875,6 +907,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"updatePlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -957,7 +990,8 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -970,19 +1004,20 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* 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.
|
||||
*
|
||||
* @param playlistID the ID of the playlist
|
||||
* @param type The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
* 1 = movie
|
||||
* 2 = show
|
||||
* 3 = season
|
||||
* 4 = episode
|
||||
* 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
|
||||
* @throws Exception if the API call fails
|
||||
*/
|
||||
@@ -1022,6 +1057,7 @@ public class Playlists implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"getPlaylistContents",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1033,6 +1069,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getPlaylistContents",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1042,6 +1079,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"getPlaylistContents",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1051,6 +1089,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getPlaylistContents",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1144,7 +1183,8 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
@@ -1154,7 +1194,8 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @return The response from the API call
|
||||
@@ -1189,6 +1230,7 @@ public class Playlists implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"clearPlaylistContents",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1200,6 +1242,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"clearPlaylistContents",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1209,6 +1252,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"clearPlaylistContents",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1218,6 +1262,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"clearPlaylistContents",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1300,7 +1345,8 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @return The call builder
|
||||
@@ -1311,7 +1357,8 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @param playlistID the ID of the playlist
|
||||
@@ -1327,7 +1374,8 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @param playlistID the ID of the playlist
|
||||
@@ -1374,6 +1422,7 @@ public class Playlists implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"addPlaylistContents",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1385,6 +1434,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"addPlaylistContents",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1394,6 +1444,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"addPlaylistContents",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1403,6 +1454,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"addPlaylistContents",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1496,7 +1548,8 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
@@ -1506,20 +1559,21 @@ public class Playlists implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
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.
|
||||
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.
|
||||
The GUID of each playlist is based on the filename.
|
||||
|
||||
* 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.
|
||||
* 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.
|
||||
* The GUID of each playlist is based on the filename.
|
||||
*
|
||||
* @param force Force overwriting of duplicate playlists.
|
||||
By default, a playlist file uploaded with the same path will overwrite the existing playlist.
|
||||
The `force` argument is used to disable overwriting.
|
||||
If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.
|
||||
|
||||
* By default, a playlist file uploaded with the same path will overwrite the existing playlist.
|
||||
* The `force` argument is used to disable overwriting.
|
||||
* If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.
|
||||
*
|
||||
* @param sectionID Possibly the section ID to upload the playlist to, we are not certain.
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
@@ -1560,6 +1614,7 @@ public class Playlists implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"uploadPlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1571,6 +1626,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"uploadPlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1580,6 +1636,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"uploadPlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1589,6 +1646,7 @@ public class Playlists implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"uploadPlaylist",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
/*
|
||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
*/
|
||||
|
||||
package dev.plexapi.sdk;
|
||||
|
||||
import com.fasterxml.jackson.core.type.TypeReference;
|
||||
@@ -60,11 +59,10 @@ import java.net.http.HttpRequest;
|
||||
import java.net.http.HttpResponse;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Optional;
|
||||
import java.util.Optional;
|
||||
|
||||
/**
|
||||
* API Calls that perform operations directly against https://Plex.tv
|
||||
*
|
||||
*/
|
||||
public class Plex implements
|
||||
MethodCallGetCompanionsData,
|
||||
@@ -126,7 +124,9 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* Get Companions Data
|
||||
* Get Companions Data
|
||||
*
|
||||
* <p>Get Companions Data
|
||||
*
|
||||
* @return The call builder
|
||||
*/
|
||||
public GetCompanionsDataRequestBuilder getCompanionsData() {
|
||||
@@ -135,7 +135,9 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* Get Companions Data
|
||||
* Get Companions Data
|
||||
*
|
||||
* <p>Get Companions Data
|
||||
*
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
*/
|
||||
@@ -145,16 +147,20 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* Get Companions Data
|
||||
* Get Companions Data
|
||||
*
|
||||
* <p>Get Companions Data
|
||||
*
|
||||
* @param serverURL Overrides the server URL.
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
*/
|
||||
public GetCompanionsDataResponse getCompanionsData(
|
||||
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()) {
|
||||
_baseUrl = serverURL.get();
|
||||
} else {
|
||||
_baseUrl = Utils.templateUrl(GET_COMPANIONS_DATA_SERVERS[0], new HashMap<String, String>());
|
||||
}
|
||||
String _url = Utils.generateURL(
|
||||
_baseUrl,
|
||||
@@ -173,6 +179,7 @@ public class Plex implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"getCompanionsData",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -184,6 +191,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getCompanionsData",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -193,6 +201,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"getCompanionsData",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -202,6 +211,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getCompanionsData",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -295,7 +305,9 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
public GetUserFriendsRequestBuilder getUserFriends() {
|
||||
@@ -304,7 +316,9 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @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 friends of provided auth token.
|
||||
*
|
||||
* <p>Get friends of provided auth token.
|
||||
*
|
||||
* @param serverURL Overrides the server URL.
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
*/
|
||||
public GetUserFriendsResponse getUserFriends(
|
||||
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()) {
|
||||
_baseUrl = serverURL.get();
|
||||
} else {
|
||||
_baseUrl = Utils.templateUrl(GET_USER_FRIENDS_SERVERS[0], new HashMap<String, String>());
|
||||
}
|
||||
String _url = Utils.generateURL(
|
||||
_baseUrl,
|
||||
@@ -342,6 +360,7 @@ public class Plex implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"getUserFriends",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -353,6 +372,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getUserFriends",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -362,6 +382,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"getUserFriends",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -371,6 +392,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getUserFriends",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -464,7 +486,9 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
public GetGeoDataRequestBuilder getGeoData() {
|
||||
@@ -473,7 +497,9 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @throws Exception if the API call fails
|
||||
*/
|
||||
@@ -483,16 +509,20 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
*/
|
||||
public GetGeoDataResponse getGeoData(
|
||||
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()) {
|
||||
_baseUrl = serverURL.get();
|
||||
} else {
|
||||
_baseUrl = Utils.templateUrl(GET_GEO_DATA_SERVERS[0], new HashMap<String, String>());
|
||||
}
|
||||
String _url = Utils.generateURL(
|
||||
_baseUrl,
|
||||
@@ -508,6 +538,7 @@ public class Plex implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"getGeoData",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -519,6 +550,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getGeoData",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -528,6 +560,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"getGeoData",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -537,6 +570,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getGeoData",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -630,7 +664,9 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
public GetHomeDataRequestBuilder getHomeData() {
|
||||
@@ -639,7 +675,9 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @throws Exception if the API call fails
|
||||
*/
|
||||
@@ -663,6 +701,7 @@ public class Plex implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"getHomeData",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -674,6 +713,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getHomeData",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -683,6 +723,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"getHomeData",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -692,6 +733,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getHomeData",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -785,7 +827,9 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* Get Server Resources
|
||||
* Get Plex server access tokens and server connections
|
||||
*
|
||||
* <p>Get Plex server access tokens and server connections
|
||||
*
|
||||
* @return The call builder
|
||||
*/
|
||||
public GetServerResourcesRequestBuilder getServerResources() {
|
||||
@@ -794,7 +838,9 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* 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)
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
@@ -806,11 +852,13 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* 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 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 clientID An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
|
||||
* @param serverURL Overrides the server URL.
|
||||
@@ -832,9 +880,11 @@ public class Plex implements
|
||||
.clientID(clientID)
|
||||
.build();
|
||||
|
||||
String _baseUrl = Utils.templateUrl(GET_SERVER_RESOURCES_SERVERS[0], new HashMap<String, String>());
|
||||
final String _baseUrl;
|
||||
if (serverURL.isPresent() && !serverURL.get().isBlank()) {
|
||||
_baseUrl = serverURL.get();
|
||||
} else {
|
||||
_baseUrl = Utils.templateUrl(GET_SERVER_RESOURCES_SERVERS[0], new HashMap<String, String>());
|
||||
}
|
||||
String _url = Utils.generateURL(
|
||||
_baseUrl,
|
||||
@@ -859,6 +909,7 @@ public class Plex implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"get-server-resources",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -870,6 +921,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"get-server-resources",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -879,6 +931,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"get-server-resources",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -888,6 +941,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"get-server-resources",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -981,7 +1035,9 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
public GetPinRequestBuilder getPin() {
|
||||
@@ -990,7 +1046,9 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
@@ -1002,7 +1060,9 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* 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 serverURL Overrides the server URL.
|
||||
* @return The response from the API call
|
||||
@@ -1011,9 +1071,11 @@ public class Plex implements
|
||||
public GetPinResponse getPin(
|
||||
GetPinRequest request,
|
||||
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()) {
|
||||
_baseUrl = serverURL.get();
|
||||
} else {
|
||||
_baseUrl = Utils.templateUrl(GET_PIN_SERVERS[0], new HashMap<String, String>());
|
||||
}
|
||||
String _url = Utils.generateURL(
|
||||
_baseUrl,
|
||||
@@ -1035,6 +1097,7 @@ public class Plex implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"getPin",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1046,6 +1109,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getPin",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1055,6 +1119,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"getPin",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1064,6 +1129,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getPin",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1141,7 +1207,9 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
public GetTokenByPinIdRequestBuilder getTokenByPinId() {
|
||||
@@ -1150,7 +1218,9 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* @return The response from the API call
|
||||
* @throws Exception if the API call fails
|
||||
@@ -1162,7 +1232,9 @@ public class Plex implements
|
||||
|
||||
/**
|
||||
* 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 serverURL Overrides the server URL.
|
||||
* @return The response from the API call
|
||||
@@ -1171,9 +1243,11 @@ public class Plex implements
|
||||
public GetTokenByPinIdResponse getTokenByPinId(
|
||||
GetTokenByPinIdRequest request,
|
||||
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()) {
|
||||
_baseUrl = serverURL.get();
|
||||
} else {
|
||||
_baseUrl = Utils.templateUrl(GET_TOKEN_BY_PIN_ID_SERVERS[0], new HashMap<String, String>());
|
||||
}
|
||||
String _url = Utils.generateURL(
|
||||
GetTokenByPinIdRequest.class,
|
||||
@@ -1192,6 +1266,7 @@ public class Plex implements
|
||||
sdkConfiguration.hooks()
|
||||
.beforeRequest(
|
||||
new BeforeRequestContextImpl(
|
||||
_baseUrl,
|
||||
"getTokenByPinId",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1203,6 +1278,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getTokenByPinId",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1212,6 +1288,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterSuccess(
|
||||
new AfterSuccessContextImpl(
|
||||
_baseUrl,
|
||||
"getTokenByPinId",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
@@ -1221,6 +1298,7 @@ public class Plex implements
|
||||
_httpRes = sdkConfiguration.hooks()
|
||||
.afterError(
|
||||
new AfterErrorContextImpl(
|
||||
_baseUrl,
|
||||
"getTokenByPinId",
|
||||
Optional.of(List.of()),
|
||||
_hookSecuritySource),
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
/*
|
||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
*/
|
||||
|
||||
package dev.plexapi.sdk;
|
||||
|
||||
import com.fasterxml.jackson.annotation.JsonValue;
|
||||
@@ -11,26 +10,28 @@ import dev.plexapi.sdk.utils.SpeakeasyHTTPClient;
|
||||
import dev.plexapi.sdk.utils.Utils;
|
||||
import java.lang.String;
|
||||
import java.util.Map;
|
||||
import java.util.Objects;
|
||||
import java.util.Optional;
|
||||
import java.util.function.Consumer;
|
||||
|
||||
/**
|
||||
* 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/) | - |
|
||||
* | 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) | - |
|
||||
* | 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) | -
|
||||
*
|
||||
*/
|
||||
public class PlexAPI {
|
||||
|
||||
@@ -52,24 +52,21 @@ public class PlexAPI {
|
||||
/**
|
||||
* The full address of your Plex Server
|
||||
*/
|
||||
"{protocol}://{ip}:{port}",
|
||||
"https://10.10.10.47:32400",
|
||||
};
|
||||
|
||||
/**
|
||||
* Operations against the Plex Media Server System.
|
||||
*
|
||||
*/
|
||||
private final Server server;
|
||||
|
||||
/**
|
||||
* API Calls interacting with Plex Media Server Media
|
||||
*
|
||||
*/
|
||||
private final Media media;
|
||||
|
||||
/**
|
||||
* API Calls that perform operations with Plex Media Server Videos
|
||||
*
|
||||
*/
|
||||
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 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.
|
||||
*
|
||||
*/
|
||||
private final Activities activities;
|
||||
|
||||
/**
|
||||
* Butler is the task manager of the Plex Media Server Ecosystem.
|
||||
*
|
||||
*/
|
||||
private final Butler butler;
|
||||
|
||||
/**
|
||||
* API Calls that perform operations directly against https://Plex.tv
|
||||
*
|
||||
*/
|
||||
private final Plex plex;
|
||||
|
||||
/**
|
||||
* Hubs are a structured two-dimensional container for media, generally represented by multiple horizontal rows.
|
||||
*
|
||||
*/
|
||||
private final Hubs hubs;
|
||||
|
||||
/**
|
||||
* API Calls that perform search operations with Plex Media Server
|
||||
*
|
||||
*/
|
||||
private final Search search;
|
||||
|
||||
/**
|
||||
* API Calls interacting with Plex Media Server Libraries
|
||||
*
|
||||
*/
|
||||
private final Library library;
|
||||
|
||||
/**
|
||||
* API Calls that perform operations with Plex Media Server Watchlists
|
||||
*
|
||||
*/
|
||||
private final Watchlist watchlist;
|
||||
|
||||
/**
|
||||
* Submit logs to the Log Handler for Plex Media Server
|
||||
*
|
||||
*/
|
||||
private final Log log;
|
||||
|
||||
@@ -132,32 +121,27 @@ public class PlexAPI {
|
||||
* They can be organized in (optionally nesting) folders.
|
||||
* Retrieving a playlist, or its items, will trigger a refresh of its metadata.
|
||||
* This may cause the duration and number of items to change.
|
||||
*
|
||||
*/
|
||||
private final Playlists playlists;
|
||||
|
||||
/**
|
||||
* API Calls regarding authentication for Plex Media Server
|
||||
*
|
||||
*/
|
||||
private final Authentication authentication;
|
||||
|
||||
/**
|
||||
* API Calls that perform operations with Plex Media Server Statistics
|
||||
*
|
||||
*/
|
||||
private final Statistics statistics;
|
||||
|
||||
/**
|
||||
* API Calls that perform search operations with Plex Media Server Sessions
|
||||
*
|
||||
*/
|
||||
private final Sessions sessions;
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
private final Updater updater;
|
||||
|
||||
@@ -165,7 +149,6 @@ public class PlexAPI {
|
||||
|
||||
/**
|
||||
* Operations against the Plex Media Server System.
|
||||
*
|
||||
*/
|
||||
public Server server() {
|
||||
return server;
|
||||
@@ -173,7 +156,6 @@ public class PlexAPI {
|
||||
|
||||
/**
|
||||
* API Calls interacting with Plex Media Server Media
|
||||
*
|
||||
*/
|
||||
public Media media() {
|
||||
return media;
|
||||
@@ -181,7 +163,6 @@ public class PlexAPI {
|
||||
|
||||
/**
|
||||
* API Calls that perform operations with Plex Media Server Videos
|
||||
*
|
||||
*/
|
||||
public Video 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 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.
|
||||
*
|
||||
*/
|
||||
public Activities activities() {
|
||||
return activities;
|
||||
@@ -203,7 +183,6 @@ public class PlexAPI {
|
||||
|
||||
/**
|
||||
* Butler is the task manager of the Plex Media Server Ecosystem.
|
||||
*
|
||||
*/
|
||||
public Butler butler() {
|
||||
return butler;
|
||||
@@ -211,7 +190,6 @@ public class PlexAPI {
|
||||
|
||||
/**
|
||||
* API Calls that perform operations directly against https://Plex.tv
|
||||
*
|
||||
*/
|
||||
public Plex 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.
|
||||
*
|
||||
*/
|
||||
public Hubs hubs() {
|
||||
return hubs;
|
||||
@@ -227,7 +204,6 @@ public class PlexAPI {
|
||||
|
||||
/**
|
||||
* API Calls that perform search operations with Plex Media Server
|
||||
*
|
||||
*/
|
||||
public Search search() {
|
||||
return search;
|
||||
@@ -235,7 +211,6 @@ public class PlexAPI {
|
||||
|
||||
/**
|
||||
* API Calls interacting with Plex Media Server Libraries
|
||||
*
|
||||
*/
|
||||
public Library library() {
|
||||
return library;
|
||||
@@ -243,7 +218,6 @@ public class PlexAPI {
|
||||
|
||||
/**
|
||||
* API Calls that perform operations with Plex Media Server Watchlists
|
||||
*
|
||||
*/
|
||||
public Watchlist watchlist() {
|
||||
return watchlist;
|
||||
@@ -251,7 +225,6 @@ public class PlexAPI {
|
||||
|
||||
/**
|
||||
* Submit logs to the Log Handler for Plex Media Server
|
||||
*
|
||||
*/
|
||||
public Log log() {
|
||||
return log;
|
||||
@@ -262,7 +235,6 @@ public class PlexAPI {
|
||||
* They can be organized in (optionally nesting) folders.
|
||||
* Retrieving a playlist, or its items, will trigger a refresh of its metadata.
|
||||
* This may cause the duration and number of items to change.
|
||||
*
|
||||
*/
|
||||
public Playlists playlists() {
|
||||
return playlists;
|
||||
@@ -270,7 +242,6 @@ public class PlexAPI {
|
||||
|
||||
/**
|
||||
* API Calls regarding authentication for Plex Media Server
|
||||
*
|
||||
*/
|
||||
public Authentication authentication() {
|
||||
return authentication;
|
||||
@@ -278,7 +249,6 @@ public class PlexAPI {
|
||||
|
||||
/**
|
||||
* API Calls that perform operations with Plex Media Server Statistics
|
||||
*
|
||||
*/
|
||||
public Statistics statistics() {
|
||||
return statistics;
|
||||
@@ -286,7 +256,6 @@ public class PlexAPI {
|
||||
|
||||
/**
|
||||
* API Calls that perform search operations with Plex Media Server Sessions
|
||||
*
|
||||
*/
|
||||
public Sessions sessions() {
|
||||
return sessions;
|
||||
@@ -295,7 +264,6 @@ public class PlexAPI {
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
public Updater updater() {
|
||||
return updater;
|
||||
@@ -342,6 +310,7 @@ public class PlexAPI {
|
||||
|
||||
/**
|
||||
* Configures the SDK to use a custom security source.
|
||||
*
|
||||
* @param securitySource The security source to use for all requests.
|
||||
* @return The builder instance.
|
||||
*/
|
||||
@@ -396,7 +365,9 @@ public class PlexAPI {
|
||||
return this;
|
||||
}
|
||||
/**
|
||||
* ServerProtocol - The protocol to use for the server connection
|
||||
* ServerProtocol
|
||||
*
|
||||
* <p>The protocol to use for the server connection
|
||||
*/
|
||||
public enum ServerProtocol {
|
||||
HTTP("http"),
|
||||
@@ -412,6 +383,15 @@ public class PlexAPI {
|
||||
public String 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.
|
||||
@@ -478,6 +458,7 @@ public class PlexAPI {
|
||||
|
||||
/**
|
||||
* Builds a new instance of the SDK.
|
||||
*
|
||||
* @return The SDK instance.
|
||||
*/
|
||||
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.
|
||||
*
|
||||
* @return The SDK builder instance.
|
||||
*/
|
||||
public static Builder builder() {
|
||||
@@ -526,4 +508,5 @@ public class PlexAPI {
|
||||
this.updater = new Updater(sdkConfiguration);
|
||||
this.users = new Users(sdkConfiguration);
|
||||
this.sdkConfiguration.initialize();
|
||||
}}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
/*
|
||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
*/
|
||||
|
||||
package dev.plexapi.sdk;
|
||||
|
||||
import dev.plexapi.sdk.hooks.SDKHooks;
|
||||
@@ -43,8 +42,8 @@ class SDKConfiguration {
|
||||
} };
|
||||
private static final String LANGUAGE = "java";
|
||||
public static final String OPENAPI_DOC_VERSION = "0.0.3";
|
||||
public static final String SDK_VERSION = "0.13.0";
|
||||
public static final String GEN_VERSION = "2.545.2";
|
||||
public static final String SDK_VERSION = "0.14.2";
|
||||
public static final String GEN_VERSION = "2.566.5";
|
||||
private static final String BASE_PACKAGE = "dev.plexapi.sdk";
|
||||
public static final String USER_AGENT =
|
||||
String.format("speakeasy-sdk/%s %s %s %s %s",
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user