mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 20:47:45 +00:00
Compare commits
19 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
81ecd024e7 | ||
|
|
c7a69e0673 | ||
|
|
820f55d192 | ||
|
|
aa85c1813b | ||
|
|
84fb18428a | ||
|
|
37569715a6 | ||
|
|
c0e915da8b | ||
|
|
0077561a6a | ||
|
|
4b28ca3416 | ||
|
|
dd781d1e27 | ||
|
|
dcdcafc044 | ||
|
|
04db2979db | ||
|
|
c2eeb488c4 | ||
|
|
8194abfa99 | ||
|
|
26e1ac258e | ||
|
|
bf77d1e2b9 | ||
|
|
3523b6a0c8 | ||
|
|
a4a2130978 | ||
|
|
f33408b177 |
1
.gitattributes
vendored
1
.gitattributes
vendored
@@ -9,4 +9,3 @@
|
||||
|
||||
# This allows generated code to be indexed correctly
|
||||
*.java linguist-generated=false
|
||||
|
||||
|
||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -1,3 +1,7 @@
|
||||
.env
|
||||
.env.local
|
||||
**/.speakeasy/temp/
|
||||
**/.speakeasy/logs/
|
||||
.speakeasy/reports
|
||||
# Ignore Gradle project-specific cache directory
|
||||
.gradle
|
||||
|
||||
9200
.speakeasy/gen.lock
9200
.speakeasy/gen.lock
File diff suppressed because one or more lines are too long
@@ -4,25 +4,39 @@ generation:
|
||||
maintainOpenAPIOrder: true
|
||||
usageSnippets:
|
||||
optionalPropertyRendering: withExample
|
||||
sdkInitStyle: constructor
|
||||
useClassNamesForArrayFields: true
|
||||
fixes:
|
||||
nameResolutionDec2023: true
|
||||
nameResolutionFeb2025: false
|
||||
parameterOrderingFeb2024: true
|
||||
requestResponseComponentNamesFeb2024: true
|
||||
securityFeb2025: false
|
||||
sharedErrorComponentsApr2025: false
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
oAuth2PasswordEnabled: false
|
||||
hoistGlobalSecurity: true
|
||||
tests:
|
||||
generateTests: true
|
||||
generateNewTests: false
|
||||
skipResponseBodyAssertions: false
|
||||
java:
|
||||
version: 0.11.3
|
||||
version: 0.19.1
|
||||
additionalDependencies: []
|
||||
additionalPlugins: []
|
||||
artifactID: plexapi
|
||||
asyncMode: enabled
|
||||
baseErrorName: PlexAPIError
|
||||
clientServerStatusCodesAsErrors: true
|
||||
companyEmail: lukeslakemail@gmail.com
|
||||
companyName: plexapi
|
||||
companyURL: plexapi.dev
|
||||
defaultErrorName: SDKError
|
||||
enableCustomCodeRegions: false
|
||||
enableStreamingUploads: false
|
||||
flattenGlobalSecurity: true
|
||||
generateSpringBootStarter: true
|
||||
githubURL: github.com/LukeHagar/plexjava
|
||||
groupID: dev.plexapi
|
||||
imports:
|
||||
@@ -34,11 +48,13 @@ java:
|
||||
shared: models/shared
|
||||
webhooks: models/webhooks
|
||||
inputModelSuffix: input
|
||||
languageVersion: 11
|
||||
license:
|
||||
name: The MIT License (MIT)
|
||||
shortName: MIT
|
||||
url: https://mit-license.org/
|
||||
maxMethodParams: 4
|
||||
nullFriendlyParameters: false
|
||||
outputModelSuffix: output
|
||||
packageName: dev.plexapi.sdk
|
||||
projectName: plexapi
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.476.1
|
||||
speakeasyVersion: 1.615.2
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
@@ -8,26 +8,29 @@ sources:
|
||||
- latest
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:e73707dfae50d22dab2166b1661938446b9831bcee252ecd696a1172dfd6ae2c
|
||||
sourceBlobDigest: sha256:e06caa091ad527fd21714fc0d43e7ea385e181fbad8c4f60296457a89a23c696
|
||||
sourceRevisionDigest: sha256:bc60551015634fd59475cf17983ca3aedcab591426d526ab1e3634b1feedaec1
|
||||
sourceBlobDigest: sha256:fc8cd5343a94564b646830738f38e065d61e2ea63e4a1383ce07533586889950
|
||||
tags:
|
||||
- latest
|
||||
- speakeasy-sdk-regen-1737937609
|
||||
- speakeasy-sdk-regen-1760251795
|
||||
- 1.1.1
|
||||
targets:
|
||||
plexjava:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:e73707dfae50d22dab2166b1661938446b9831bcee252ecd696a1172dfd6ae2c
|
||||
sourceBlobDigest: sha256:e06caa091ad527fd21714fc0d43e7ea385e181fbad8c4f60296457a89a23c696
|
||||
sourceRevisionDigest: sha256:bc60551015634fd59475cf17983ca3aedcab591426d526ab1e3634b1feedaec1
|
||||
sourceBlobDigest: sha256:fc8cd5343a94564b646830738f38e065d61e2ea63e4a1383ce07533586889950
|
||||
codeSamplesNamespace: code-samples-java-plexjava
|
||||
codeSamplesRevisionDigest: sha256:88e5ff78d25261d63cd6b797a5176884e5606d54b7ff8bade974b8464a274a94
|
||||
codeSamplesRevisionDigest: sha256:b2a3306d8dbea9843d858a4e35373df6988c2c0cf53086ae4cd2072c2c8ffb06
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
sources:
|
||||
plexapi:
|
||||
inputs:
|
||||
- location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main
|
||||
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/plex-api-spec.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
|
||||
targets:
|
||||
plexjava:
|
||||
target: java
|
||||
@@ -42,3 +45,5 @@ workflow:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
|
||||
labelOverride:
|
||||
fixedValue: PlexJava
|
||||
|
||||
@@ -3,7 +3,9 @@ speakeasyVersion: latest
|
||||
sources:
|
||||
plexapi:
|
||||
inputs:
|
||||
- location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main
|
||||
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/plex-api-spec.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
|
||||
targets:
|
||||
plexjava:
|
||||
target: java
|
||||
@@ -18,3 +20,5 @@ targets:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
|
||||
labelOverride:
|
||||
fixedValue: PlexJava
|
||||
|
||||
813
README.md
813
README.md
@@ -11,47 +11,21 @@
|
||||
<!-- Start Summary [summary] -->
|
||||
## Summary
|
||||
|
||||
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
||||
|
||||
# Plex Media Server OpenAPI Specification
|
||||
|
||||
An Open Source OpenAPI Specification for Plex Media Server
|
||||
|
||||
Automation and SDKs provided by [Speakeasy](https://speakeasyapi.dev/)
|
||||
|
||||
## Documentation
|
||||
|
||||
[API Documentation](https://plexapi.dev)
|
||||
|
||||
## SDKs
|
||||
|
||||
The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the [main specification Repository](https://github.com/LukeHagar/plex-api-spec).
|
||||
|
||||
| Language | Repository | Releases | Other |
|
||||
| --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
|
||||
| Python | [GitHub](https://github.com/LukeHagar/plexpy) | [PyPI](https://pypi.org/project/plex-api-client/) | - |
|
||||
| JavaScript/TypeScript | [GitHub](https://github.com/LukeHagar/plexjs) | [NPM](https://www.npmjs.com/package/@lukehagar/plexjs) \ [JSR](https://jsr.io/@lukehagar/plexjs) | - |
|
||||
| Go | [GitHub](https://github.com/LukeHagar/plexgo) | [Releases](https://github.com/LukeHagar/plexgo/releases) | [GoDoc](https://pkg.go.dev/github.com/LukeHagar/plexgo) |
|
||||
| Ruby | [GitHub](https://github.com/LukeHagar/plexruby) | [Releases](https://github.com/LukeHagar/plexruby/releases) | - |
|
||||
| Swift | [GitHub](https://github.com/LukeHagar/plexswift) | [Releases](https://github.com/LukeHagar/plexswift/releases) | - |
|
||||
| PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - |
|
||||
| Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - |
|
||||
| C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -
|
||||
<!-- End Summary [summary] -->
|
||||
|
||||
<!-- 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)
|
||||
* [Asynchronous Support](#asynchronous-support)
|
||||
* [Authentication](#authentication)
|
||||
* [Debugging](#debugging)
|
||||
* [Development](#development)
|
||||
* [Maturity](#maturity)
|
||||
* [Contributions](#contributions)
|
||||
@@ -69,7 +43,7 @@ The samples below show how a published SDK artifact is used:
|
||||
|
||||
Gradle:
|
||||
```groovy
|
||||
implementation 'dev.plexapi:plexapi:0.11.3'
|
||||
implementation 'dev.plexapi:plexapi:0.19.1'
|
||||
```
|
||||
|
||||
Maven:
|
||||
@@ -77,7 +51,7 @@ Maven:
|
||||
<dependency>
|
||||
<groupId>dev.plexapi</groupId>
|
||||
<artifactId>plexapi</artifactId>
|
||||
<version>0.11.3</version>
|
||||
<version>0.19.1</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
@@ -105,28 +79,120 @@ gradlew.bat publishToMavenLocal -Pskip.signing
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetServerCapabilitiesResponse;
|
||||
import dev.plexapi.sdk.models.operations.*;
|
||||
import dev.plexapi.sdk.models.shared.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {
|
||||
public static void main(String[] args) throws Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.accepts(Accepts.APPLICATION_XML)
|
||||
.clientIdentifier("abc123")
|
||||
.product("Plex for Roku")
|
||||
.version("2.4.1")
|
||||
.platform("Roku")
|
||||
.platformVersion("4.3 build 1057")
|
||||
.device("Roku 3")
|
||||
.model("4200X")
|
||||
.deviceVendor("Roku")
|
||||
.deviceName("Living Room TV")
|
||||
.marketplace("googlePlay")
|
||||
.token(System.getenv().getOrDefault("TOKEN", ""))
|
||||
.build();
|
||||
|
||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||
StartTranscodeSessionRequest req = StartTranscodeSessionRequest.builder()
|
||||
.transcodeType(TranscodeType.MUSIC)
|
||||
.extension(Extension.MPD)
|
||||
.advancedSubtitles(AdvancedSubtitles.BURN)
|
||||
.audioBoost(50L)
|
||||
.audioChannelCount(5L)
|
||||
.autoAdjustQuality(BoolInt.ONE)
|
||||
.autoAdjustSubtitle(BoolInt.ONE)
|
||||
.directPlay(BoolInt.ONE)
|
||||
.directStream(BoolInt.ONE)
|
||||
.directStreamAudio(BoolInt.ONE)
|
||||
.disableResolutionRotation(BoolInt.ONE)
|
||||
.hasMDE(BoolInt.ONE)
|
||||
.location(StartTranscodeSessionQueryParamLocation.WAN)
|
||||
.mediaBufferSize(102400L)
|
||||
.mediaIndex(0L)
|
||||
.musicBitrate(5000L)
|
||||
.offset(90.5)
|
||||
.partIndex(0L)
|
||||
.path("/library/metadata/151671")
|
||||
.peakBitrate(12000L)
|
||||
.photoResolution("1080x1080")
|
||||
.protocol(StartTranscodeSessionQueryParamProtocol.DASH)
|
||||
.secondsPerSegment(5L)
|
||||
.subtitleSize(50L)
|
||||
.videoBitrate(12000L)
|
||||
.videoQuality(50L)
|
||||
.videoResolution("1080x1080")
|
||||
.xPlexClientProfileExtra("add-limitation(scope=videoCodec&scopeName=*&type=upperBound&name=video.frameRate&value=60&replace=true)+append-transcode-target-codec(type=videoProfile&context=streaming&videoCodec=h264%2Chevc&audioCodec=aac&protocol=dash)")
|
||||
.xPlexClientProfileName("generic")
|
||||
.build();
|
||||
|
||||
StartTranscodeSessionResponse res = sdk.transcoder().startTranscodeSession()
|
||||
.request(req)
|
||||
.call();
|
||||
|
||||
if (res.object().isPresent()) {
|
||||
if (res.responseStream().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
#### Asynchronous Call
|
||||
An asynchronous SDK client is also available that returns a [`CompletableFuture<T>`][comp-fut]. See [Asynchronous Support](#asynchronous-support) for more details on async benefits and reactive library integration.
|
||||
```java
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.sdk.AsyncPlexAPI;
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.operations.GetServerInfoRequest;
|
||||
import dev.plexapi.sdk.models.operations.async.GetServerInfoResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import java.util.concurrent.CompletableFuture;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) {
|
||||
|
||||
AsyncPlexAPI sdk = PlexAPI.builder()
|
||||
.accepts(Accepts.APPLICATION_XML)
|
||||
.clientIdentifier("abc123")
|
||||
.product("Plex for Roku")
|
||||
.version("2.4.1")
|
||||
.platform("Roku")
|
||||
.platformVersion("4.3 build 1057")
|
||||
.device("Roku 3")
|
||||
.model("4200X")
|
||||
.deviceVendor("Roku")
|
||||
.deviceName("Living Room TV")
|
||||
.marketplace("googlePlay")
|
||||
.token(System.getenv().getOrDefault("TOKEN", ""))
|
||||
.build()
|
||||
.async();
|
||||
|
||||
GetServerInfoRequest req = GetServerInfoRequest.builder()
|
||||
.build();
|
||||
|
||||
CompletableFuture<GetServerInfoResponse> resFut = sdk.general().getServerInfo()
|
||||
.request(req)
|
||||
.call();
|
||||
|
||||
resFut.thenAccept(res -> {
|
||||
if (res.mediaContainerWithDirectory().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
[comp-fut]: https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html
|
||||
<!-- End SDK Example Usage [usage] -->
|
||||
|
||||
<!-- Start Available Resources and Operations [operations] -->
|
||||
@@ -137,128 +203,324 @@ public class Application {
|
||||
|
||||
### [activities()](docs/sdks/activities/README.md)
|
||||
|
||||
* [getServerActivities](docs/sdks/activities/README.md#getserveractivities) - Get Server Activities
|
||||
* [cancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities) - Cancel Server Activities
|
||||
|
||||
### [authentication()](docs/sdks/authentication/README.md)
|
||||
|
||||
* [getTransientToken](docs/sdks/authentication/README.md#gettransienttoken) - Get a Transient Token
|
||||
* [getSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation) - Get Source Connection Information
|
||||
* [getTokenDetails](docs/sdks/authentication/README.md#gettokendetails) - Get Token Details
|
||||
* [postUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata) - Get User Sign In Data
|
||||
* [listActivities](docs/sdks/activities/README.md#listactivities) - Get all activities
|
||||
* [cancelActivity](docs/sdks/activities/README.md#cancelactivity) - Cancel a running activity
|
||||
|
||||
### [butler()](docs/sdks/butler/README.md)
|
||||
|
||||
* [getButlerTasks](docs/sdks/butler/README.md#getbutlertasks) - Get Butler tasks
|
||||
* [startAllTasks](docs/sdks/butler/README.md#startalltasks) - Start all Butler tasks
|
||||
* [stopAllTasks](docs/sdks/butler/README.md#stopalltasks) - Stop all Butler tasks
|
||||
* [startTask](docs/sdks/butler/README.md#starttask) - Start a single Butler task
|
||||
* [stopTasks](docs/sdks/butler/README.md#stoptasks) - Stop all Butler tasks
|
||||
* [getTasks](docs/sdks/butler/README.md#gettasks) - Get all Butler tasks
|
||||
* [startTasks](docs/sdks/butler/README.md#starttasks) - Start all Butler tasks
|
||||
* [stopTask](docs/sdks/butler/README.md#stoptask) - Stop a single Butler task
|
||||
* [startTask](docs/sdks/butler/README.md#starttask) - Start a single Butler task
|
||||
|
||||
### [collections()](docs/sdks/collections/README.md)
|
||||
|
||||
* [createCollection](docs/sdks/collections/README.md#createcollection) - Create collection
|
||||
|
||||
### [content()](docs/sdks/content/README.md)
|
||||
|
||||
* [getCollectionItems](docs/sdks/content/README.md#getcollectionitems) - Get items in a collection
|
||||
* [getMetadataItem](docs/sdks/content/README.md#getmetadataitem) - Get a metadata item
|
||||
* [getAlbums](docs/sdks/content/README.md#getalbums) - Set section albums
|
||||
* [listContent](docs/sdks/content/README.md#listcontent) - Get items in the section
|
||||
* [getAllLeaves](docs/sdks/content/README.md#getallleaves) - Set section leaves
|
||||
* [getArts](docs/sdks/content/README.md#getarts) - Set section artwork
|
||||
* [getCategories](docs/sdks/content/README.md#getcategories) - Set section categories
|
||||
* [getCluster](docs/sdks/content/README.md#getcluster) - Set section clusters
|
||||
* [getSonicPath](docs/sdks/content/README.md#getsonicpath) - Similar tracks to transition from one to another
|
||||
* [getFolders](docs/sdks/content/README.md#getfolders) - Get all folder locations
|
||||
* [listMoments](docs/sdks/content/README.md#listmoments) - Set section moments
|
||||
* [getSonicallySimilar](docs/sdks/content/README.md#getsonicallysimilar) - The nearest audio tracks
|
||||
* [getCollectionImage](docs/sdks/content/README.md#getcollectionimage) - Get a collection's image
|
||||
|
||||
### [devices()](docs/sdks/devices/README.md)
|
||||
|
||||
* [getAvailableGrabbers](docs/sdks/devices/README.md#getavailablegrabbers) - Get available grabbers
|
||||
* [listDevices](docs/sdks/devices/README.md#listdevices) - Get all devices
|
||||
* [addDevice](docs/sdks/devices/README.md#adddevice) - Add a device
|
||||
* [discoverDevices](docs/sdks/devices/README.md#discoverdevices) - Tell grabbers to discover devices
|
||||
* [removeDevice](docs/sdks/devices/README.md#removedevice) - Remove a device
|
||||
* [getDeviceDetails](docs/sdks/devices/README.md#getdevicedetails) - Get device details
|
||||
* [modifyDevice](docs/sdks/devices/README.md#modifydevice) - Enable or disable a device
|
||||
* [setChannelmap](docs/sdks/devices/README.md#setchannelmap) - Set a device's channel mapping
|
||||
* [getDevicesChannels](docs/sdks/devices/README.md#getdeviceschannels) - Get a device's channels
|
||||
* [setDevicePreferences](docs/sdks/devices/README.md#setdevicepreferences) - Set device preferences
|
||||
* [stopScan](docs/sdks/devices/README.md#stopscan) - Tell a device to stop scanning for channels
|
||||
* [scan](docs/sdks/devices/README.md#scan) - Tell a device to scan for channels
|
||||
* [getThumb](docs/sdks/devices/README.md#getthumb) - Get device thumb
|
||||
|
||||
### [downloadQueue()](docs/sdks/downloadqueue/README.md)
|
||||
|
||||
* [createDownloadQueue](docs/sdks/downloadqueue/README.md#createdownloadqueue) - Create download queue
|
||||
* [getDownloadQueue](docs/sdks/downloadqueue/README.md#getdownloadqueue) - Get a download queue
|
||||
* [addDownloadQueueItems](docs/sdks/downloadqueue/README.md#adddownloadqueueitems) - Add to download queue
|
||||
* [listDownloadQueueItems](docs/sdks/downloadqueue/README.md#listdownloadqueueitems) - Get download queue items
|
||||
* [getItemDecision](docs/sdks/downloadqueue/README.md#getitemdecision) - Grab download queue item decision
|
||||
* [getDownloadQueueMedia](docs/sdks/downloadqueue/README.md#getdownloadqueuemedia) - Grab download queue media
|
||||
* [removeDownloadQueueItems](docs/sdks/downloadqueue/README.md#removedownloadqueueitems) - Delete download queue items
|
||||
* [getDownloadQueueItems](docs/sdks/downloadqueue/README.md#getdownloadqueueitems) - Get download queue items
|
||||
* [restartProcessingDownloadQueueItems](docs/sdks/downloadqueue/README.md#restartprocessingdownloadqueueitems) - Restart processing of items from the decision
|
||||
|
||||
### [dvRs()](docs/sdks/dvrs/README.md)
|
||||
|
||||
* [listDVRs](docs/sdks/dvrs/README.md#listdvrs) - Get DVRs
|
||||
* [createDVR](docs/sdks/dvrs/README.md#createdvr) - Create a DVR
|
||||
* [deleteDVR](docs/sdks/dvrs/README.md#deletedvr) - Delete a single DVR
|
||||
* [getDVR](docs/sdks/dvrs/README.md#getdvr) - Get a single DVR
|
||||
* [deleteLineup](docs/sdks/dvrs/README.md#deletelineup) - Delete a DVR Lineup
|
||||
* [addLineup](docs/sdks/dvrs/README.md#addlineup) - Add a DVR Lineup
|
||||
* [setDVRPreferences](docs/sdks/dvrs/README.md#setdvrpreferences) - Set DVR preferences
|
||||
* [stopDVRReload](docs/sdks/dvrs/README.md#stopdvrreload) - Tell a DVR to stop reloading program guide
|
||||
* [reloadGuide](docs/sdks/dvrs/README.md#reloadguide) - Tell a DVR to reload program guide
|
||||
* [tuneChannel](docs/sdks/dvrs/README.md#tunechannel) - Tune a channel on a DVR
|
||||
* [removeDeviceFromDVR](docs/sdks/dvrs/README.md#removedevicefromdvr) - Remove a device from an existing DVR
|
||||
* [addDeviceToDVR](docs/sdks/dvrs/README.md#adddevicetodvr) - Add a device to an existing DVR
|
||||
|
||||
### [epg()](docs/sdks/epg/README.md)
|
||||
|
||||
* [computeChannelMap](docs/sdks/epg/README.md#computechannelmap) - Compute the best channel map
|
||||
* [getChannels](docs/sdks/epg/README.md#getchannels) - Get channels for a lineup
|
||||
* [getCountries](docs/sdks/epg/README.md#getcountries) - Get all countries
|
||||
* [getAllLanguages](docs/sdks/epg/README.md#getalllanguages) - Get all languages
|
||||
* [getLineup](docs/sdks/epg/README.md#getlineup) - Compute the best lineup
|
||||
* [getLineupChannels](docs/sdks/epg/README.md#getlineupchannels) - Get the channels for mulitple lineups
|
||||
* [getCountriesLineups](docs/sdks/epg/README.md#getcountrieslineups) - Get lineups for a country via postal code
|
||||
* [getCountryRegions](docs/sdks/epg/README.md#getcountryregions) - Get regions for a country
|
||||
* [listLineups](docs/sdks/epg/README.md#listlineups) - Get lineups for a region
|
||||
|
||||
### [events()](docs/sdks/events/README.md)
|
||||
|
||||
* [getNotifications](docs/sdks/events/README.md#getnotifications) - Connect to Eventsource
|
||||
* [connectWebSocket](docs/sdks/events/README.md#connectwebsocket) - Connect to WebSocket
|
||||
|
||||
### [general()](docs/sdks/general/README.md)
|
||||
|
||||
* [getServerInfo](docs/sdks/general/README.md#getserverinfo) - Get PMS info
|
||||
* [getIdentity](docs/sdks/general/README.md#getidentity) - Get PMS identity
|
||||
* [getSourceConnectionInformation](docs/sdks/general/README.md#getsourceconnectioninformation) - Get Source Connection Information
|
||||
* [getTransientToken](docs/sdks/general/README.md#gettransienttoken) - Get Transient Tokens
|
||||
|
||||
### [hubs()](docs/sdks/hubs/README.md)
|
||||
|
||||
* [getGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
|
||||
* [getRecentlyAdded](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
|
||||
* [getLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
||||
* [getAllHubs](docs/sdks/hubs/README.md#getallhubs) - Get global hubs
|
||||
* [getContinueWatching](docs/sdks/hubs/README.md#getcontinuewatching) - Get the continue watching hub
|
||||
* [getHubItems](docs/sdks/hubs/README.md#gethubitems) - Get a hub's items
|
||||
* [getPromotedHubs](docs/sdks/hubs/README.md#getpromotedhubs) - Get the hubs which are promoted
|
||||
* [getMetadataHubs](docs/sdks/hubs/README.md#getmetadatahubs) - Get hubs for section by metadata item
|
||||
* [getPostplayHubs](docs/sdks/hubs/README.md#getpostplayhubs) - Get postplay hubs
|
||||
* [getRelatedHubs](docs/sdks/hubs/README.md#getrelatedhubs) - Get related hubs
|
||||
* [getSectionHubs](docs/sdks/hubs/README.md#getsectionhubs) - Get section hubs
|
||||
* [resetSectionDefaults](docs/sdks/hubs/README.md#resetsectiondefaults) - Reset hubs to defaults
|
||||
* [listHubs](docs/sdks/hubs/README.md#listhubs) - Get hubs
|
||||
* [createCustomHub](docs/sdks/hubs/README.md#createcustomhub) - Create a custom hub
|
||||
* [moveHub](docs/sdks/hubs/README.md#movehub) - Move Hub
|
||||
* [deleteCustomHub](docs/sdks/hubs/README.md#deletecustomhub) - Delete a custom hub
|
||||
* [updateHubVisibility](docs/sdks/hubs/README.md#updatehubvisibility) - Change hub visibility
|
||||
|
||||
### [library()](docs/sdks/library/README.md)
|
||||
|
||||
* [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||
* [getRecentlyAddedLibrary](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
|
||||
* [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
||||
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get all items in library
|
||||
* [deleteCaches](docs/sdks/library/README.md#deletecaches) - Delete library caches
|
||||
* [cleanBundles](docs/sdks/library/README.md#cleanbundles) - Clean bundles
|
||||
* [ingestTransientItem](docs/sdks/library/README.md#ingesttransientitem) - Ingest a transient item
|
||||
* [getLibraryMatches](docs/sdks/library/README.md#getlibrarymatches) - Get library matches
|
||||
* [optimizeDatabase](docs/sdks/library/README.md#optimizedatabase) - Optimize the Database
|
||||
* [getRandomArtwork](docs/sdks/library/README.md#getrandomartwork) - Get random artwork
|
||||
* [getSections](docs/sdks/library/README.md#getsections) - Get library sections (main Media Provider Only)
|
||||
* [addSection](docs/sdks/library/README.md#addsection) - Add a library section
|
||||
* [stopAllRefreshes](docs/sdks/library/README.md#stopallrefreshes) - Stop refresh
|
||||
* [getSectionsPrefs](docs/sdks/library/README.md#getsectionsprefs) - Get section prefs
|
||||
* [refreshSectionsMetadata](docs/sdks/library/README.md#refreshsectionsmetadata) - Refresh all sections
|
||||
* [getTags](docs/sdks/library/README.md#gettags) - Get all library tags of a type
|
||||
* [deleteMetadataItem](docs/sdks/library/README.md#deletemetadataitem) - Delete a metadata item
|
||||
* [editMetadataItem](docs/sdks/library/README.md#editmetadataitem) - Edit a metadata item
|
||||
* [detectAds](docs/sdks/library/README.md#detectads) - Ad-detect an item
|
||||
* [getAllItemLeaves](docs/sdks/library/README.md#getallitemleaves) - Get the leaves of an item
|
||||
* [analyzeMetadata](docs/sdks/library/README.md#analyzemetadata) - Analyze an item
|
||||
* [generateThumbs](docs/sdks/library/README.md#generatethumbs) - Generate thumbs of chapters for an item
|
||||
* [detectCredits](docs/sdks/library/README.md#detectcredits) - Credit detect a metadata item
|
||||
* [getExtras](docs/sdks/library/README.md#getextras) - Get an item's extras
|
||||
* [addExtras](docs/sdks/library/README.md#addextras) - Add to an item's extras
|
||||
* [getFile](docs/sdks/library/README.md#getfile) - Get a file from a metadata or media bundle
|
||||
* [startBifGeneration](docs/sdks/library/README.md#startbifgeneration) - Start BIF generation of an item
|
||||
* [detectIntros](docs/sdks/library/README.md#detectintros) - Intro detect an item
|
||||
* [createMarker](docs/sdks/library/README.md#createmarker) - Create a marker
|
||||
* [matchItem](docs/sdks/library/README.md#matchitem) - Match a metadata item
|
||||
* [listMatches](docs/sdks/library/README.md#listmatches) - Get metadata matches for an item
|
||||
* [mergeItems](docs/sdks/library/README.md#mergeitems) - Merge a metadata item
|
||||
* [listSonicallySimilar](docs/sdks/library/README.md#listsonicallysimilar) - Get nearest tracks to metadata item
|
||||
* [setItemPreferences](docs/sdks/library/README.md#setitempreferences) - Set metadata preferences
|
||||
* [refreshItemsMetadata](docs/sdks/library/README.md#refreshitemsmetadata) - Refresh a metadata item
|
||||
* [getRelatedItems](docs/sdks/library/README.md#getrelateditems) - Get related items
|
||||
* [listSimilar](docs/sdks/library/README.md#listsimilar) - Get similar items
|
||||
* [splitItem](docs/sdks/library/README.md#splititem) - Split a metadata item
|
||||
* [addSubtitles](docs/sdks/library/README.md#addsubtitles) - Add subtitles
|
||||
* [getItemTree](docs/sdks/library/README.md#getitemtree) - Get metadata items as a tree
|
||||
* [unmatch](docs/sdks/library/README.md#unmatch) - Unmatch a metadata item
|
||||
* [listTopUsers](docs/sdks/library/README.md#listtopusers) - Get metadata top users
|
||||
* [detectVoiceActivity](docs/sdks/library/README.md#detectvoiceactivity) - Detect voice activity
|
||||
* [getAugmentationStatus](docs/sdks/library/README.md#getaugmentationstatus) - Get augmentation status
|
||||
* [setStreamSelection](docs/sdks/library/README.md#setstreamselection) - Set stream selection
|
||||
* [getPerson](docs/sdks/library/README.md#getperson) - Get person details
|
||||
* [listPersonMedia](docs/sdks/library/README.md#listpersonmedia) - Get media for a person
|
||||
* [deleteLibrarySection](docs/sdks/library/README.md#deletelibrarysection) - Delete a library section
|
||||
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get a library section by id
|
||||
* [editSection](docs/sdks/library/README.md#editsection) - Edit a library section
|
||||
* [updateItems](docs/sdks/library/README.md#updateitems) - Set the fields of the filtered items
|
||||
* [startAnalysis](docs/sdks/library/README.md#startanalysis) - Analyze a section
|
||||
* [autocomplete](docs/sdks/library/README.md#autocomplete) - Get autocompletions for search
|
||||
* [getCollections](docs/sdks/library/README.md#getcollections) - Get collections in a section
|
||||
* [getCommon](docs/sdks/library/README.md#getcommon) - Get common fields for items
|
||||
* [emptyTrash](docs/sdks/library/README.md#emptytrash) - Empty section trash
|
||||
* [getSectionFilters](docs/sdks/library/README.md#getsectionfilters) - Get section filters
|
||||
* [getFirstCharacters](docs/sdks/library/README.md#getfirstcharacters) - Get list of first characters
|
||||
* [deleteIndexes](docs/sdks/library/README.md#deleteindexes) - Delete section indexes
|
||||
* [deleteIntros](docs/sdks/library/README.md#deleteintros) - Delete section intro markers
|
||||
* [getSectionPreferences](docs/sdks/library/README.md#getsectionpreferences) - Get section prefs
|
||||
* [setSectionPreferences](docs/sdks/library/README.md#setsectionpreferences) - Set section prefs
|
||||
* [cancelRefresh](docs/sdks/library/README.md#cancelrefresh) - Cancel section refresh
|
||||
* [refreshSection](docs/sdks/library/README.md#refreshsection) - Refresh section
|
||||
* [getAvailableSorts](docs/sdks/library/README.md#getavailablesorts) - Get a section sorts
|
||||
* [getStreamLevels](docs/sdks/library/README.md#getstreamlevels) - Get loudness about a stream in json
|
||||
* [getStreamLoudness](docs/sdks/library/README.md#getstreamloudness) - Get loudness about a stream
|
||||
* [getChapterImage](docs/sdks/library/README.md#getchapterimage) - Get a chapter image
|
||||
* [setItemArtwork](docs/sdks/library/README.md#setitemartwork) - Set an item's artwork, theme, etc
|
||||
* [updateItemArtwork](docs/sdks/library/README.md#updateitemartwork) - Set an item's artwork, theme, etc
|
||||
* [deleteMarker](docs/sdks/library/README.md#deletemarker) - Delete a marker
|
||||
* [editMarker](docs/sdks/library/README.md#editmarker) - Edit a marker
|
||||
* [deleteMediaItem](docs/sdks/library/README.md#deletemediaitem) - Delete a media item
|
||||
* [getPartIndex](docs/sdks/library/README.md#getpartindex) - Get BIF index for a part
|
||||
* [deleteCollection](docs/sdks/library/README.md#deletecollection) - Delete a collection
|
||||
* [getSectionImage](docs/sdks/library/README.md#getsectionimage) - Get a section composite image
|
||||
* [deleteStream](docs/sdks/library/README.md#deletestream) - Delete a stream
|
||||
* [getStream](docs/sdks/library/README.md#getstream) - Get a stream
|
||||
* [setStreamOffset](docs/sdks/library/README.md#setstreamoffset) - Set a stream offset
|
||||
* [getItemArtwork](docs/sdks/library/README.md#getitemartwork) - Get an item's artwork, theme, etc
|
||||
* [getMediaPart](docs/sdks/library/README.md#getmediapart) - Get a media part
|
||||
* [getImageFromBif](docs/sdks/library/README.md#getimagefrombif) - Get an image from part BIF
|
||||
|
||||
### [libraryCollections()](docs/sdks/librarycollections/README.md)
|
||||
|
||||
* [addCollectionItems](docs/sdks/librarycollections/README.md#addcollectionitems) - Add items to a collection
|
||||
* [deleteCollectionItem](docs/sdks/librarycollections/README.md#deletecollectionitem) - Delete an item from a collection
|
||||
* [moveCollectionItem](docs/sdks/librarycollections/README.md#movecollectionitem) - Reorder an item in the collection
|
||||
|
||||
### [libraryPlaylists()](docs/sdks/libraryplaylists/README.md)
|
||||
|
||||
* [createPlaylist](docs/sdks/libraryplaylists/README.md#createplaylist) - Create a Playlist
|
||||
* [uploadPlaylist](docs/sdks/libraryplaylists/README.md#uploadplaylist) - Upload
|
||||
* [deletePlaylist](docs/sdks/libraryplaylists/README.md#deleteplaylist) - Delete a Playlist
|
||||
* [updatePlaylist](docs/sdks/libraryplaylists/README.md#updateplaylist) - Editing a Playlist
|
||||
* [getPlaylistGenerators](docs/sdks/libraryplaylists/README.md#getplaylistgenerators) - Get a playlist's generators
|
||||
* [clearPlaylistItems](docs/sdks/libraryplaylists/README.md#clearplaylistitems) - Clearing a playlist
|
||||
* [addPlaylistItems](docs/sdks/libraryplaylists/README.md#addplaylistitems) - Adding to a Playlist
|
||||
* [deletePlaylistItem](docs/sdks/libraryplaylists/README.md#deleteplaylistitem) - Delete a Generator
|
||||
* [getPlaylistGenerator](docs/sdks/libraryplaylists/README.md#getplaylistgenerator) - Get a playlist generator
|
||||
* [getPlaylistGeneratorItems](docs/sdks/libraryplaylists/README.md#getplaylistgeneratoritems) - Get a playlist generator's items
|
||||
* [movePlaylistItem](docs/sdks/libraryplaylists/README.md#moveplaylistitem) - Moving items in a playlist
|
||||
* [refreshPlaylist](docs/sdks/libraryplaylists/README.md#refreshplaylist) - Reprocess a generator
|
||||
|
||||
### [liveTV()](docs/sdks/livetv/README.md)
|
||||
|
||||
* [getSessions](docs/sdks/livetv/README.md#getsessions) - Get all sessions
|
||||
* [getLiveTVSession](docs/sdks/livetv/README.md#getlivetvsession) - Get a single session
|
||||
* [getSessionPlaylistIndex](docs/sdks/livetv/README.md#getsessionplaylistindex) - Get a session playlist index
|
||||
* [getSessionSegment](docs/sdks/livetv/README.md#getsessionsegment) - Get a single session segment
|
||||
|
||||
### [log()](docs/sdks/log/README.md)
|
||||
|
||||
* [logLine](docs/sdks/log/README.md#logline) - Logging a single line message.
|
||||
* [logMultiLine](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
|
||||
* [enablePaperTrail](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
|
||||
* [writeLog](docs/sdks/log/README.md#writelog) - Logging a multi-line message to the Plex Media Server log
|
||||
* [writeMessage](docs/sdks/log/README.md#writemessage) - Logging a single-line message to the Plex Media Server log
|
||||
* [enablePapertrail](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
|
||||
|
||||
### [media()](docs/sdks/media/README.md)
|
||||
### [playlist()](docs/sdks/playlist/README.md)
|
||||
|
||||
* [markPlayed](docs/sdks/media/README.md#markplayed) - Mark Media Played
|
||||
* [markUnplayed](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
|
||||
* [updatePlayProgress](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress
|
||||
* [getBannerImage](docs/sdks/media/README.md#getbannerimage) - Get Banner Image
|
||||
* [getThumbImage](docs/sdks/media/README.md#getthumbimage) - Get Thumb Image
|
||||
* [listPlaylists](docs/sdks/playlist/README.md#listplaylists) - List playlists
|
||||
* [getPlaylist](docs/sdks/playlist/README.md#getplaylist) - Retrieve Playlist
|
||||
* [getPlaylistItems](docs/sdks/playlist/README.md#getplaylistitems) - Retrieve Playlist Contents
|
||||
|
||||
### [playlists()](docs/sdks/playlists/README.md)
|
||||
### [playQueue()](docs/sdks/playqueue/README.md)
|
||||
|
||||
* [createPlaylist](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
|
||||
* [getPlaylists](docs/sdks/playlists/README.md#getplaylists) - Get All Playlists
|
||||
* [getPlaylist](docs/sdks/playlists/README.md#getplaylist) - Retrieve Playlist
|
||||
* [deletePlaylist](docs/sdks/playlists/README.md#deleteplaylist) - Deletes a Playlist
|
||||
* [updatePlaylist](docs/sdks/playlists/README.md#updateplaylist) - Update a Playlist
|
||||
* [getPlaylistContents](docs/sdks/playlists/README.md#getplaylistcontents) - Retrieve Playlist Contents
|
||||
* [clearPlaylistContents](docs/sdks/playlists/README.md#clearplaylistcontents) - Delete Playlist Contents
|
||||
* [addPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a Playlist
|
||||
* [uploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist) - Upload Playlist
|
||||
* [createPlayQueue](docs/sdks/playqueue/README.md#createplayqueue) - Create a play queue
|
||||
* [getPlayQueue](docs/sdks/playqueue/README.md#getplayqueue) - Retrieve a play queue
|
||||
* [addToPlayQueue](docs/sdks/playqueue/README.md#addtoplayqueue) - Add a generator or playlist to a play queue
|
||||
* [clearPlayQueue](docs/sdks/playqueue/README.md#clearplayqueue) - Clear a play queue
|
||||
* [resetPlayQueue](docs/sdks/playqueue/README.md#resetplayqueue) - Reset a play queue
|
||||
* [shuffle](docs/sdks/playqueue/README.md#shuffle) - Shuffle a play queue
|
||||
* [unshuffle](docs/sdks/playqueue/README.md#unshuffle) - Unshuffle a play queue
|
||||
* [deletePlayQueueItem](docs/sdks/playqueue/README.md#deleteplayqueueitem) - Delete an item from a play queue
|
||||
* [movePlayQueueItem](docs/sdks/playqueue/README.md#moveplayqueueitem) - Move an item in a play queue
|
||||
|
||||
### [plex()](docs/sdks/plex/README.md)
|
||||
|
||||
* [getCompanionsData](docs/sdks/plex/README.md#getcompanionsdata) - Get Companions Data
|
||||
* [getUserFriends](docs/sdks/plex/README.md#getuserfriends) - Get list of friends of the user logged in
|
||||
* [getGeoData](docs/sdks/plex/README.md#getgeodata) - Get Geo Data
|
||||
* [getHomeData](docs/sdks/plex/README.md#gethomedata) - Get Plex Home Data
|
||||
* [getServerResources](docs/sdks/plex/README.md#getserverresources) - Get Server Resources
|
||||
* [getPin](docs/sdks/plex/README.md#getpin) - Get a Pin
|
||||
* [getTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid) - Get Access Token by PinId
|
||||
### [preferences()](docs/sdks/preferences/README.md)
|
||||
|
||||
* [getAllPreferences](docs/sdks/preferences/README.md#getallpreferences) - Get all preferences
|
||||
* [setPreferences](docs/sdks/preferences/README.md#setpreferences) - Set preferences
|
||||
* [getPreference](docs/sdks/preferences/README.md#getpreference) - Get a preferences
|
||||
|
||||
### [provider()](docs/sdks/provider/README.md)
|
||||
|
||||
* [listProviders](docs/sdks/provider/README.md#listproviders) - Get the list of available media providers
|
||||
* [addProvider](docs/sdks/provider/README.md#addprovider) - Add a media provider
|
||||
* [refreshProviders](docs/sdks/provider/README.md#refreshproviders) - Refresh media providers
|
||||
* [deleteMediaProvider](docs/sdks/provider/README.md#deletemediaprovider) - Delete a media provider
|
||||
|
||||
### [rate()](docs/sdks/rate/README.md)
|
||||
|
||||
* [setRating](docs/sdks/rate/README.md#setrating) - Rate an item
|
||||
|
||||
### [search()](docs/sdks/search/README.md)
|
||||
|
||||
* [performSearch](docs/sdks/search/README.md#performsearch) - Perform a search
|
||||
* [performVoiceSearch](docs/sdks/search/README.md#performvoicesearch) - Perform a voice search
|
||||
* [getSearchResults](docs/sdks/search/README.md#getsearchresults) - Get Search Results
|
||||
* [searchHubs](docs/sdks/search/README.md#searchhubs) - Search Hub
|
||||
* [voiceSearchHubs](docs/sdks/search/README.md#voicesearchhubs) - Voice Search Hub
|
||||
|
||||
### [server()](docs/sdks/server/README.md)
|
||||
### [status()](docs/sdks/status/README.md)
|
||||
|
||||
* [getServerCapabilities](docs/sdks/server/README.md#getservercapabilities) - Get Server Capabilities
|
||||
* [getServerPreferences](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
|
||||
* [getAvailableClients](docs/sdks/server/README.md#getavailableclients) - Get Available Clients
|
||||
* [getDevices](docs/sdks/server/README.md#getdevices) - Get Devices
|
||||
* [getServerIdentity](docs/sdks/server/README.md#getserveridentity) - Get Server Identity
|
||||
* [getMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount) - Get MyPlex Account
|
||||
* [getResizedPhoto](docs/sdks/server/README.md#getresizedphoto) - Get a Resized Photo
|
||||
* [getMediaProviders](docs/sdks/server/README.md#getmediaproviders) - Get Media Providers
|
||||
* [getServerList](docs/sdks/server/README.md#getserverlist) - Get Server List
|
||||
* [listSessions](docs/sdks/status/README.md#listsessions) - List Sessions
|
||||
* [getBackgroundTasks](docs/sdks/status/README.md#getbackgroundtasks) - Get background tasks
|
||||
* [listPlaybackHistory](docs/sdks/status/README.md#listplaybackhistory) - List Playback History
|
||||
* [terminateSession](docs/sdks/status/README.md#terminatesession) - Terminate a session
|
||||
* [deleteHistory](docs/sdks/status/README.md#deletehistory) - Delete Single History Item
|
||||
* [getHistoryItem](docs/sdks/status/README.md#gethistoryitem) - Get Single History Item
|
||||
|
||||
### [sessions()](docs/sdks/sessions/README.md)
|
||||
### [subscriptions()](docs/sdks/subscriptions/README.md)
|
||||
|
||||
* [getSessions](docs/sdks/sessions/README.md#getsessions) - Get Active Sessions
|
||||
* [getSessionHistory](docs/sdks/sessions/README.md#getsessionhistory) - Get Session History
|
||||
* [getTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions) - Get Transcode Sessions
|
||||
* [stopTranscodeSession](docs/sdks/sessions/README.md#stoptranscodesession) - Stop a Transcode Session
|
||||
* [getAllSubscriptions](docs/sdks/subscriptions/README.md#getallsubscriptions) - Get all subscriptions
|
||||
* [createSubscription](docs/sdks/subscriptions/README.md#createsubscription) - Create a subscription
|
||||
* [processSubscriptions](docs/sdks/subscriptions/README.md#processsubscriptions) - Process all subscriptions
|
||||
* [getScheduledRecordings](docs/sdks/subscriptions/README.md#getscheduledrecordings) - Get all scheduled recordings
|
||||
* [getTemplate](docs/sdks/subscriptions/README.md#gettemplate) - Get the subscription template
|
||||
* [cancelGrab](docs/sdks/subscriptions/README.md#cancelgrab) - Cancel an existing grab
|
||||
* [deleteSubscription](docs/sdks/subscriptions/README.md#deletesubscription) - Delete a subscription
|
||||
* [getSubscription](docs/sdks/subscriptions/README.md#getsubscription) - Get a single subscription
|
||||
* [editSubscriptionPreferences](docs/sdks/subscriptions/README.md#editsubscriptionpreferences) - Edit a subscription
|
||||
* [reorderSubscription](docs/sdks/subscriptions/README.md#reordersubscription) - Re-order a subscription
|
||||
|
||||
### [statistics()](docs/sdks/statistics/README.md)
|
||||
### [timeline()](docs/sdks/timeline/README.md)
|
||||
|
||||
* [getStatistics](docs/sdks/statistics/README.md#getstatistics) - Get Media Statistics
|
||||
* [getResourcesStatistics](docs/sdks/statistics/README.md#getresourcesstatistics) - Get Resources Statistics
|
||||
* [getBandwidthStatistics](docs/sdks/statistics/README.md#getbandwidthstatistics) - Get Bandwidth Statistics
|
||||
* [markPlayed](docs/sdks/timeline/README.md#markplayed) - Mark an item as played
|
||||
* [report](docs/sdks/timeline/README.md#report) - Report media timeline
|
||||
* [unscrobble](docs/sdks/timeline/README.md#unscrobble) - Mark an item as unplayed
|
||||
|
||||
### [transcoder()](docs/sdks/transcoder/README.md)
|
||||
|
||||
* [transcodeImage](docs/sdks/transcoder/README.md#transcodeimage) - Transcode an image
|
||||
* [makeDecision](docs/sdks/transcoder/README.md#makedecision) - Make a decision on media playback
|
||||
* [triggerFallback](docs/sdks/transcoder/README.md#triggerfallback) - Manually trigger a transcoder fallback
|
||||
* [transcodeSubtitles](docs/sdks/transcoder/README.md#transcodesubtitles) - Transcode subtitles
|
||||
* [startTranscodeSession](docs/sdks/transcoder/README.md#starttranscodesession) - Start A Transcoding Session
|
||||
|
||||
### [ultraBlur()](docs/sdks/ultrablur/README.md)
|
||||
|
||||
* [getColors](docs/sdks/ultrablur/README.md#getcolors) - Get UltraBlur Colors
|
||||
* [getImage](docs/sdks/ultrablur/README.md#getimage) - Get UltraBlur Image
|
||||
|
||||
### [updater()](docs/sdks/updater/README.md)
|
||||
|
||||
* [getUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
|
||||
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
||||
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
||||
|
||||
### [video()](docs/sdks/video/README.md)
|
||||
|
||||
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
||||
* [startUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
|
||||
|
||||
### [watchlist()](docs/sdks/watchlist/README.md)
|
||||
|
||||
* [getWatchList](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
|
||||
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Applying updates
|
||||
* [checkUpdates](docs/sdks/updater/README.md#checkupdates) - Checking for updates
|
||||
* [getUpdatesStatus](docs/sdks/updater/README.md#getupdatesstatus) - Querying status of updates
|
||||
|
||||
</details>
|
||||
<!-- End Available Resources and Operations [operations] -->
|
||||
@@ -268,12 +530,10 @@ public class Application {
|
||||
|
||||
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
|
||||
|
||||
By default, an API error will throw a `models/errors/SDKError` exception. When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `getServerCapabilities` method throws the following exceptions:
|
||||
By default, an API error will throw a `models/errors/SDKError` exception. When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `getServerInfo` method throws the following exceptions:
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------------- | ----------- | ---------------- |
|
||||
| models/errors/GetServerCapabilitiesBadRequest | 400 | application/json |
|
||||
| models/errors/GetServerCapabilitiesUnauthorized | 401 | application/json |
|
||||
| ---------------------- | ----------- | ------------ |
|
||||
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
### Example
|
||||
@@ -282,23 +542,38 @@ By default, an API error will throw a `models/errors/SDKError` exception. When c
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetServerCapabilitiesResponse;
|
||||
import dev.plexapi.sdk.models.operations.GetServerInfoRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetServerInfoResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {
|
||||
public static void main(String[] args) throws Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.accepts(Accepts.APPLICATION_XML)
|
||||
.clientIdentifier("abc123")
|
||||
.product("Plex for Roku")
|
||||
.version("2.4.1")
|
||||
.platform("Roku")
|
||||
.platformVersion("4.3 build 1057")
|
||||
.device("Roku 3")
|
||||
.model("4200X")
|
||||
.deviceVendor("Roku")
|
||||
.deviceName("Living Room TV")
|
||||
.marketplace("googlePlay")
|
||||
.token(System.getenv().getOrDefault("TOKEN", ""))
|
||||
.build();
|
||||
|
||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||
GetServerInfoRequest req = GetServerInfoRequest.builder()
|
||||
.build();
|
||||
|
||||
GetServerInfoResponse res = sdk.general().getServerInfo()
|
||||
.request(req)
|
||||
.call();
|
||||
|
||||
if (res.object().isPresent()) {
|
||||
if (res.mediaContainerWithDirectory().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
@@ -309,12 +584,74 @@ public class Application {
|
||||
<!-- Start Server Selection [server] -->
|
||||
## Server Selection
|
||||
|
||||
### Server Variables
|
||||
### Select Server by Index
|
||||
|
||||
The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following builder methods are available when initializing the SDK client instance:
|
||||
* `protocol(ServerProtocol protocol)`
|
||||
* `ip(String ip)`
|
||||
* `port(String port)`
|
||||
You can override the default server globally using the `.serverIndex(int serverIdx)` builder method when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
|
||||
|
||||
| # | Server | Variables | Description |
|
||||
| --- | ---------------------------------------------------------- | -------------------------------------------- | ----------- |
|
||||
| 0 | `https://{IP-description}.{identifier}.plex.direct:{port}` | `identifier`<br/>`IP-description`<br/>`port` | |
|
||||
| 1 | `{protocol}://{host}:{port}` | `protocol`<br/>`host`<br/>`port` | |
|
||||
| 2 | `https://{server_url}` | `server_url` | |
|
||||
|
||||
If the selected server has variables, you may override its default values using the associated builder method(s):
|
||||
|
||||
| Variable | BuilderMethod | Default | Description |
|
||||
| ---------------- | ------------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `identifier` | `identifier(String identifier)` | `"0123456789abcdef0123456789abcdef"` | The unique identifier of this particular PMS |
|
||||
| `IP-description` | `ipDescription(String ipDescription)` | `"1-2-3-4"` | A `-` separated string of the IPv4 or IPv6 address components |
|
||||
| `port` | `port(String port)` | `"32400"` | The Port number configured on the PMS. Typically (`32400`). <br/>If using a reverse proxy, this would be the port number configured on the proxy.<br/> |
|
||||
| `protocol` | `protocol(String protocol)` | `"http"` | The network protocol to use. Typically (`http` or `https`) |
|
||||
| `host` | `host(String host)` | `"localhost"` | The Host of the PMS.<br/>If using on a local network, this is the internal IP address of the server hosting the PMS.<br/>If using on an external network, this is the external IP address for your network, and requires port forwarding.<br/>If using a reverse proxy, this would be the external DNS domain for your network, and requires the proxy handle port forwarding. <br/> |
|
||||
| `server_url` | `serverUrl(String serverUrl)` | `"http://localhost:32400"` | The full manual URL to access the PMS |
|
||||
|
||||
#### Example
|
||||
|
||||
```java
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.operations.GetServerInfoRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetServerInfoResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) throws Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.serverIndex(1)
|
||||
.protocol("<value>")
|
||||
.host("electric-excess.name")
|
||||
.port("36393")
|
||||
.accepts(Accepts.APPLICATION_XML)
|
||||
.clientIdentifier("abc123")
|
||||
.product("Plex for Roku")
|
||||
.version("2.4.1")
|
||||
.platform("Roku")
|
||||
.platformVersion("4.3 build 1057")
|
||||
.device("Roku 3")
|
||||
.model("4200X")
|
||||
.deviceVendor("Roku")
|
||||
.deviceName("Living Room TV")
|
||||
.marketplace("googlePlay")
|
||||
.token(System.getenv().getOrDefault("TOKEN", ""))
|
||||
.build();
|
||||
|
||||
GetServerInfoRequest req = GetServerInfoRequest.builder()
|
||||
.build();
|
||||
|
||||
GetServerInfoResponse res = sdk.general().getServerInfo()
|
||||
.request(req)
|
||||
.call();
|
||||
|
||||
if (res.mediaContainerWithDirectory().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Override Server URL Per-Client
|
||||
|
||||
@@ -323,55 +660,39 @@ The default server can also be overridden globally using the `.serverURL(String
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetServerCapabilitiesResponse;
|
||||
import dev.plexapi.sdk.models.operations.GetServerInfoRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetServerInfoResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {
|
||||
public static void main(String[] args) throws Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.serverURL("https://10.10.10.47:32400")
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.serverURL("https://http://localhost:32400")
|
||||
.accepts(Accepts.APPLICATION_XML)
|
||||
.clientIdentifier("abc123")
|
||||
.product("Plex for Roku")
|
||||
.version("2.4.1")
|
||||
.platform("Roku")
|
||||
.platformVersion("4.3 build 1057")
|
||||
.device("Roku 3")
|
||||
.model("4200X")
|
||||
.deviceVendor("Roku")
|
||||
.deviceName("Living Room TV")
|
||||
.marketplace("googlePlay")
|
||||
.token(System.getenv().getOrDefault("TOKEN", ""))
|
||||
.build();
|
||||
|
||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||
.call();
|
||||
|
||||
if (res.object().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Override Server URL Per-Operation
|
||||
|
||||
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
|
||||
```java
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetCompanionsDataBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetCompanionsDataUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetCompanionsDataResponse;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) throws GetCompanionsDataBadRequest, GetCompanionsDataUnauthorized, Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
GetServerInfoRequest req = GetServerInfoRequest.builder()
|
||||
.build();
|
||||
|
||||
GetCompanionsDataResponse res = sdk.plex().getCompanionsData()
|
||||
.serverURL("https://plex.tv/api/v2")
|
||||
GetServerInfoResponse res = sdk.general().getServerInfo()
|
||||
.request(req)
|
||||
.call();
|
||||
|
||||
if (res.responseBodies().isPresent()) {
|
||||
if (res.mediaContainerWithDirectory().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
@@ -379,6 +700,72 @@ public class Application {
|
||||
```
|
||||
<!-- End Server Selection [server] -->
|
||||
|
||||
<!-- Start Asynchronous Support [async-support] -->
|
||||
## Asynchronous Support
|
||||
|
||||
The SDK provides comprehensive asynchronous support using Java's [`CompletableFuture<T>`][comp-fut] and [Reactive Streams `Publisher<T>`][reactive-streams] APIs. This design makes no assumptions about your choice of reactive toolkit, allowing seamless integration with any reactive library.
|
||||
|
||||
<details>
|
||||
<summary>Why Use Async?</summary>
|
||||
|
||||
Asynchronous operations provide several key benefits:
|
||||
|
||||
- **Non-blocking I/O**: Your threads stay free for other work while operations are in flight
|
||||
- **Better resource utilization**: Handle more concurrent operations with fewer threads
|
||||
- **Improved scalability**: Build highly responsive applications that can handle thousands of concurrent requests
|
||||
- **Reactive integration**: Works seamlessly with reactive streams and backpressure handling
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Reactive Library Integration</summary>
|
||||
|
||||
The SDK returns [Reactive Streams `Publisher<T>`][reactive-streams] instances for operations dealing with streams involving multiple I/O interactions. We use Reactive Streams instead of JDK Flow API to provide broader compatibility with the reactive ecosystem, as most reactive libraries natively support Reactive Streams.
|
||||
|
||||
**Why Reactive Streams over JDK Flow?**
|
||||
- **Broader ecosystem compatibility**: Most reactive libraries (Project Reactor, RxJava, Akka Streams, etc.) natively support Reactive Streams
|
||||
- **Industry standard**: Reactive Streams is the de facto standard for reactive programming in Java
|
||||
- **Better interoperability**: Seamless integration without additional adapters for most use cases
|
||||
|
||||
**Integration with Popular Libraries:**
|
||||
- **Project Reactor**: Use `Flux.from(publisher)` to convert to Reactor types
|
||||
- **RxJava**: Use `Flowable.fromPublisher(publisher)` for RxJava integration
|
||||
- **Akka Streams**: Use `Source.fromPublisher(publisher)` for Akka Streams integration
|
||||
- **Vert.x**: Use `ReadStream.fromPublisher(vertx, publisher)` for Vert.x reactive streams
|
||||
- **Mutiny**: Use `Multi.createFrom().publisher(publisher)` for Quarkus Mutiny integration
|
||||
|
||||
**For JDK Flow API Integration:**
|
||||
If you need JDK Flow API compatibility (e.g., for Quarkus/Mutiny 2), you can use adapters:
|
||||
```java
|
||||
// Convert Reactive Streams Publisher to Flow Publisher
|
||||
Flow.Publisher<T> flowPublisher = FlowAdapters.toFlowPublisher(reactiveStreamsPublisher);
|
||||
|
||||
// Convert Flow Publisher to Reactive Streams Publisher
|
||||
Publisher<T> reactiveStreamsPublisher = FlowAdapters.toPublisher(flowPublisher);
|
||||
```
|
||||
|
||||
For standard single-response operations, the SDK returns `CompletableFuture<T>` for straightforward async execution.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Supported Operations</summary>
|
||||
|
||||
Async support is available for:
|
||||
|
||||
- **[Server-sent Events](#server-sent-event-streaming)**: Stream real-time events with Reactive Streams `Publisher<T>`
|
||||
- **[JSONL Streaming](#jsonl-streaming)**: Process streaming JSON lines asynchronously
|
||||
- **[Pagination](#pagination)**: Iterate through paginated results using `callAsPublisher()` and `callAsPublisherUnwrapped()`
|
||||
- **[File Uploads](#file-uploads)**: Upload files asynchronously with progress tracking
|
||||
- **[File Downloads](#file-downloads)**: Download files asynchronously with streaming support
|
||||
- **[Standard Operations](#example)**: All regular API calls return `CompletableFuture<T>` for async execution
|
||||
|
||||
</details>
|
||||
|
||||
[comp-fut]: https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html
|
||||
[reactive-streams]: https://www.reactive-streams.org/
|
||||
<!-- End Asynchronous Support [async-support] -->
|
||||
|
||||
<!-- Start Authentication [security] -->
|
||||
## Authentication
|
||||
|
||||
@@ -387,31 +774,46 @@ public class Application {
|
||||
This SDK supports the following security scheme globally:
|
||||
|
||||
| Name | Type | Scheme |
|
||||
| ------------- | ------ | ------- |
|
||||
| `accessToken` | apiKey | API key |
|
||||
| ------- | ------ | ------- |
|
||||
| `token` | apiKey | API key |
|
||||
|
||||
To authenticate with the API the `accessToken` parameter must be set when initializing the SDK client instance. For example:
|
||||
To authenticate with the API the `token` parameter must be set when initializing the SDK client instance. For example:
|
||||
```java
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetServerCapabilitiesResponse;
|
||||
import dev.plexapi.sdk.models.operations.GetServerInfoRequest;
|
||||
import dev.plexapi.sdk.models.operations.GetServerInfoResponse;
|
||||
import dev.plexapi.sdk.models.shared.Accepts;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {
|
||||
public static void main(String[] args) throws Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.token(System.getenv().getOrDefault("TOKEN", ""))
|
||||
.accepts(Accepts.APPLICATION_XML)
|
||||
.clientIdentifier("abc123")
|
||||
.product("Plex for Roku")
|
||||
.version("2.4.1")
|
||||
.platform("Roku")
|
||||
.platformVersion("4.3 build 1057")
|
||||
.device("Roku 3")
|
||||
.model("4200X")
|
||||
.deviceVendor("Roku")
|
||||
.deviceName("Living Room TV")
|
||||
.marketplace("googlePlay")
|
||||
.build();
|
||||
|
||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||
GetServerInfoRequest req = GetServerInfoRequest.builder()
|
||||
.build();
|
||||
|
||||
GetServerInfoResponse res = sdk.general().getServerInfo()
|
||||
.request(req)
|
||||
.call();
|
||||
|
||||
if (res.object().isPresent()) {
|
||||
if (res.mediaContainerWithDirectory().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
@@ -419,6 +821,37 @@ public class Application {
|
||||
```
|
||||
<!-- End Authentication [security] -->
|
||||
|
||||
<!-- Start Debugging [debug] -->
|
||||
## Debugging
|
||||
|
||||
### Debug
|
||||
You can setup your SDK to emit debug logs for SDK requests and responses.
|
||||
|
||||
For request and response logging (especially json bodies), call `enableHTTPDebugLogging(boolean)` on the SDK builder like so:
|
||||
```java
|
||||
SDK.builder()
|
||||
.enableHTTPDebugLogging(true)
|
||||
.build();
|
||||
```
|
||||
Example output:
|
||||
```
|
||||
Sending request: http://localhost:35123/bearer#global GET
|
||||
Request headers: {Accept=[application/json], Authorization=[******], Client-Level-Header=[added by client], Idempotency-Key=[some-key], x-speakeasy-user-agent=[speakeasy-sdk/java 0.0.1 internal 0.1.0 org.openapis.openapi]}
|
||||
Received response: (GET http://localhost:35123/bearer#global) 200
|
||||
Response headers: {access-control-allow-credentials=[true], access-control-allow-origin=[*], connection=[keep-alive], content-length=[50], content-type=[application/json], date=[Wed, 09 Apr 2025 01:43:29 GMT], server=[gunicorn/19.9.0]}
|
||||
Response body:
|
||||
{
|
||||
"authenticated": true,
|
||||
"token": "global"
|
||||
}
|
||||
```
|
||||
__WARNING__: This should only used for temporary debugging purposes. Leaving this option on in a production system could expose credentials/secrets in logs. <i>Authorization</i> headers are redacted by default and there is the ability to specify redacted header names via `SpeakeasyHTTPClient.setRedactedHeaders`.
|
||||
|
||||
__NOTE__: This is a convenience method that calls `HTTPClient.enableDebugLogging()`. The `SpeakeasyHTTPClient` honors this setting. If you are using a custom HTTP client, it is up to the custom client to honor this setting.
|
||||
|
||||
Another option is to set the System property `-Djdk.httpclient.HttpClient.log=all`. However, this second option does not log bodies.
|
||||
<!-- End Debugging [debug] -->
|
||||
|
||||
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
||||
|
||||
# Development
|
||||
|
||||
170
RELEASES.md
170
RELEASES.md
@@ -219,3 +219,173 @@ Based on:
|
||||
- [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 - .
|
||||
|
||||
## 2025-02-07 00:26:07
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.487.0 (2.506.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.11.6] .
|
||||
### Releases
|
||||
- [Maven Central v0.11.6] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.6 - .
|
||||
|
||||
## 2025-02-10 00:27:03
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.487.1 (2.506.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.12.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.12.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.12.0 - .
|
||||
|
||||
## 2025-03-07 00:27:17
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.513.2 (2.545.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.13.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.13.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.13.0 - .
|
||||
|
||||
## 2025-03-09 00:24:27
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.513.4 (2.545.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.13.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.13.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.13.1 - .
|
||||
|
||||
## 2025-03-31 17:07:30
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.14.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.14.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.14.0 - .
|
||||
|
||||
## 2025-04-03 00:27:41
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.528.1 (2.565.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.14.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.14.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.14.1 - .
|
||||
|
||||
## 2025-04-06 00:30:19
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.529.1 (2.566.5) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.14.2] .
|
||||
### Releases
|
||||
- [Maven Central v0.14.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.14.2 - .
|
||||
|
||||
## 2025-04-14 00:30:37
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.531.4 (2.570.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.15.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.15.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.15.0 - .
|
||||
|
||||
## 2025-04-19 00:27:27
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.535.1 (2.585.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.16.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.16.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.16.0 - .
|
||||
|
||||
## 2025-05-01 00:32:51
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.541.2 (2.595.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.16.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.16.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.16.1 - .
|
||||
|
||||
## 2025-05-05 00:31:37
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.542.1 (2.597.9) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.16.2] .
|
||||
### Releases
|
||||
- [Maven Central v0.16.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.16.2 - .
|
||||
|
||||
## 2025-06-04 00:30:54
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.555.2 (2.620.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.17.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.17.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.17.0 - .
|
||||
|
||||
## 2025-06-09 00:32:43
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.557.0 (2.623.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.17.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.17.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.17.1 - .
|
||||
|
||||
## 2025-09-16 00:27:57
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.615.2 (2.698.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.18.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.18.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.18.0 - .
|
||||
|
||||
## 2025-10-12 06:49:36
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.615.2 (2.698.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.19.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.19.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.19.1 - .
|
||||
57
USAGE.md
57
USAGE.md
@@ -3,23 +3,66 @@
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesBadRequest;
|
||||
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesUnauthorized;
|
||||
import dev.plexapi.sdk.models.operations.GetServerCapabilitiesResponse;
|
||||
import dev.plexapi.sdk.models.operations.*;
|
||||
import dev.plexapi.sdk.models.shared.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {
|
||||
public static void main(String[] args) throws Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.accepts(Accepts.APPLICATION_XML)
|
||||
.clientIdentifier("abc123")
|
||||
.product("Plex for Roku")
|
||||
.version("2.4.1")
|
||||
.platform("Roku")
|
||||
.platformVersion("4.3 build 1057")
|
||||
.device("Roku 3")
|
||||
.model("4200X")
|
||||
.deviceVendor("Roku")
|
||||
.deviceName("Living Room TV")
|
||||
.marketplace("googlePlay")
|
||||
.token(System.getenv().getOrDefault("TOKEN", ""))
|
||||
.build();
|
||||
|
||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||
StartTranscodeSessionRequest req = StartTranscodeSessionRequest.builder()
|
||||
.transcodeType(TranscodeType.MUSIC)
|
||||
.extension(Extension.MPD)
|
||||
.advancedSubtitles(AdvancedSubtitles.BURN)
|
||||
.audioBoost(50L)
|
||||
.audioChannelCount(5L)
|
||||
.autoAdjustQuality(BoolInt.ONE)
|
||||
.autoAdjustSubtitle(BoolInt.ONE)
|
||||
.directPlay(BoolInt.ONE)
|
||||
.directStream(BoolInt.ONE)
|
||||
.directStreamAudio(BoolInt.ONE)
|
||||
.disableResolutionRotation(BoolInt.ONE)
|
||||
.hasMDE(BoolInt.ONE)
|
||||
.location(StartTranscodeSessionQueryParamLocation.WAN)
|
||||
.mediaBufferSize(102400L)
|
||||
.mediaIndex(0L)
|
||||
.musicBitrate(5000L)
|
||||
.offset(90.5)
|
||||
.partIndex(0L)
|
||||
.path("/library/metadata/151671")
|
||||
.peakBitrate(12000L)
|
||||
.photoResolution("1080x1080")
|
||||
.protocol(StartTranscodeSessionQueryParamProtocol.DASH)
|
||||
.secondsPerSegment(5L)
|
||||
.subtitleSize(50L)
|
||||
.videoBitrate(12000L)
|
||||
.videoQuality(50L)
|
||||
.videoResolution("1080x1080")
|
||||
.xPlexClientProfileExtra("add-limitation(scope=videoCodec&scopeName=*&type=upperBound&name=video.frameRate&value=60&replace=true)+append-transcode-target-codec(type=videoProfile&context=streaming&videoCodec=h264%2Chevc&audioCodec=aac&protocol=dash)")
|
||||
.xPlexClientProfileName("generic")
|
||||
.build();
|
||||
|
||||
StartTranscodeSessionResponse res = sdk.transcoder().startTranscodeSession()
|
||||
.request(req)
|
||||
.call();
|
||||
|
||||
if (res.object().isPresent()) {
|
||||
if (res.responseStream().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
|
||||
38
build.gradle
38
build.gradle
@@ -27,8 +27,6 @@ repositories {
|
||||
}
|
||||
|
||||
java {
|
||||
sourceCompatibility = JavaVersion.VERSION_11
|
||||
targetCompatibility = JavaVersion.VERSION_11
|
||||
withSourcesJar()
|
||||
withJavadocJar()
|
||||
}
|
||||
@@ -39,9 +37,12 @@ model {
|
||||
}
|
||||
}
|
||||
|
||||
version = "${version}"
|
||||
group = "${groupId}"
|
||||
|
||||
jar {
|
||||
dependsOn(":generatePomFileForMavenPublication")
|
||||
archiveBaseName = "plexapi"
|
||||
archiveBaseName = "${artifactId}"
|
||||
|
||||
into("META-INF/maven/dev.plexapi/plexapi") {
|
||||
from("$buildDir/pom.xml")
|
||||
@@ -58,19 +59,20 @@ javadoc {
|
||||
}
|
||||
|
||||
tasks.withType(Javadoc) {
|
||||
failOnError false
|
||||
failOnError = false
|
||||
options.addStringOption('Xdoclint:none', '-quiet')
|
||||
}
|
||||
|
||||
group = "dev.plexapi"
|
||||
version = "0.11.3"
|
||||
tasks.withType(JavaCompile).configureEach {
|
||||
options.release = 11
|
||||
}
|
||||
|
||||
sourcesJar {
|
||||
archiveBaseName = "plexapi"
|
||||
archiveBaseName = "${artifactId}"
|
||||
}
|
||||
|
||||
javadocJar {
|
||||
archiveBaseName = "plexapi"
|
||||
archiveBaseName = "${artifactId}"
|
||||
}
|
||||
sonatypeCentralUpload {
|
||||
// This is your Sonatype generated username
|
||||
@@ -80,9 +82,9 @@ sonatypeCentralUpload {
|
||||
|
||||
// This is a list of files to upload. Ideally you would point to your jar file, source and javadoc jar (required by central)
|
||||
archives = files(
|
||||
"$buildDir/libs/plexapi-${version}.jar",
|
||||
"$buildDir/libs/plexapi-${version}-sources.jar",
|
||||
"$buildDir/libs/plexapi-${version}-javadoc.jar"
|
||||
"$buildDir/libs/${artifactId}-${version}.jar",
|
||||
"$buildDir/libs/${artifactId}-${version}-sources.jar",
|
||||
"$buildDir/libs/${artifactId}-${version}-javadoc.jar"
|
||||
)
|
||||
|
||||
// This is the pom file to upload. This is required by central
|
||||
@@ -99,13 +101,19 @@ publishing {
|
||||
|
||||
publications {
|
||||
maven(MavenPublication) {
|
||||
groupId = 'dev.plexapi'
|
||||
artifactId = 'plexapi'
|
||||
version = '0.11.3'
|
||||
// note that properties can't yet be used below!
|
||||
// https://github.com/gradle/gradle/issues/18619
|
||||
groupId = "dev.plexapi"
|
||||
artifactId = "plexapi"
|
||||
version = "0.19.1"
|
||||
|
||||
from components.java
|
||||
|
||||
pom {
|
||||
properties = [
|
||||
'maven.compiler.source': '11',
|
||||
'maven.compiler.target': '11',
|
||||
]
|
||||
name = 'plexapi Java SDK'
|
||||
description = 'SDK enabling Java developers to easily integrate with the plexapi API.'
|
||||
url = 'https://github.com/LukeHagar/plexjava'
|
||||
@@ -152,8 +160,8 @@ dependencies {
|
||||
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'
|
||||
api 'org.reactivestreams:reactive-streams:1.0.4'
|
||||
}
|
||||
|
||||
apply from: 'build-extras.gradle'
|
||||
11296
codeSamples.yaml
11296
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
@@ -1,11 +0,0 @@
|
||||
# AddPlaylistContentsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[AddPlaylistContentsErrors](../../models/errors/AddPlaylistContentsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# AddPlaylistContentsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# AddPlaylistContentsPlaylistsErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AddPlaylistContentsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[AddPlaylistContentsPlaylistsErrors](../../models/errors/AddPlaylistContentsPlaylistsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ApplyUpdatesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[ApplyUpdatesErrors](../../models/errors/ApplyUpdatesErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# ApplyUpdatesErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ApplyUpdatesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[ApplyUpdatesUpdaterErrors](../../models/errors/ApplyUpdatesUpdaterErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# ApplyUpdatesUpdaterErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# CancelServerActivitiesActivitiesErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CancelServerActivitiesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[CancelServerActivitiesErrors](../../models/errors/CancelServerActivitiesErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# CancelServerActivitiesErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CancelServerActivitiesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[CancelServerActivitiesActivitiesErrors](../../models/errors/CancelServerActivitiesActivitiesErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CheckForUpdatesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[CheckForUpdatesErrors](../../models/errors/CheckForUpdatesErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# CheckForUpdatesErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CheckForUpdatesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[CheckForUpdatesUpdaterErrors](../../models/errors/CheckForUpdatesUpdaterErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# CheckForUpdatesUpdaterErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ClearPlaylistContentsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[ClearPlaylistContentsErrors](../../models/errors/ClearPlaylistContentsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# ClearPlaylistContentsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# ClearPlaylistContentsPlaylistsErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ClearPlaylistContentsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[ClearPlaylistContentsPlaylistsErrors](../../models/errors/ClearPlaylistContentsPlaylistsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CreatePlaylistBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[CreatePlaylistErrors](../../models/errors/CreatePlaylistErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# CreatePlaylistErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# CreatePlaylistPlaylistsErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CreatePlaylistUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[CreatePlaylistPlaylistsErrors](../../models/errors/CreatePlaylistPlaylistsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# DeleteLibraryBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[DeleteLibraryErrors](../../models/errors/DeleteLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# DeleteLibraryErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# DeleteLibraryLibraryErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# DeleteLibraryUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[DeleteLibraryLibraryErrors](../../models/errors/DeleteLibraryLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# DeletePlaylistBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[DeletePlaylistErrors](../../models/errors/DeletePlaylistErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# DeletePlaylistErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# DeletePlaylistPlaylistsErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# DeletePlaylistUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[DeletePlaylistPlaylistsErrors](../../models/errors/DeletePlaylistPlaylistsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# EnablePaperTrailBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[EnablePaperTrailErrors](../../models/errors/EnablePaperTrailErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# EnablePaperTrailErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# EnablePaperTrailLogErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# EnablePaperTrailUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[EnablePaperTrailLogErrors](../../models/errors/EnablePaperTrailLogErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# Errors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetAllLibrariesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetAllLibrariesErrors](../../models/errors/GetAllLibrariesErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetAllLibrariesErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetAllLibrariesLibraryErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetAllLibrariesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetAllLibrariesLibraryErrors](../../models/errors/GetAllLibrariesLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetAvailableClientsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetAvailableClientsErrors](../../models/errors/GetAvailableClientsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetAvailableClientsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetAvailableClientsServerErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetAvailableClientsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetAvailableClientsServerErrors](../../models/errors/GetAvailableClientsServerErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetBandwidthStatisticsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetBandwidthStatisticsErrors](../../models/errors/GetBandwidthStatisticsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetBandwidthStatisticsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetBandwidthStatisticsStatisticsErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetBandwidthStatisticsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetBandwidthStatisticsStatisticsErrors](../../models/errors/GetBandwidthStatisticsStatisticsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetBannerImageBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetBannerImageErrors](../../models/errors/GetBannerImageErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetBannerImageErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetBannerImageMediaErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetBannerImageUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetBannerImageMediaErrors](../../models/errors/GetBannerImageMediaErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetButlerTasksBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetButlerTasksErrors](../../models/errors/GetButlerTasksErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetButlerTasksButlerErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetButlerTasksErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetButlerTasksUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetButlerTasksButlerErrors](../../models/errors/GetButlerTasksButlerErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetCompanionsDataBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetCompanionsDataErrors](../../models/errors/GetCompanionsDataErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetCompanionsDataErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetCompanionsDataPlexErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetCompanionsDataUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetCompanionsDataPlexErrors](../../models/errors/GetCompanionsDataPlexErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetDevicesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetDevicesErrors](../../models/errors/GetDevicesErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetDevicesErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetDevicesServerErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetDevicesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetDevicesServerErrors](../../models/errors/GetDevicesServerErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetFileHashBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetFileHashErrors](../../models/errors/GetFileHashErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetFileHashErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetFileHashLibraryErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetFileHashUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetFileHashLibraryErrors](../../models/errors/GetFileHashLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetGeoDataBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetGeoDataErrors](../../models/errors/GetGeoDataErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetGeoDataErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetGeoDataPlexErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetGeoDataUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetGeoDataPlexErrors](../../models/errors/GetGeoDataPlexErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetGlobalHubsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetGlobalHubsErrors](../../models/errors/GetGlobalHubsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetGlobalHubsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetGlobalHubsHubsErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetGlobalHubsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetGlobalHubsHubsErrors](../../models/errors/GetGlobalHubsHubsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetHomeDataBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetHomeDataErrors](../../models/errors/GetHomeDataErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetHomeDataErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetHomeDataPlexErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetHomeDataUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetHomeDataPlexErrors](../../models/errors/GetHomeDataPlexErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetLibraryDetailsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetLibraryDetailsErrors](../../models/errors/GetLibraryDetailsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetLibraryDetailsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetLibraryDetailsLibraryErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetLibraryDetailsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetLibraryDetailsLibraryErrors](../../models/errors/GetLibraryDetailsLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetLibraryHubsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetLibraryHubsErrors](../../models/errors/GetLibraryHubsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetLibraryHubsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetLibraryHubsHubsErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetLibraryHubsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List\<[GetLibraryHubsHubsErrors](../../models/errors/GetLibraryHubsHubsErrors.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 |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user