Compare commits

..

7 Commits

Author SHA1 Message Date
speakeasybot
a4a2130978 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.484.1 2025-02-06 00:27:45 +00:00
speakeasybot
f33408b177 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.484.1 2025-02-05 00:27:30 +00:00
speakeasybot
22654201f5 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.476.1 2025-01-27 00:28:08 +00:00
speakeasybot
9dc8821b31 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.474.0 2025-01-24 00:27:12 +00:00
speakeasybot
412b27f162 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.459.2 2024-12-22 00:30:11 +00:00
speakeasybot
9c8fe4c95e ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.459.2 2024-12-21 00:27:05 +00:00
speakeasybot
a60df4029d ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.439.0 2024-11-14 00:27:10 +00:00
283 changed files with 14763 additions and 2956 deletions

1
.gitignore vendored
View File

@@ -1,3 +1,4 @@
.speakeasy/reports
# Ignore Gradle project-specific cache directory
.gradle
# Ignore Gradle build output directory

File diff suppressed because one or more lines are too long

View File

@@ -13,7 +13,7 @@ generation:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
java:
version: 0.10.0
version: 0.11.5
additionalDependencies: []
additionalPlugins: []
artifactID: plexapi

View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.438.1
speakeasyVersion: 1.484.1
sources:
my-source:
sourceNamespace: my-source
@@ -8,19 +8,19 @@ sources:
- latest
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:15e040d800921ded49cf84650ef2bc8fb1acf32c885ee193c42e838d754bf345
sourceBlobDigest: sha256:c178be2b4bfefb37d76c0fdaef37c51f9b6ab1410422d3698a41bb6a8d79a79f
sourceRevisionDigest: sha256:e6ab335dd91a4165f4510e4a3af8a55819c6310b7e66251266d2384376f3ccae
sourceBlobDigest: sha256:89d1b1133e400c89f0d06efe5e5168f5ba25a413e1ab8380d442d6b233e2e5a9
tags:
- latest
- main
- speakeasy-sdk-regen-1738801581
targets:
plexjava:
source: plexapi
sourceNamespace: plexapi
sourceRevisionDigest: sha256:15e040d800921ded49cf84650ef2bc8fb1acf32c885ee193c42e838d754bf345
sourceBlobDigest: sha256:c178be2b4bfefb37d76c0fdaef37c51f9b6ab1410422d3698a41bb6a8d79a79f
sourceRevisionDigest: sha256:e6ab335dd91a4165f4510e4a3af8a55819c6310b7e66251266d2384376f3ccae
sourceBlobDigest: sha256:89d1b1133e400c89f0d06efe5e5168f5ba25a413e1ab8380d442d6b233e2e5a9
codeSamplesNamespace: code-samples-java-plexjava
codeSamplesRevisionDigest: sha256:59231703e7c16d75675e4ee5c84e901b3033cfa89204ba9a3326ff1dcb0d5183
codeSamplesRevisionDigest: sha256:85b9a83c615e20272177b4b49152c959df250bf45bc141a4652d71090ec72db7
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest

View File

@@ -41,13 +41,21 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [plexapi](#plexapi)
* [Plex Media Server OpenAPI Specification](#plex-media-server-openapi-specification)
* [Documentation](#documentation)
* [SDKs](#sdks)
* [SDK Installation](#sdk-installation)
* [SDK Example Usage](#sdk-example-usage)
* [Available Resources and Operations](#available-resources-and-operations)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Authentication](#authentication)
* [Development](#development)
* [Maturity](#maturity)
* [Contributions](#contributions)
* [SDK Installation](#sdk-installation)
* [SDK Example Usage](#sdk-example-usage)
* [Available Resources and Operations](#available-resources-and-operations)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Authentication](#authentication)
<!-- End Table of Contents [toc] -->
<!-- Start SDK Installation [installation] -->
@@ -61,7 +69,7 @@ The samples below show how a published SDK artifact is used:
Gradle:
```groovy
implementation 'dev.plexapi:plexapi:0.10.0'
implementation 'dev.plexapi:plexapi:0.11.5'
```
Maven:
@@ -69,7 +77,7 @@ Maven:
<dependency>
<groupId>dev.plexapi</groupId>
<artifactId>plexapi</artifactId>
<version>0.10.0</version>
<version>0.11.5</version>
</dependency>
```
@@ -108,11 +116,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
@@ -168,6 +171,8 @@ public class Application {
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
* [getCountriesLibrary](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
@@ -248,6 +253,10 @@ public class Application {
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
### [users()](docs/sdks/users/README.md)
* [getUsers](docs/sdks/users/README.md#getusers) - Get list of all connected users
### [video()](docs/sdks/video/README.md)
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
@@ -290,11 +299,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
@@ -337,11 +341,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.serverURL("https://10.10.10.47:32400")
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
@@ -372,11 +371,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetCompanionsDataResponse res = sdk.plex().getCompanionsData()
@@ -418,11 +412,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()

View File

@@ -168,4 +168,74 @@ Based on:
### Generated
- [java v0.10.0] .
### Releases
- [Maven Central v0.10.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.10.0 - .
- [Maven Central v0.10.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.10.0 - .
## 2024-11-14 00:25:48
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.439.0 (2.457.9) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.10.1] .
### Releases
- [Maven Central v0.10.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.10.1 - .
## 2024-12-21 00:25:42
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.459.2 (2.483.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.11.0] .
### Releases
- [Maven Central v0.11.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.0 - .
## 2024-12-22 00:28:49
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.459.2 (2.483.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.11.1] .
### Releases
- [Maven Central v0.11.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.1 - .
## 2025-01-24 00:25:37
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.474.0 (2.495.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.11.2] .
### Releases
- [Maven Central v0.11.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.2 - .
## 2025-01-27 00:26:34
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.476.1 (2.495.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.11.3] .
### Releases
- [Maven Central v0.11.3] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.3 - .
## 2025-02-05 00:25:55
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.11.4] .
### Releases
- [Maven Central v0.11.4] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.4 - .
## 2025-02-06 00:26:06
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.11.5] .
### Releases
- [Maven Central v0.11.5] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.5 - .

View File

@@ -14,11 +14,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()

View File

@@ -63,7 +63,7 @@ tasks.withType(Javadoc) {
}
group = "dev.plexapi"
version = "0.10.0"
version = "0.11.5"
sourcesJar {
archiveBaseName = "plexapi"
@@ -101,7 +101,7 @@ publishing {
maven(MavenPublication) {
groupId = 'dev.plexapi'
artifactId = 'plexapi'
version = '0.10.0'
version = '0.11.5'
from components.java
@@ -144,16 +144,16 @@ if (!project.hasProperty('skip.signing')) {
}
}
dependencies {
implementation 'com.fasterxml.jackson.core:jackson-databind:2.17.2'
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.17.2'
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.17.2'
implementation 'org.openapitools:jackson-databind-nullable:0.2.6'
implementation 'org.apache.httpcomponents:httpclient:4.5.14'
implementation 'org.apache.httpcomponents:httpmime:4.5.14'
implementation 'commons-io:commons-io:2.15.1'
api 'com.fasterxml.jackson.core:jackson-annotations:2.18.2'
implementation 'com.fasterxml.jackson.core:jackson-databind:2.18.2'
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.18.2'
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.18.2'
api('org.openapitools:jackson-databind-nullable:0.2.6') {exclude group: 'com.fasterxml.jackson.core', module: 'jackson-databind'}
implementation 'org.apache.httpcomponents.client5:httpclient5:5.4.1'
implementation 'commons-io:commons-io:2.18.0'
}
apply from: 'build-extras.gradle'

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,11 @@
# GetCountriesLibraryBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `errors` | List\<[GetCountriesLibraryErrors](../../models/errors/GetCountriesLibraryErrors.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 |

View File

@@ -0,0 +1,10 @@
# GetCountriesLibraryErrors
## 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 |

View File

@@ -0,0 +1,10 @@
# GetCountriesLibraryLibraryErrors
## 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 |

View File

@@ -0,0 +1,11 @@
# GetCountriesLibraryUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `errors` | List\<[GetCountriesLibraryLibraryErrors](../../models/errors/GetCountriesLibraryLibraryErrors.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 |

View File

@@ -0,0 +1,11 @@
# GetGenresLibraryBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `errors` | List\<[GetGenresLibraryErrors](../../models/errors/GetGenresLibraryErrors.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 |

View File

@@ -0,0 +1,10 @@
# GetGenresLibraryErrors
## 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 |

View File

@@ -0,0 +1,10 @@
# GetGenresLibraryLibraryErrors
## 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 |

View File

@@ -0,0 +1,11 @@
# GetGenresLibraryUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `errors` | List\<[GetGenresLibraryLibraryErrors](../../models/errors/GetGenresLibraryLibraryErrors.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 |

View File

@@ -0,0 +1,11 @@
# GetUsersBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `errors` | List\<[GetUsersErrors](../../models/errors/GetUsersErrors.md)> | :heavy_minus_sign: | N/A |
| `rawResponse` | [HttpResponse\<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 |

View File

@@ -0,0 +1,10 @@
# GetUsersErrors
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |

View File

@@ -0,0 +1,11 @@
# GetUsersUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `errors` | List\<[GetUsersUsersErrors](../../models/errors/GetUsersUsersErrors.md)> | :heavy_minus_sign: | N/A |
| `rawResponse` | [HttpResponse\<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 |

View File

@@ -0,0 +1,10 @@
# GetUsersUsersErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,11 @@
# AllLibraries
Indicates if the user has access to all libraries.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,11 @@
# AllowCameraUpload
Indicates if the user is allowed to upload from a camera.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,11 @@
# AllowChannels
Indicates if the user has access to channels.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,11 @@
# AllowSubtitleAdmin
Indicates if the user can manage subtitles.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,11 @@
# AllowSync
Indicates if the user is allowed to sync media.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,11 @@
# AllowTuners
Indicates if the user is allowed to use tuners.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,11 @@
# EnableCreditsMarkerGeneration
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Disabled` | 0 |

View File

@@ -0,0 +1,12 @@
# EpisodeSort
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 |

View File

@@ -1,9 +1,12 @@
# FlattenSeasons
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
## Values
| Name | Value |
| ------- | ------- |
| `False` | 0 |
| `True` | 1 |
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Hide` | 0 |
| `Show` | 1 |

View File

@@ -0,0 +1,10 @@
# GetCountriesLibraryDirectory
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
| `fastKey` | *String* | :heavy_check_mark: | N/A | /library/sections/2/all?country=15491 |
| `key` | *String* | :heavy_check_mark: | N/A | 15491 |
| `title` | *String* | :heavy_check_mark: | N/A | Japan |

View File

@@ -0,0 +1,22 @@
# GetCountriesLibraryMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `size` | *double* | :heavy_check_mark: | N/A | 50 |
| `offset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | |
| `totalSize` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | |
| `identifier` | *String* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
| `art` | *String* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
| `content` | *String* | :heavy_check_mark: | N/A | secondary |
| `mediaTagPrefix` | *String* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *long* | :heavy_check_mark: | N/A | 1734362201 |
| `nocache` | *boolean* | :heavy_check_mark: | N/A | true |
| `thumb` | *String* | :heavy_check_mark: | N/A | /:/resources/show.png |
| `title1` | *String* | :heavy_check_mark: | N/A | TV Series |
| `title2` | *String* | :heavy_check_mark: | N/A | By Country |
| `viewGroup` | *String* | :heavy_check_mark: | N/A | secondary |
| `directory` | List\<[GetCountriesLibraryDirectory](../../models/operations/GetCountriesLibraryDirectory.md)> | :heavy_minus_sign: | N/A | |

View File

@@ -0,0 +1,8 @@
# GetCountriesLibraryRequest
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |

View File

@@ -0,0 +1,11 @@
# GetCountriesLibraryResponse
## 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\<GetCountriesLibraryResponseBody>](../../models/operations/GetCountriesLibraryResponseBody.md) | :heavy_minus_sign: | Successful response containing media container data. |

View File

@@ -0,0 +1,10 @@
# GetCountriesLibraryResponseBody
Successful response containing media container data.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `mediaContainer` | [Optional\<GetCountriesLibraryMediaContainer>](../../models/operations/GetCountriesLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,11 @@
# GetGenresLibraryDirectory
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
| `fastKey` | *String* | :heavy_check_mark: | N/A | /library/sections/10/all?genre=89 |
| `key` | *String* | :heavy_check_mark: | N/A | 89 |
| `title` | *String* | :heavy_check_mark: | N/A | Action |
| `type` | *String* | :heavy_check_mark: | N/A | genre |

View File

@@ -0,0 +1,22 @@
# GetGenresLibraryMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `size` | *double* | :heavy_check_mark: | N/A | 50 |
| `offset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | |
| `totalSize` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | |
| `identifier` | *String* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
| `art` | *String* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
| `content` | *String* | :heavy_check_mark: | N/A | secondary |
| `mediaTagPrefix` | *String* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *long* | :heavy_check_mark: | N/A | 1734362201 |
| `nocache` | *boolean* | :heavy_check_mark: | N/A | true |
| `thumb` | *String* | :heavy_check_mark: | N/A | /:/resources/show.png |
| `title1` | *String* | :heavy_check_mark: | N/A | TV Shows (Reality) |
| `title2` | *String* | :heavy_check_mark: | N/A | By Genre |
| `viewGroup` | *String* | :heavy_check_mark: | N/A | secondary |
| `directory` | List\<[GetGenresLibraryDirectory](../../models/operations/GetGenresLibraryDirectory.md)> | :heavy_minus_sign: | N/A | |

View File

@@ -0,0 +1,8 @@
# GetGenresLibraryRequest
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |

View File

@@ -0,0 +1,11 @@
# GetGenresLibraryResponse
## 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\<GetGenresLibraryResponseBody>](../../models/operations/GetGenresLibraryResponseBody.md) | :heavy_minus_sign: | Successful response containing media container data. |

View File

@@ -0,0 +1,10 @@
# GetGenresLibraryResponseBody
Successful response containing media container data.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `mediaContainer` | [Optional\<GetGenresLibraryMediaContainer>](../../models/operations/GetGenresLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,11 @@
# GetLibraryItemsEnableCreditsMarkerGeneration
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Disabled` | 0 |

View File

@@ -0,0 +1,12 @@
# 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 |

View File

@@ -1,9 +1,12 @@
# GetLibraryItemsFlattenSeasons
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
## Values
| Name | Value |
| ------- | ------- |
| `False` | 0 |
| `True` | 1 |
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Hide` | 0 |
| `Show` | 1 |

View File

@@ -23,8 +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: | N/A | 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/> | dvd |
| `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 |
| `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 |

View File

@@ -17,4 +17,6 @@ E.g. A movie library will not return anything with type 3 as there are no season
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

View File

@@ -1,20 +1,20 @@
# GetLibraryItemsShowOrdering
Setting that indicates the episode ordering for the show
None = Library default,
tmdbAiring = The Movie Database (Aired),
aired = TheTVDB (Aired),
dvd = TheTVDB (DVD),
Setting that indicates the episode ordering for the show.
None = Library default,
tmdbAiring = The Movie Database (Aired),
aired = TheTVDB (Aired),
dvd = TheTVDB (DVD),
absolute = TheTVDB (Absolute)).
## Values
| Name | Value |
| ------------ | ------------ |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `Aired` | aired |
| `Dvd` | dvd |
| `Absolute` | absolute |
| Name | Value |
| -------------- | -------------- |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `TvdbAired` | aired |
| `TvdbDvd` | dvd |
| `TvdbAbsolute` | absolute |

View File

@@ -14,6 +14,11 @@
| `librarySectionTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionID` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | The name of the album artist for the track when audio, and the name of the TV show for the episode when video. | |
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | The name of the album for the track when audio, and the name of the season for the episode when TV show. | |
| `originalTitle` | *Optional\<String>* | :heavy_minus_sign: | The orginal untranslated name of the media item when non-english. | |
| `index` | *Optional\<Long>* | :heavy_minus_sign: | The index starting from 0 of this media item in the MetaData array. | |
| `parentIndex` | *Optional\<Long>* | :heavy_minus_sign: | The parent index starting from 0 of this media item in the parent MetaData array. | |
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | N/A | PG-13 |
| `summary` | *Optional\<String>* | :heavy_minus_sign: | N/A | Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job. |
| `rating` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 8.2 |

View File

@@ -6,7 +6,7 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `strong` | *Optional\<Boolean>* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
| `clientID` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `clientID` | *String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `clientName` | *Optional\<String>* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `deviceNickname` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `clientVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |

View File

@@ -17,4 +17,6 @@ E.g. A movie library will not return anything with type 3 as there are no season
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

View File

@@ -9,6 +9,6 @@
| `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 | |
| `allowSync` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
| `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 | |

View File

@@ -23,8 +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\<FlattenSeasons>](../../models/operations/FlattenSeasons.md) | :heavy_minus_sign: | N/A | 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/> | dvd |
| `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 |

View File

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesEnableCreditsMarkerGeneration
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Disabled` | 0 |

View File

@@ -0,0 +1,12 @@
# GetSearchAllLibrariesEpisodeSort
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 |

View File

@@ -1,9 +1,12 @@
# GetSearchAllLibrariesFlattenSeasons
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
## Values
| Name | Value |
| ------- | ------- |
| `False` | 0 |
| `True` | 1 |
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Hide` | 0 |
| `Show` | 1 |

View File

@@ -23,8 +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\<GetSearchAllLibrariesFlattenSeasons>](../../models/operations/GetSearchAllLibrariesFlattenSeasons.md) | :heavy_minus_sign: | N/A | 1 |
| `showOrdering` | [Optional\<GetSearchAllLibrariesShowOrdering>](../../models/operations/GetSearchAllLibrariesShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
| `flattenSeasons` | [Optional\<GetSearchAllLibrariesFlattenSeasons>](../../models/operations/GetSearchAllLibrariesFlattenSeasons.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\<GetSearchAllLibrariesEpisodeSort>](../../models/operations/GetSearchAllLibrariesEpisodeSort.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\<GetSearchAllLibrariesEnableCreditsMarkerGeneration>](../../models/operations/GetSearchAllLibrariesEnableCreditsMarkerGeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
| `showOrdering` | [Optional\<GetSearchAllLibrariesShowOrdering>](../../models/operations/GetSearchAllLibrariesShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | 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 |

View File

@@ -6,7 +6,7 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `query` | *String* | :heavy_check_mark: | The search query term. | |
| `clientID` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `clientID` | *String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `limit` | *Optional\<Long>* | :heavy_minus_sign: | Limit the number of results returned. | |
| `searchTypes` | List\<[SearchTypes](../../models/operations/SearchTypes.md)> | :heavy_minus_sign: | A comma-separated list of search types to include. Valid values are: movies, music, otherVideos, people, tv.<br/> | movies,music,otherVideos,people,tv |
| `includeCollections` | [Optional\<QueryParamIncludeCollections>](../../models/operations/QueryParamIncludeCollections.md) | :heavy_minus_sign: | Whether to include collections in the search results. | 1 |

View File

@@ -1,20 +1,20 @@
# GetSearchAllLibrariesShowOrdering
Setting that indicates the episode ordering for the show
None = Library default,
tmdbAiring = The Movie Database (Aired),
aired = TheTVDB (Aired),
dvd = TheTVDB (DVD),
Setting that indicates the episode ordering for the show.
None = Library default,
tmdbAiring = The Movie Database (Aired),
aired = TheTVDB (Aired),
dvd = TheTVDB (DVD),
absolute = TheTVDB (Absolute)).
## Values
| Name | Value |
| ------------ | ------------ |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `Aired` | aired |
| `Dvd` | dvd |
| `Absolute` | absolute |
| Name | Value |
| -------------- | -------------- |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `TvdbAired` | aired |
| `TvdbDvd` | dvd |
| `TvdbAbsolute` | absolute |

View File

@@ -17,4 +17,6 @@ E.g. A movie library will not return anything with type 3 as there are no season
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

View File

@@ -8,4 +8,4 @@
| `includeHttps` | [Optional\<IncludeHttps>](../../models/operations/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `includeRelay` | [Optional\<IncludeRelay>](../../models/operations/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `includeIPv6` | [Optional\<IncludeIPv6>](../../models/operations/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `clientID` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `clientID` | *String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |

View File

@@ -3,42 +3,43 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `addedAt` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1705543312 |
| `art` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/39904/art/1705310687 |
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 186240 |
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/39904/art/1705310687 |
| `grandparentGuid` | *Optional\<String>* | :heavy_minus_sign: | N/A | plex://artist/5d07bbfd403c6402904a6480 |
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/39904 |
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | 39904 |
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/39904/thumb/1705310687 |
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Green Day |
| `guid` | *Optional\<String>* | :heavy_minus_sign: | N/A | plex://track/6535834f71f22f36f71a8e8f |
| `index` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `key` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/67085 |
| `librarySectionID` | *Optional\<String>* | :heavy_minus_sign: | N/A | 3 |
| `librarySectionKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/3 |
| `librarySectionTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Music |
| `musicAnalysisVersion` | *Optional\<String>* | :heavy_minus_sign: | N/A | 1 |
| `parentGuid` | *Optional\<String>* | :heavy_minus_sign: | N/A | plex://album/65394d6d472b8ab03ef47f12 |
| `parentIndex` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/67084 |
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | 67084 |
| `parentStudio` | *Optional\<String>* | :heavy_minus_sign: | N/A | Reprise Records |
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/67084/thumb/1705543314 |
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Saviors |
| `parentYear` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2024 |
| `ratingCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 45885 |
| `ratingKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | 67085 |
| `sessionKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | 203 |
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/67084/thumb/1705543314 |
| `title` | *Optional\<String>* | :heavy_minus_sign: | N/A | The American Dream Is Killing Me |
| `titleSort` | *Optional\<String>* | :heavy_minus_sign: | N/A | American Dream Is Killing Me |
| `type` | *Optional\<String>* | :heavy_minus_sign: | N/A | track |
| `updatedAt` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1705543314 |
| `viewOffset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
| `media` | List\<[GetSessionsMedia](../../models/operations/GetSessionsMedia.md)> | :heavy_minus_sign: | N/A | |
| `user` | [Optional\<GetSessionsUser>](../../models/operations/GetSessionsUser.md) | :heavy_minus_sign: | N/A | |
| `player` | [Optional\<Player>](../../models/operations/Player.md) | :heavy_minus_sign: | N/A | |
| `session` | [Optional\<Session>](../../models/operations/Session.md) | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `addedAt` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1705543312 |
| `art` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/39904/art/1705310687 |
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 186240 |
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/39904/art/1705310687 |
| `grandparentGuid` | *Optional\<String>* | :heavy_minus_sign: | N/A | plex://artist/5d07bbfd403c6402904a6480 |
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/39904 |
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | 39904 |
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/39904/thumb/1705310687 |
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Green Day |
| `guid` | *Optional\<String>* | :heavy_minus_sign: | N/A | plex://track/6535834f71f22f36f71a8e8f |
| `index` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `key` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/67085 |
| `librarySectionID` | *Optional\<String>* | :heavy_minus_sign: | N/A | 3 |
| `librarySectionKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/3 |
| `librarySectionTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Music |
| `musicAnalysisVersion` | *Optional\<String>* | :heavy_minus_sign: | N/A | 1 |
| `originalTitle` | *Optional\<String>* | :heavy_minus_sign: | The original untranslated name of the media item when non-english, or the track artist if an audio Item has an album artist | The American Dream Is Killing Me |
| `parentGuid` | *Optional\<String>* | :heavy_minus_sign: | N/A | plex://album/65394d6d472b8ab03ef47f12 |
| `parentIndex` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/67084 |
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | 67084 |
| `parentStudio` | *Optional\<String>* | :heavy_minus_sign: | N/A | Reprise Records |
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/67084/thumb/1705543314 |
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Saviors |
| `parentYear` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2024 |
| `ratingCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 45885 |
| `ratingKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | 67085 |
| `sessionKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | 203 |
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/67084/thumb/1705543314 |
| `title` | *Optional\<String>* | :heavy_minus_sign: | N/A | The American Dream Is Killing Me |
| `titleSort` | *Optional\<String>* | :heavy_minus_sign: | N/A | American Dream Is Killing Me |
| `type` | *Optional\<String>* | :heavy_minus_sign: | N/A | track |
| `updatedAt` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1705543314 |
| `viewOffset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
| `media` | List\<[GetSessionsMedia](../../models/operations/GetSessionsMedia.md)> | :heavy_minus_sign: | N/A | |
| `user` | [Optional\<GetSessionsUser>](../../models/operations/GetSessionsUser.md) | :heavy_minus_sign: | N/A | |
| `player` | [Optional\<Player>](../../models/operations/Player.md) | :heavy_minus_sign: | N/A | |
| `session` | [Optional\<Session>](../../models/operations/Session.md) | :heavy_minus_sign: | N/A | |

View File

@@ -6,7 +6,7 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `pinID` | *long* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `clientID` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `clientID` | *String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `clientName` | *Optional\<String>* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `deviceNickname` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `clientVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |

View File

@@ -36,4 +36,4 @@
| `country` | List\<[GetTopWatchedContentCountry](../../models/operations/GetTopWatchedContentCountry.md)> | :heavy_minus_sign: | N/A | |
| `guids` | List\<[GetTopWatchedContentGuids](../../models/operations/GetTopWatchedContentGuids.md)> | :heavy_minus_sign: | N/A | |
| `role` | List\<[GetTopWatchedContentRole](../../models/operations/GetTopWatchedContentRole.md)> | :heavy_minus_sign: | N/A | |
| `user` | List\<[User](../../models/operations/User.md)> | :heavy_minus_sign: | N/A | |
| `user` | List\<[GetTopWatchedContentUser](../../models/operations/GetTopWatchedContentUser.md)> | :heavy_minus_sign: | N/A | |

View File

@@ -17,4 +17,6 @@ E.g. A movie library will not return anything with type 3 as there are no season
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

View File

@@ -0,0 +1,8 @@
# GetTopWatchedContentUser
## Fields
| Field | Type | Required | Description | Example |
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
| `id` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 220 |

View File

@@ -0,0 +1,15 @@
# GetUsersMediaContainer
Container holding user and server details.
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `friendlyName` | *String* | :heavy_check_mark: | The friendly name of the Plex instance. | myPlex |
| `identifier` | *String* | :heavy_check_mark: | N/A | com.plexapp.plugins.myplex |
| `machineIdentifier` | *String* | :heavy_check_mark: | Unique Machine identifier of the Plex server. | 3dff4c4da3b1229a649aa574a9e2b419a684a20e |
| `totalSize` | *long* | :heavy_check_mark: | Total number of users. | 30 |
| `size` | *long* | :heavy_check_mark: | Number of users in the current response. | 30 |
| `user` | List\<[User](../../models/operations/User.md)> | :heavy_check_mark: | List of users with access to the Plex server. | |

View File

@@ -0,0 +1,20 @@
# GetUsersRequest
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientID` | *String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `clientName` | *Optional\<String>* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `deviceNickname` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | The name of the device the client application is running on. This is used to track the client application and its usage. (Chrome, Safari, etc.) | Chrome |
| `deviceScreenResolution` | *Optional\<String>* | :heavy_minus_sign: | The resolution of the device the client application is running on. This is used to track the client application and its usage. (1487x1165,2560x1440) | 1487x1165,2560x1440 |
| `clientVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client application. | Roku |
| `clientFeatures` | *Optional\<String>* | :heavy_minus_sign: | The features of the client application. This is used to track the client application and its usage. (external-media,indirect-media,hub-style-list) | external-media,indirect-media,hub-style-list |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexSessionId` | *Optional\<String>* | :heavy_minus_sign: | The session ID of the client application. This is used to track the client application and its usage. (97e136ef-4ddd-4ff3-89a7-a5820c96c2ca) | 97e136ef-4ddd-4ff3-89a7-a5820c96c2ca |
| `xPlexLanguage` | *Optional\<String>* | :heavy_minus_sign: | The language of the client application. | en |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexToken` | *String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

View File

@@ -0,0 +1,11 @@
# GetUsersResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<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 |
| `body` | *Optional\<byte[]>* | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,10 @@
# GetUsersResponseBody
Successful response with media container data in XML
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional\<GetUsersMediaContainer>](../../models/operations/GetUsersMediaContainer.md) | :heavy_minus_sign: | Container holding user and server details. |

View File

@@ -0,0 +1,16 @@
# GetUsersServer
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `id` | *long* | :heavy_check_mark: | Unique ID of the server of the connected user | 907759180 |
| `serverId` | *long* | :heavy_check_mark: | ID of the actual Plex server. | 9999999 |
| `machineIdentifier` | *String* | :heavy_check_mark: | Machine identifier of the Plex server. | fbb8aa6be6e0c997c6268bc2b4431c8807f70a3 |
| `name` | *String* | :heavy_check_mark: | Name of the Plex server of the connected user. | ConnectedUserFlix |
| `lastSeenAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
| `numLibraries` | *long* | :heavy_check_mark: | Number of libraries in the server this user has access to. | 16 |
| `allLibraries` | [Optional\<AllLibraries>](../../models/operations/AllLibraries.md) | :heavy_minus_sign: | N/A | 1 |
| `owned` | [Optional\<Owned>](../../models/operations/Owned.md) | :heavy_minus_sign: | N/A | 1 |
| `pending` | [Optional\<Pending>](../../models/operations/Pending.md) | :heavy_minus_sign: | N/A | 1 |

View File

@@ -0,0 +1,11 @@
# Home
Indicates if the user is part of a home group.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,11 @@
# Owned
Indicates if the user owns the server.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,11 @@
# Pending
Indicates if the server is pending approval.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `clientID` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `clientID` | *String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `clientName` | *Optional\<String>* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `deviceNickname` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `clientVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |

View File

@@ -0,0 +1,11 @@
# Protected
Indicates whether the account is protected.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -17,4 +17,6 @@ E.g. A movie library will not return anything with type 3 as there are no season
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

View File

@@ -0,0 +1,11 @@
# Restricted
Indicates if the user has restricted access.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -1,20 +1,20 @@
# ShowOrdering
Setting that indicates the episode ordering for the show
None = Library default,
tmdbAiring = The Movie Database (Aired),
aired = TheTVDB (Aired),
dvd = TheTVDB (DVD),
Setting that indicates the episode ordering for the show.
None = Library default,
tmdbAiring = The Movie Database (Aired),
aired = TheTVDB (Aired),
dvd = TheTVDB (DVD),
absolute = TheTVDB (Absolute)).
## Values
| Name | Value |
| ------------ | ------------ |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `Aired` | aired |
| `Dvd` | dvd |
| `Absolute` | absolute |
| Name | Value |
| -------------- | -------------- |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `TvdbAired` | aired |
| `TvdbDvd` | dvd |
| `TvdbAbsolute` | absolute |

View File

@@ -25,4 +25,5 @@ A key representing a specific tag within the section.
| `RATING` | rating |
| `RESOLUTION` | resolution |
| `FIRST_CHARACTER` | firstCharacter |
| `FOLDER` | folder |
| `FOLDER` | folder |
| `ALBUMS` | albums |

View File

@@ -17,4 +17,6 @@ E.g. A movie library will not return anything with type 3 as there are no season
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

View File

@@ -3,6 +3,25 @@
## Fields
| Field | Type | Required | Description | Example |
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
| `id` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 220 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| `id` | *long* | :heavy_check_mark: | User's unique ID. | 22526914 |
| `title` | *String* | :heavy_check_mark: | User's display name. | Plex User |
| `username` | *String* | :heavy_check_mark: | User's username. | zgfuc7krcqfimrmb9lsl5j |
| `email` | *String* | :heavy_check_mark: | User's email address. | zgfuc7krcqfimrmb9lsl5j@protonmail.com |
| `recommendationsPlaylistId` | *JsonNullable\<String>* | :heavy_minus_sign: | ID of the user's recommendation playlist. | |
| `thumb` | *String* | :heavy_check_mark: | URL to the user's avatar image. | https://plex.tv/users/3346028014e93acd/avatar?c=1731605021 |
| `protected_` | [Optional\<Protected>](../../models/operations/Protected.md) | :heavy_minus_sign: | N/A | 1 |
| `home` | [Optional\<Home>](../../models/operations/Home.md) | :heavy_minus_sign: | N/A | 1 |
| `allowTuners` | [Optional\<AllowTuners>](../../models/operations/AllowTuners.md) | :heavy_minus_sign: | N/A | 1 |
| `allowSync` | [Optional\<AllowSync>](../../models/operations/AllowSync.md) | :heavy_minus_sign: | N/A | 1 |
| `allowCameraUpload` | [Optional\<AllowCameraUpload>](../../models/operations/AllowCameraUpload.md) | :heavy_minus_sign: | N/A | 1 |
| `allowChannels` | [Optional\<AllowChannels>](../../models/operations/AllowChannels.md) | :heavy_minus_sign: | N/A | 1 |
| `allowSubtitleAdmin` | [Optional\<AllowSubtitleAdmin>](../../models/operations/AllowSubtitleAdmin.md) | :heavy_minus_sign: | N/A | 1 |
| `filterAll` | *JsonNullable\<String>* | :heavy_minus_sign: | Filters applied for all content. | |
| `filterMovies` | *JsonNullable\<String>* | :heavy_minus_sign: | Filters applied for movies. | |
| `filterMusic` | *JsonNullable\<String>* | :heavy_minus_sign: | Filters applied for music. | |
| `filterPhotos` | *JsonNullable\<String>* | :heavy_minus_sign: | Filters applied for photos. | |
| `filterTelevision` | *Optional\<String>* | :heavy_minus_sign: | Filters applied for television. | |
| `restricted` | [Optional\<Restricted>](../../models/operations/Restricted.md) | :heavy_minus_sign: | N/A | 1 |
| `server` | List\<[GetUsersServer](../../models/operations/GetUsersServer.md)> | :heavy_check_mark: | List of servers owned by the user. | |

View File

@@ -38,11 +38,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetServerActivitiesResponse res = sdk.activities().getServerActivities()
@@ -88,11 +83,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
CancelServerActivitiesResponse res = sdk.activities().cancelServerActivities()

View File

@@ -37,11 +37,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetTransientTokenResponse res = sdk.authentication().getTransientToken()
@@ -96,15 +91,10 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetSourceConnectionInformationResponse res = sdk.authentication().getSourceConnectionInformation()
.source("server://client-identifier")
.source("provider://provider-identifier")
.call();
// handle response
@@ -151,11 +141,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetTokenDetailsResponse res = sdk.authentication().getTokenDetails()
@@ -208,14 +193,14 @@ public class Application {
public static void main(String[] args) throws PostUsersSignInDataBadRequest, PostUsersSignInDataUnauthorized, Exception {
PlexAPI sdk = PlexAPI.builder()
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
PostUsersSignInDataRequest req = PostUsersSignInDataRequest.builder()
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.deviceNickname("Roku 3")
.clientVersion("2.4.1")
.platform("Roku")
.requestBody(PostUsersSignInDataRequestBody.builder()
.login("username@email.com")
.password("password123")

View File

@@ -35,11 +35,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetButlerTasksResponse res = sdk.butler().getButlerTasks()
@@ -90,11 +85,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
StartAllTasksResponse res = sdk.butler().startAllTasks()
@@ -139,11 +129,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
StopAllTasksResponse res = sdk.butler().stopAllTasks()
@@ -193,11 +178,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
StartTaskResponse res = sdk.butler().startTask()
@@ -250,11 +230,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
StopTaskResponse res = sdk.butler().stopTask()

View File

@@ -34,11 +34,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetGlobalHubsResponse res = sdk.hubs().getGlobalHubs()
@@ -85,7 +80,6 @@ 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.IncludeMeta;
import dev.plexapi.sdk.models.operations.Type;
import java.lang.Exception;
@@ -95,20 +89,12 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetRecentlyAddedRequest req = GetRecentlyAddedRequest.builder()
.contentDirectoryID(470161L)
.type(Type.TvShow)
.sectionID(2L)
.includeMeta(IncludeMeta.Enable)
.xPlexContainerStart(0)
.xPlexContainerSize(50)
.build();
GetRecentlyAddedResponse res = sdk.hubs().getRecentlyAdded()
@@ -161,17 +147,12 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetLibraryHubsResponse res = sdk.hubs().getLibraryHubs()
.sectionId(6728.76d)
.count(639.24d)
.onlyTransient(QueryParamOnlyTransient.ONE)
.count(6728.76d)
.onlyTransient(QueryParamOnlyTransient.ZERO)
.call();
if (res.object().isPresent()) {

View File

@@ -16,6 +16,8 @@ API Calls interacting with Plex Media Server Libraries
* [getLibraryItems](#getlibraryitems) - Get Library Items
* [getRefreshLibraryMetadata](#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
* [getSearchLibrary](#getsearchlibrary) - Search Library
* [getGenresLibrary](#getgenreslibrary) - Get Genres of library media
* [getCountriesLibrary](#getcountrieslibrary) - Get Countries of library media
* [getSearchAllLibraries](#getsearchalllibraries) - Search All Libraries
* [getMetaDataByRatingKey](#getmetadatabyratingkey) - Get Metadata by RatingKey
* [getMetadataChildren](#getmetadatachildren) - Get Items Children
@@ -43,11 +45,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetFileHashResponse res = sdk.library().getFileHash()
@@ -94,7 +91,6 @@ 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.QueryParamIncludeMeta;
import dev.plexapi.sdk.models.operations.QueryParamType;
import java.lang.Exception;
import java.util.List;
@@ -105,11 +101,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetRecentlyAddedLibraryRequest req = GetRecentlyAddedLibraryRequest.builder()
@@ -129,9 +120,6 @@ public class Application {
16L,
17L))
.sectionID(2L)
.includeMeta(QueryParamIncludeMeta.Enable)
.xPlexContainerStart(0)
.xPlexContainerSize(50)
.build();
GetRecentlyAddedLibraryResponse res = sdk.library().getRecentlyAddedLibrary()
@@ -190,11 +178,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetAllLibrariesResponse res = sdk.library().getAllLibraries()
@@ -280,11 +263,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetLibraryDetailsResponse res = sdk.library().getLibraryDetails()
@@ -339,11 +317,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
DeleteLibraryResponse res = sdk.library().deleteLibrary()
@@ -395,6 +368,7 @@ Fetches details from a specific section of the library identified by a section k
- `resolution`: Items categorized by resolution.
- `firstCharacter`: Items categorized by the first letter.
- `folder`: Items categorized by folder.
- `albums`: Items categorized by album.
### Example Usage
@@ -405,11 +379,9 @@ 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.GetLibraryItemsQueryParamIncludeMeta;
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.IncludeGuids;
import dev.plexapi.sdk.models.operations.Tag;
import java.lang.Exception;
@@ -419,21 +391,12 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetLibraryItemsRequest req = GetLibraryItemsRequest.builder()
.tag(Tag.EDITION)
.sectionKey(9518)
.includeGuids(IncludeGuids.Enable)
.type(GetLibraryItemsQueryParamType.TvShow)
.includeMeta(GetLibraryItemsQueryParamIncludeMeta.Enable)
.xPlexContainerStart(0)
.xPlexContainerSize(50)
.build();
GetLibraryItemsResponse res = sdk.library().getLibraryItems()
@@ -488,11 +451,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetRefreshLibraryMetadataResponse res = sdk.library().getRefreshLibraryMetadata()
@@ -564,11 +522,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetSearchLibraryResponse res = sdk.library().getSearchLibrary()
@@ -602,6 +555,112 @@ public class Application {
| models/errors/GetSearchLibraryUnauthorized | 401 | application/json |
| models/errors/SDKError | 4XX, 5XX | \*/\* |
## getGenresLibrary
Retrieves a list of all the genres that are found for the media in this library.
### Example Usage
```java
package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.GetGenresLibraryBadRequest;
import dev.plexapi.sdk.models.errors.GetGenresLibraryUnauthorized;
import dev.plexapi.sdk.models.operations.GetGenresLibraryResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws GetGenresLibraryBadRequest, GetGenresLibraryUnauthorized, Exception {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.build();
GetGenresLibraryResponse res = sdk.library().getGenresLibrary()
.sectionKey(9518)
.call();
if (res.object().isPresent()) {
// handle response
}
}
}
```
### Parameters
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
### Response
**[GetGenresLibraryResponse](../../models/operations/GetGenresLibraryResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| models/errors/GetGenresLibraryBadRequest | 400 | application/json |
| models/errors/GetGenresLibraryUnauthorized | 401 | application/json |
| models/errors/SDKError | 4XX, 5XX | \*/\* |
## getCountriesLibrary
Retrieves a list of all the countries that are found for the media in this library.
### Example Usage
```java
package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.GetCountriesLibraryBadRequest;
import dev.plexapi.sdk.models.errors.GetCountriesLibraryUnauthorized;
import dev.plexapi.sdk.models.operations.GetCountriesLibraryResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws GetCountriesLibraryBadRequest, GetCountriesLibraryUnauthorized, Exception {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.build();
GetCountriesLibraryResponse res = sdk.library().getCountriesLibrary()
.sectionKey(9518)
.call();
if (res.object().isPresent()) {
// handle response
}
}
}
```
### Parameters
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
### Response
**[GetCountriesLibraryResponse](../../models/operations/GetCountriesLibraryResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| models/errors/GetCountriesLibraryBadRequest | 400 | application/json |
| models/errors/GetCountriesLibraryUnauthorized | 401 | application/json |
| models/errors/SDKError | 4XX, 5XX | \*/\* |
## getSearchAllLibraries
Search the provided query across all library sections, or a single section, and return matches as hubs, split up by type.
@@ -617,8 +676,6 @@ import dev.plexapi.sdk.models.errors.GetSearchAllLibrariesBadRequest;
import dev.plexapi.sdk.models.errors.GetSearchAllLibrariesUnauthorized;
import dev.plexapi.sdk.models.operations.GetSearchAllLibrariesRequest;
import dev.plexapi.sdk.models.operations.GetSearchAllLibrariesResponse;
import dev.plexapi.sdk.models.operations.QueryParamIncludeCollections;
import dev.plexapi.sdk.models.operations.QueryParamIncludeExternalMedia;
import dev.plexapi.sdk.models.operations.SearchTypes;
import java.lang.Exception;
import java.util.List;
@@ -629,19 +686,13 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetSearchAllLibrariesRequest req = GetSearchAllLibrariesRequest.builder()
.query("<value>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.searchTypes(List.of(
SearchTypes.PEOPLE))
.includeCollections(QueryParamIncludeCollections.Enable)
.includeExternalMedia(QueryParamIncludeExternalMedia.Enable)
.build();
GetSearchAllLibrariesResponse res = sdk.library().getSearchAllLibraries()
@@ -695,11 +746,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetMetaDataByRatingKeyResponse res = sdk.library().getMetaDataByRatingKey()
@@ -753,16 +799,11 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetMetadataChildrenResponse res = sdk.library().getMetadataChildren()
.ratingKey(1539.15d)
.includeElements("<value>")
.ratingKey(1539.14d)
.includeElements("Stream")
.call();
if (res.object().isPresent()) {
@@ -814,11 +855,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetTopWatchedContentResponse res = sdk.library().getTopWatchedContent()
@@ -874,11 +910,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetOnDeckResponse res = sdk.library().getOnDeck()

View File

@@ -35,11 +35,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
LogLineResponse res = sdk.log().logLine()
@@ -116,15 +111,9 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
String req = "level=4&message=Test%20message%201&source=postman\nlevel=3&message=Test%20message%202&source=postman
level=1&message=Test%20message%203&source=postman";
String req = "level=4&message=Test%20message%201&source=postman\nlevel=3&message=Test%20message%202&source=postman\nlevel=1&message=Test%20message%203&source=postman";
LogMultiLineResponse res = sdk.log().logMultiLine()
.request(req)
@@ -175,11 +164,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
EnablePaperTrailResponse res = sdk.log().enablePaperTrail()

View File

@@ -35,11 +35,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
MarkPlayedResponse res = sdk.media().markPlayed()
@@ -90,11 +85,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
MarkUnplayedResponse res = sdk.media().markUnplayed()
@@ -146,11 +136,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
UpdatePlayProgressResponse res = sdk.media().updatePlayProgress()
@@ -206,11 +191,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetBannerImageRequest req = GetBannerImageRequest.builder()
@@ -273,11 +253,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetThumbImageRequest req = GetThumbImageRequest.builder()

View File

@@ -48,11 +48,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
CreatePlaylistRequest req = CreatePlaylistRequest.builder()
@@ -114,11 +109,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetPlaylistsResponse res = sdk.playlists().getPlaylists()
@@ -175,11 +165,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetPlaylistResponse res = sdk.playlists().getPlaylist()
@@ -233,11 +218,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
DeletePlaylistResponse res = sdk.playlists().deletePlaylist()
@@ -289,15 +269,10 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
UpdatePlaylistResponse res = sdk.playlists().updatePlaylist()
.playlistID(3915.00d)
.playlistID(3915d)
.title("<value>")
.summary("<value>")
.call();
@@ -353,11 +328,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetPlaylistContentsResponse res = sdk.playlists().getPlaylistContents()
@@ -413,11 +383,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
ClearPlaylistContentsResponse res = sdk.playlists().clearPlaylistContents()
@@ -470,15 +435,10 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
AddPlaylistContentsResponse res = sdk.playlists().addPlaylistContents()
.playlistID(8502.00d)
.playlistID(8502.01d)
.uri("server://12345/com.plexapp.plugins.library/library/metadata/1")
.playQueueID(123d)
.call();
@@ -533,11 +493,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
UploadPlaylistResponse res = sdk.playlists().uploadPlaylist()

View File

@@ -37,11 +37,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetCompanionsDataResponse res = sdk.plex().getCompanionsData()
@@ -93,11 +88,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetUserFriendsResponse res = sdk.plex().getUserFriends()
@@ -148,11 +138,6 @@ public class Application {
public static void main(String[] args) throws GetGeoDataBadRequest, GetGeoDataUnauthorized, Exception {
PlexAPI sdk = PlexAPI.builder()
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetGeoDataResponse res = sdk.plex().getGeoData()
@@ -204,11 +189,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetHomeDataResponse res = sdk.plex().getHomeData()
@@ -257,11 +237,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetServerResourcesResponse res = sdk.plex().getServerResources()
@@ -285,7 +260,7 @@ public class Application {
| `includeHttps` | [Optional\<IncludeHttps>](../../models/operations/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `includeRelay` | [Optional\<IncludeRelay>](../../models/operations/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `includeIPv6` | [Optional\<IncludeIPv6>](../../models/operations/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `clientID` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `clientID` | *String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `serverURL` | *String* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response
@@ -320,14 +295,14 @@ public class Application {
public static void main(String[] args) throws GetPinBadRequest, Exception {
PlexAPI sdk = PlexAPI.builder()
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetPinRequest req = GetPinRequest.builder()
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.deviceNickname("Roku 3")
.clientVersion("2.4.1")
.platform("Roku")
.build();
GetPinResponse res = sdk.plex().getPin()
@@ -380,15 +355,15 @@ public class Application {
public static void main(String[] args) throws GetTokenByPinIdBadRequest, GetTokenByPinIdResponseBody, Exception {
PlexAPI sdk = PlexAPI.builder()
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetTokenByPinIdRequest req = GetTokenByPinIdRequest.builder()
.pinID(408895L)
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.deviceNickname("Roku 3")
.clientVersion("2.4.1")
.platform("Roku")
.build();
GetTokenByPinIdResponse res = sdk.plex().getTokenByPinId()

View File

@@ -26,3 +26,6 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
| 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) | -
### Available Operations

View File

@@ -45,16 +45,11 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
PerformSearchResponse res = sdk.search().performSearch()
.query("dylan")
.sectionId(9372.69d)
.sectionId(9487.88d)
.limit(5d)
.call();
@@ -108,16 +103,11 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
PerformVoiceSearchResponse res = sdk.search().performVoiceSearch()
.query("dead+poop")
.sectionId(4094.80d)
.sectionId(4094.8d)
.limit(5d)
.call();
@@ -167,11 +157,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetSearchResultsResponse res = sdk.search().getSearchResults()

View File

@@ -39,11 +39,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
@@ -89,11 +84,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetServerPreferencesResponse res = sdk.server().getServerPreferences()
@@ -139,11 +129,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetAvailableClientsResponse res = sdk.server().getAvailableClients()
@@ -189,11 +174,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetDevicesResponse res = sdk.server().getDevices()
@@ -237,11 +217,6 @@ public class Application {
public static void main(String[] args) throws GetServerIdentityRequestTimeout, Exception {
PlexAPI sdk = PlexAPI.builder()
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetServerIdentityResponse res = sdk.server().getServerIdentity()
@@ -286,11 +261,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetMyPlexAccountResponse res = sdk.server().getMyPlexAccount()
@@ -340,19 +310,14 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetResizedPhotoRequest req = GetResizedPhotoRequest.builder()
.width(110d)
.height(165d)
.opacity(100L)
.blur(20d)
.minSize(MinSize.ZERO)
.blur(0d)
.minSize(MinSize.ONE)
.upscale(Upscale.ONE)
.url("/library/metadata/49564/thumb/1654258204")
.build();
@@ -405,11 +370,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetMediaProvidersResponse res = sdk.server().getMediaProviders()
@@ -462,11 +422,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetServerListResponse res = sdk.server().getServerList()

View File

@@ -34,11 +34,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetSessionsResponse res = sdk.sessions().getSessions()
@@ -85,15 +80,10 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetSessionHistoryResponse res = sdk.sessions().getSessionHistory()
.sort("<value>")
.sort("viewedAt:desc")
.accountId(1L)
.filter(QueryParamFilter.builder()
.build())
@@ -149,11 +139,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetTranscodeSessionsResponse res = sdk.sessions().getTranscodeSessions()
@@ -199,11 +184,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
StopTranscodeSessionResponse res = sdk.sessions().stopTranscodeSession()

View File

@@ -33,11 +33,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetStatisticsResponse res = sdk.statistics().getStatistics()
@@ -90,11 +85,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetResourcesStatisticsResponse res = sdk.statistics().getResourcesStatistics()
@@ -147,11 +137,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetBandwidthStatisticsResponse res = sdk.statistics().getBandwidthStatistics()

View File

@@ -34,11 +34,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetUpdateStatusResponse res = sdk.updater().getUpdateStatus()
@@ -85,11 +80,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
CheckForUpdatesResponse res = sdk.updater().checkForUpdates()
@@ -143,11 +133,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
ApplyUpdatesResponse res = sdk.updater().applyUpdates()

77
docs/sdks/users/README.md Normal file
View File

@@ -0,0 +1,77 @@
# Users
(*users()*)
## Overview
### Available Operations
* [getUsers](#getusers) - Get list of all connected users
## getUsers
Get list of all users that are friends and have library access with the provided Plex authentication token
### Example Usage
```java
package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.GetUsersBadRequest;
import dev.plexapi.sdk.models.errors.GetUsersUnauthorized;
import dev.plexapi.sdk.models.operations.GetUsersRequest;
import dev.plexapi.sdk.models.operations.GetUsersResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws GetUsersBadRequest, GetUsersUnauthorized, Exception {
PlexAPI sdk = PlexAPI.builder()
.build();
GetUsersRequest req = GetUsersRequest.builder()
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.xPlexToken("CV5xoxjTpFKUzBTShsaf")
.clientName("Plex for Roku")
.deviceNickname("Roku 3")
.deviceName("Chrome")
.deviceScreenResolution("1487x1165,2560x1440")
.clientVersion("2.4.1")
.platform("Roku")
.clientFeatures("external-media,indirect-media,hub-style-list")
.model("4200X")
.xPlexSessionId("97e136ef-4ddd-4ff3-89a7-a5820c96c2ca")
.xPlexLanguage("en")
.platformVersion("4.3 build 1057")
.build();
GetUsersResponse res = sdk.users().getUsers()
.request(req)
.call();
if (res.body().isPresent()) {
// handle response
}
}
}
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| `request` | [GetUsersRequest](../../models/operations/GetUsersRequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `serverURL` | *String* | :heavy_minus_sign: | An optional server URL to use. |
### Response
**[GetUsersResponse](../../models/operations/GetUsersResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| models/errors/GetUsersBadRequest | 400 | application/json |
| models/errors/GetUsersUnauthorized | 401 | application/json |
| models/errors/SDKError | 4XX, 5XX | \*/\* |

View File

@@ -34,11 +34,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetTimelineRequest req = GetTimelineRequest.builder()
@@ -103,11 +98,6 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
StartUniversalTranscodeRequest req = StartUniversalTranscodeRequest.builder()

View File

@@ -33,18 +33,11 @@ public class Application {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.clientName("Plex for Roku")
.clientVersion("2.4.1")
.platform("Roku")
.deviceNickname("Roku 3")
.build();
GetWatchListRequest req = GetWatchListRequest.builder()
.filter(Filter.AVAILABLE)
.xPlexToken("CV5xoxjTpFKUzBTShsaf")
.xPlexContainerStart(0)
.xPlexContainerSize(50)
.build();
GetWatchListResponse res = sdk.watchlist().getWatchList()

View File

@@ -78,10 +78,10 @@ public class Activities implements
_req.addHeader("Accept", "application/json")
.addHeader("user-agent",
SDKConfiguration.USER_AGENT);
Optional<SecuritySource> _hookSecuritySource = this.sdkConfiguration.securitySource();
Utils.configureSecurity(_req,
this.sdkConfiguration.securitySource.getSecurity());
HTTPClient _client = this.sdkConfiguration.defaultClient;
HttpRequest _r =
sdkConfiguration.hooks()
@@ -89,7 +89,7 @@ public class Activities implements
new BeforeRequestContextImpl(
"getServerActivities",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
_req.build());
HttpResponse<InputStream> _httpRes;
try {
@@ -100,7 +100,7 @@ public class Activities implements
new AfterErrorContextImpl(
"getServerActivities",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
Optional.of(_httpRes),
Optional.empty());
} else {
@@ -109,7 +109,7 @@ public class Activities implements
new AfterSuccessContextImpl(
"getServerActivities",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
_httpRes);
}
} catch (Exception _e) {
@@ -118,7 +118,7 @@ public class Activities implements
new AfterErrorContextImpl(
"getServerActivities",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
Optional.empty(),
Optional.of(_e));
}
@@ -182,7 +182,15 @@ public class Activities implements
Utils.extractByteArrayFromBody(_httpRes));
}
}
if (Utils.statusCodeMatches(_httpRes.statusCode(), "4XX", "5XX")) {
if (Utils.statusCodeMatches(_httpRes.statusCode(), "4XX")) {
// no content
throw new SDKError(
_httpRes,
_httpRes.statusCode(),
"API error occurred",
Utils.extractByteArrayFromBody(_httpRes));
}
if (Utils.statusCodeMatches(_httpRes.statusCode(), "5XX")) {
// no content
throw new SDKError(
_httpRes,
@@ -229,16 +237,16 @@ public class Activities implements
CancelServerActivitiesRequest.class,
_baseUrl,
"/activities/{activityUUID}",
request, this.sdkConfiguration.globals);
request, null);
HTTPRequest _req = new HTTPRequest(_url, "DELETE");
_req.addHeader("Accept", "application/json")
.addHeader("user-agent",
SDKConfiguration.USER_AGENT);
Optional<SecuritySource> _hookSecuritySource = this.sdkConfiguration.securitySource();
Utils.configureSecurity(_req,
this.sdkConfiguration.securitySource.getSecurity());
HTTPClient _client = this.sdkConfiguration.defaultClient;
HttpRequest _r =
sdkConfiguration.hooks()
@@ -246,7 +254,7 @@ public class Activities implements
new BeforeRequestContextImpl(
"cancelServerActivities",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
_req.build());
HttpResponse<InputStream> _httpRes;
try {
@@ -257,7 +265,7 @@ public class Activities implements
new AfterErrorContextImpl(
"cancelServerActivities",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
Optional.of(_httpRes),
Optional.empty());
} else {
@@ -266,7 +274,7 @@ public class Activities implements
new AfterSuccessContextImpl(
"cancelServerActivities",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
_httpRes);
}
} catch (Exception _e) {
@@ -275,7 +283,7 @@ public class Activities implements
new AfterErrorContextImpl(
"cancelServerActivities",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
Optional.empty(),
Optional.of(_e));
}
@@ -328,7 +336,15 @@ public class Activities implements
Utils.extractByteArrayFromBody(_httpRes));
}
}
if (Utils.statusCodeMatches(_httpRes.statusCode(), "4XX", "5XX")) {
if (Utils.statusCodeMatches(_httpRes.statusCode(), "4XX")) {
// no content
throw new SDKError(
_httpRes,
_httpRes.statusCode(),
"API error occurred",
Utils.extractByteArrayFromBody(_httpRes));
}
if (Utils.statusCodeMatches(_httpRes.statusCode(), "5XX")) {
// no content
throw new SDKError(
_httpRes,

View File

@@ -122,11 +122,11 @@ public class Authentication implements
_req.addQueryParams(Utils.getQueryParams(
GetTransientTokenRequest.class,
request,
this.sdkConfiguration.globals));
null));
Optional<SecuritySource> _hookSecuritySource = this.sdkConfiguration.securitySource();
Utils.configureSecurity(_req,
this.sdkConfiguration.securitySource.getSecurity());
HTTPClient _client = this.sdkConfiguration.defaultClient;
HttpRequest _r =
sdkConfiguration.hooks()
@@ -134,7 +134,7 @@ public class Authentication implements
new BeforeRequestContextImpl(
"getTransientToken",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
_req.build());
HttpResponse<InputStream> _httpRes;
try {
@@ -145,7 +145,7 @@ public class Authentication implements
new AfterErrorContextImpl(
"getTransientToken",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
Optional.of(_httpRes),
Optional.empty());
} else {
@@ -154,7 +154,7 @@ public class Authentication implements
new AfterSuccessContextImpl(
"getTransientToken",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
_httpRes);
}
} catch (Exception _e) {
@@ -163,7 +163,7 @@ public class Authentication implements
new AfterErrorContextImpl(
"getTransientToken",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
Optional.empty(),
Optional.of(_e));
}
@@ -216,7 +216,15 @@ public class Authentication implements
Utils.extractByteArrayFromBody(_httpRes));
}
}
if (Utils.statusCodeMatches(_httpRes.statusCode(), "4XX", "5XX")) {
if (Utils.statusCodeMatches(_httpRes.statusCode(), "4XX")) {
// no content
throw new SDKError(
_httpRes,
_httpRes.statusCode(),
"API error occurred",
Utils.extractByteArrayFromBody(_httpRes));
}
if (Utils.statusCodeMatches(_httpRes.statusCode(), "5XX")) {
// no content
throw new SDKError(
_httpRes,
@@ -275,11 +283,11 @@ public class Authentication implements
_req.addQueryParams(Utils.getQueryParams(
GetSourceConnectionInformationRequest.class,
request,
this.sdkConfiguration.globals));
null));
Optional<SecuritySource> _hookSecuritySource = this.sdkConfiguration.securitySource();
Utils.configureSecurity(_req,
this.sdkConfiguration.securitySource.getSecurity());
HTTPClient _client = this.sdkConfiguration.defaultClient;
HttpRequest _r =
sdkConfiguration.hooks()
@@ -287,7 +295,7 @@ public class Authentication implements
new BeforeRequestContextImpl(
"getSourceConnectionInformation",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
_req.build());
HttpResponse<InputStream> _httpRes;
try {
@@ -298,7 +306,7 @@ public class Authentication implements
new AfterErrorContextImpl(
"getSourceConnectionInformation",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
Optional.of(_httpRes),
Optional.empty());
} else {
@@ -307,7 +315,7 @@ public class Authentication implements
new AfterSuccessContextImpl(
"getSourceConnectionInformation",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
_httpRes);
}
} catch (Exception _e) {
@@ -316,7 +324,7 @@ public class Authentication implements
new AfterErrorContextImpl(
"getSourceConnectionInformation",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
Optional.empty(),
Optional.of(_e));
}
@@ -369,7 +377,15 @@ public class Authentication implements
Utils.extractByteArrayFromBody(_httpRes));
}
}
if (Utils.statusCodeMatches(_httpRes.statusCode(), "4XX", "5XX")) {
if (Utils.statusCodeMatches(_httpRes.statusCode(), "4XX")) {
// no content
throw new SDKError(
_httpRes,
_httpRes.statusCode(),
"API error occurred",
Utils.extractByteArrayFromBody(_httpRes));
}
if (Utils.statusCodeMatches(_httpRes.statusCode(), "5XX")) {
// no content
throw new SDKError(
_httpRes,
@@ -426,10 +442,10 @@ public class Authentication implements
_req.addHeader("Accept", "application/json")
.addHeader("user-agent",
SDKConfiguration.USER_AGENT);
Optional<SecuritySource> _hookSecuritySource = this.sdkConfiguration.securitySource();
Utils.configureSecurity(_req,
this.sdkConfiguration.securitySource.getSecurity());
HTTPClient _client = this.sdkConfiguration.defaultClient;
HttpRequest _r =
sdkConfiguration.hooks()
@@ -437,7 +453,7 @@ public class Authentication implements
new BeforeRequestContextImpl(
"getTokenDetails",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
_req.build());
HttpResponse<InputStream> _httpRes;
try {
@@ -448,7 +464,7 @@ public class Authentication implements
new AfterErrorContextImpl(
"getTokenDetails",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
Optional.of(_httpRes),
Optional.empty());
} else {
@@ -457,7 +473,7 @@ public class Authentication implements
new AfterSuccessContextImpl(
"getTokenDetails",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
_httpRes);
}
} catch (Exception _e) {
@@ -466,7 +482,7 @@ public class Authentication implements
new AfterErrorContextImpl(
"getTokenDetails",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
Optional.empty(),
Optional.of(_e));
}
@@ -530,7 +546,15 @@ public class Authentication implements
Utils.extractByteArrayFromBody(_httpRes));
}
}
if (Utils.statusCodeMatches(_httpRes.statusCode(), "4XX", "5XX")) {
if (Utils.statusCodeMatches(_httpRes.statusCode(), "4XX")) {
// no content
throw new SDKError(
_httpRes,
_httpRes.statusCode(),
"API error occurred",
Utils.extractByteArrayFromBody(_httpRes));
}
if (Utils.statusCodeMatches(_httpRes.statusCode(), "5XX")) {
// no content
throw new SDKError(
_httpRes,
@@ -601,8 +625,8 @@ public class Authentication implements
_req.addHeader("Accept", "application/json")
.addHeader("user-agent",
SDKConfiguration.USER_AGENT);
_req.addHeaders(Utils.getHeadersFromMetadata(request, this.sdkConfiguration.globals));
_req.addHeaders(Utils.getHeadersFromMetadata(request, null));
Optional<SecuritySource> _hookSecuritySource = Optional.empty();
HTTPClient _client = this.sdkConfiguration.defaultClient;
HttpRequest _r =
sdkConfiguration.hooks()
@@ -610,7 +634,7 @@ public class Authentication implements
new BeforeRequestContextImpl(
"post-users-sign-in-data",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
_req.build());
HttpResponse<InputStream> _httpRes;
try {
@@ -621,7 +645,7 @@ public class Authentication implements
new AfterErrorContextImpl(
"post-users-sign-in-data",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
Optional.of(_httpRes),
Optional.empty());
} else {
@@ -630,7 +654,7 @@ public class Authentication implements
new AfterSuccessContextImpl(
"post-users-sign-in-data",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
_httpRes);
}
} catch (Exception _e) {
@@ -639,7 +663,7 @@ public class Authentication implements
new AfterErrorContextImpl(
"post-users-sign-in-data",
Optional.of(List.of()),
sdkConfiguration.securitySource()),
_hookSecuritySource),
Optional.empty(),
Optional.of(_e));
}
@@ -703,7 +727,15 @@ public class Authentication implements
Utils.extractByteArrayFromBody(_httpRes));
}
}
if (Utils.statusCodeMatches(_httpRes.statusCode(), "4XX", "5XX")) {
if (Utils.statusCodeMatches(_httpRes.statusCode(), "4XX")) {
// no content
throw new SDKError(
_httpRes,
_httpRes.statusCode(),
"API error occurred",
Utils.extractByteArrayFromBody(_httpRes));
}
if (Utils.statusCodeMatches(_httpRes.statusCode(), "5XX")) {
// no content
throw new SDKError(
_httpRes,

Some files were not shown because too many files have changed in this diff Show More