mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 12:37:47 +00:00
Compare commits
54 Commits
liblab-cod
...
v0.6.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
10a61122c2 | ||
|
|
fbca010d26 | ||
|
|
beae244178 | ||
|
|
3499fe6d12 | ||
|
|
f3780ae807 | ||
|
|
ce09c0c9f6 | ||
|
|
d17be8f8fa | ||
|
|
2e07625687 | ||
|
|
258203517f | ||
|
|
af70af8aee | ||
|
|
ee80753a6b | ||
|
|
0bcb23bc24 | ||
|
|
bb34cb3d87 | ||
|
|
fe1cd8c7e4 | ||
|
|
9b00b9305f | ||
|
|
de40bbb5d9 | ||
|
|
2c1cfa8b8d | ||
|
|
5585a18ab9 | ||
|
|
f83d7949e1 | ||
|
|
ac816582a6 | ||
|
|
ac5716c20d | ||
|
|
02ce124a6b | ||
|
|
42b3e684dd | ||
|
|
e01292f115 | ||
|
|
791c875755 | ||
|
|
981d3b0315 | ||
|
|
fe0550bbf2 | ||
|
|
aa9000664f | ||
|
|
6bbcb8fd0f | ||
|
|
1be6dc2bfd | ||
|
|
3ae54cf9c3 | ||
|
|
207d81ed46 | ||
|
|
30b4b97ccd | ||
|
|
78e6a90951 | ||
|
|
c2e5abe96a | ||
|
|
f428a04174 | ||
|
|
fbb10b5a67 | ||
|
|
c46abb8b2b | ||
|
|
330c0f6f59 | ||
|
|
245b8f4ee9 | ||
|
|
364e5a1448 | ||
|
|
ea21a808c6 | ||
|
|
49e9caf871 | ||
|
|
9d2de813ba | ||
|
|
360c0d1336 | ||
|
|
8500f7ef80 | ||
|
|
e04c5b3f06 | ||
|
|
d766b3cc4e | ||
|
|
66ee7fb1ab | ||
|
|
8420084171 | ||
|
|
12f0a76bfe | ||
|
|
366f2fbf89 | ||
|
|
bec5b122c0 | ||
|
|
e1bfef22f0 |
@@ -1,22 +0,0 @@
|
|||||||
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
|
|
||||||
// README at: https://github.com/devcontainers/templates/tree/main/src/java
|
|
||||||
{
|
|
||||||
"name": "Java SDK",
|
|
||||||
"image": "mcr.microsoft.com/devcontainers/java:1-17-bullseye",
|
|
||||||
"features": {
|
|
||||||
"ghcr.io/devcontainers/features/java:1": {
|
|
||||||
"version": "none",
|
|
||||||
"installMaven": "true",
|
|
||||||
"installGradle": "false"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"postCreateCommand": "mvn install && mvn -f examples/pom.xml install",
|
|
||||||
"customizations": {
|
|
||||||
"codespaces": {
|
|
||||||
"openFiles": [
|
|
||||||
"examples/src/main/java/47/one0/examples/Main.java",
|
|
||||||
"README.md"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
PLEXSDK_API_KEY=
|
|
||||||
PLEXSDK_API_KEY_HEADER=
|
|
||||||
12
.gitattributes
vendored
Normal file
12
.gitattributes
vendored
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
#
|
||||||
|
# https://help.github.com/articles/dealing-with-line-endings/
|
||||||
|
#
|
||||||
|
# Linux start script should use lf
|
||||||
|
/gradlew text eol=lf
|
||||||
|
|
||||||
|
# These are Windows script files and should use crlf
|
||||||
|
*.bat text eol=crlf
|
||||||
|
|
||||||
|
# This allows generated code to be indexed correctly
|
||||||
|
*.java linguist-generated=false
|
||||||
|
|
||||||
33
.github/workflows/sdk_generation.yaml
vendored
Normal file
33
.github/workflows/sdk_generation.yaml
vendored
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
name: Generate
|
||||||
|
permissions:
|
||||||
|
checks: write
|
||||||
|
contents: write
|
||||||
|
pull-requests: write
|
||||||
|
statuses: write
|
||||||
|
"on":
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
force:
|
||||||
|
description: Force generation of SDKs
|
||||||
|
type: boolean
|
||||||
|
default: false
|
||||||
|
set_version:
|
||||||
|
description: optionally set a specific SDK version
|
||||||
|
type: string
|
||||||
|
schedule:
|
||||||
|
- cron: 0 0 * * *
|
||||||
|
jobs:
|
||||||
|
generate:
|
||||||
|
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
||||||
|
with:
|
||||||
|
force: ${{ github.event.inputs.force }}
|
||||||
|
mode: direct
|
||||||
|
set_version: ${{ github.event.inputs.set_version }}
|
||||||
|
speakeasy_version: latest
|
||||||
|
secrets:
|
||||||
|
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
java_gpg_passphrase: ${{ secrets.GPG_PASSPHRASE }}
|
||||||
|
java_gpg_secret_key: ${{ secrets.GPG_SECRET_KEY }}
|
||||||
|
ossrh_username: ${{ secrets.OSSRH_USERNAME }}
|
||||||
|
ossrh_password: ${{ secrets.OSSRH_PASSWORD }}
|
||||||
|
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||||
22
.github/workflows/sdk_publish.yaml
vendored
Normal file
22
.github/workflows/sdk_publish.yaml
vendored
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
name: Publish
|
||||||
|
permissions:
|
||||||
|
checks: write
|
||||||
|
contents: write
|
||||||
|
pull-requests: write
|
||||||
|
statuses: write
|
||||||
|
"on":
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
paths:
|
||||||
|
- RELEASES.md
|
||||||
|
- '*/RELEASES.md'
|
||||||
|
jobs:
|
||||||
|
publish:
|
||||||
|
uses: speakeasy-api/sdk-generation-action/.github/workflows/sdk-publish.yaml@v15
|
||||||
|
secrets:
|
||||||
|
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
java_gpg_passphrase: ${{ secrets.GPG_PASSPHRASE }}
|
||||||
|
java_gpg_secret_key: ${{ secrets.GPG_SECRET_KEY }}
|
||||||
|
ossrh_password: ${{ secrets.OSSRH_PASSWORD }}
|
||||||
|
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||||
33
.gitignore
vendored
33
.gitignore
vendored
@@ -1,24 +1,9 @@
|
|||||||
# Compiled class file
|
# Ignore Gradle project-specific cache directory
|
||||||
*.class
|
.gradle
|
||||||
|
# Ignore Gradle build output directory
|
||||||
# Log file
|
build
|
||||||
*.log
|
bin/
|
||||||
|
# Ignore IDE-specific configs
|
||||||
# BlueJ files
|
.project
|
||||||
*.ctxt
|
.settings/
|
||||||
|
.DS_Store
|
||||||
# Mobile Tools for Java (J2ME)
|
|
||||||
.mtj.tmp/
|
|
||||||
|
|
||||||
# Package Files #
|
|
||||||
*.jar
|
|
||||||
*.war
|
|
||||||
*.nar
|
|
||||||
*.ear
|
|
||||||
*.zip
|
|
||||||
*.tar.gz
|
|
||||||
*.rar
|
|
||||||
|
|
||||||
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
|
|
||||||
hs_err_pid*
|
|
||||||
replay_pid*
|
|
||||||
|
|||||||
2747
.speakeasy/gen.lock
Executable file
2747
.speakeasy/gen.lock
Executable file
File diff suppressed because one or more lines are too long
43
.speakeasy/gen.yaml
Normal file
43
.speakeasy/gen.yaml
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
configVersion: 2.0.0
|
||||||
|
generation:
|
||||||
|
sdkClassName: Plex-API
|
||||||
|
maintainOpenAPIOrder: true
|
||||||
|
usageSnippets:
|
||||||
|
optionalPropertyRendering: withExample
|
||||||
|
useClassNamesForArrayFields: true
|
||||||
|
fixes:
|
||||||
|
nameResolutionDec2023: true
|
||||||
|
parameterOrderingFeb2024: true
|
||||||
|
requestResponseComponentNamesFeb2024: true
|
||||||
|
auth:
|
||||||
|
oAuth2ClientCredentialsEnabled: true
|
||||||
|
java:
|
||||||
|
version: 0.6.0
|
||||||
|
additionalDependencies: []
|
||||||
|
additionalPlugins: []
|
||||||
|
artifactID: plexapi
|
||||||
|
clientServerStatusCodesAsErrors: true
|
||||||
|
companyEmail: lukeslakemail@gmail.com
|
||||||
|
companyName: plexapi
|
||||||
|
companyURL: plexapi.dev
|
||||||
|
flattenGlobalSecurity: true
|
||||||
|
githubURL: github.com/LukeHagar/plexjava
|
||||||
|
groupID: dev.plexapi
|
||||||
|
imports:
|
||||||
|
option: openapi
|
||||||
|
paths:
|
||||||
|
callbacks: models/callbacks
|
||||||
|
errors: models/errors
|
||||||
|
operations: models/operations
|
||||||
|
shared: models/shared
|
||||||
|
webhooks: models/webhooks
|
||||||
|
inputModelSuffix: input
|
||||||
|
license:
|
||||||
|
name: The MIT License (MIT)
|
||||||
|
shortName: MIT
|
||||||
|
url: https://mit-license.org/
|
||||||
|
maxMethodParams: 4
|
||||||
|
outputModelSuffix: output
|
||||||
|
packageName: dev.plexapi.sdk
|
||||||
|
projectName: plexapi
|
||||||
|
templateVersion: v2
|
||||||
44
.speakeasy/workflow.lock
Normal file
44
.speakeasy/workflow.lock
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
speakeasyVersion: 1.404.5
|
||||||
|
sources:
|
||||||
|
my-source:
|
||||||
|
sourceNamespace: my-source
|
||||||
|
sourceRevisionDigest: sha256:893baf00932f1b8e49b2e60af272be6a9a62934af6eb3a2f96dd9f2302ef69c5
|
||||||
|
sourceBlobDigest: sha256:f689cdc9c740f4e5120422720722d2d256d56ceb62bc13370713ec1661a433df
|
||||||
|
tags:
|
||||||
|
- latest
|
||||||
|
plexapi:
|
||||||
|
sourceNamespace: plexapi
|
||||||
|
sourceRevisionDigest: sha256:276a31ab98595ebaf2b1fac4b4f5c3c1c7b55e0431f9074c89b8fbcb55b52d3f
|
||||||
|
sourceBlobDigest: sha256:2bc9e816db669d609d8a5988ebb629578dc5cbbaff191d260b5c63b7ba1bd59b
|
||||||
|
tags:
|
||||||
|
- latest
|
||||||
|
- main
|
||||||
|
targets:
|
||||||
|
plexjava:
|
||||||
|
source: plexapi
|
||||||
|
sourceNamespace: plexapi
|
||||||
|
sourceRevisionDigest: sha256:276a31ab98595ebaf2b1fac4b4f5c3c1c7b55e0431f9074c89b8fbcb55b52d3f
|
||||||
|
sourceBlobDigest: sha256:2bc9e816db669d609d8a5988ebb629578dc5cbbaff191d260b5c63b7ba1bd59b
|
||||||
|
codeSamplesNamespace: code-samples-java-plexjava
|
||||||
|
codeSamplesRevisionDigest: sha256:4286e602eb7c7bb7994a5820d46e703830d79724b86399aac3a75e9f2994c975
|
||||||
|
workflow:
|
||||||
|
workflowVersion: 1.0.0
|
||||||
|
speakeasyVersion: latest
|
||||||
|
sources:
|
||||||
|
plexapi:
|
||||||
|
inputs:
|
||||||
|
- location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main
|
||||||
|
targets:
|
||||||
|
plexjava:
|
||||||
|
target: java
|
||||||
|
source: plexapi
|
||||||
|
publish:
|
||||||
|
java:
|
||||||
|
ossrhUsername: $ossrh_username
|
||||||
|
ossrhPassword: $ossrh_password
|
||||||
|
gpgSecretKey: $java_gpg_secret_key
|
||||||
|
gpgPassPhrase: $java_gpg_passphrase
|
||||||
|
codeSamples:
|
||||||
|
output: codeSamples.yaml
|
||||||
|
registry:
|
||||||
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
|
||||||
20
.speakeasy/workflow.yaml
Normal file
20
.speakeasy/workflow.yaml
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
workflowVersion: 1.0.0
|
||||||
|
speakeasyVersion: latest
|
||||||
|
sources:
|
||||||
|
plexapi:
|
||||||
|
inputs:
|
||||||
|
- location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main
|
||||||
|
targets:
|
||||||
|
plexjava:
|
||||||
|
target: java
|
||||||
|
source: plexapi
|
||||||
|
publish:
|
||||||
|
java:
|
||||||
|
ossrhUsername: $ossrh_username
|
||||||
|
ossrhPassword: $ossrh_password
|
||||||
|
gpgSecretKey: $java_gpg_secret_key
|
||||||
|
gpgPassPhrase: $java_gpg_passphrase
|
||||||
|
codeSamples:
|
||||||
|
output: codeSamples.yaml
|
||||||
|
registry:
|
||||||
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
|
||||||
26
CONTRIBUTING.md
Normal file
26
CONTRIBUTING.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# Contributing to This Repository
|
||||||
|
|
||||||
|
Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
|
||||||
|
|
||||||
|
## How to Report Issues
|
||||||
|
|
||||||
|
If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
|
||||||
|
|
||||||
|
- A clear and descriptive title
|
||||||
|
- Steps to reproduce the issue
|
||||||
|
- Expected and actual behavior
|
||||||
|
- Any relevant logs, screenshots, or error messages
|
||||||
|
- Information about your environment (e.g., operating system, software versions)
|
||||||
|
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
|
||||||
|
|
||||||
|
## Issue Triage and Upstream Fixes
|
||||||
|
|
||||||
|
We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
|
||||||
|
|
||||||
|
## Contact
|
||||||
|
|
||||||
|
If you have any questions or need further assistance, please feel free to reach out by opening an issue.
|
||||||
|
|
||||||
|
Thank you for your understanding and cooperation!
|
||||||
|
|
||||||
|
The Maintainers
|
||||||
19
LICENSE
19
LICENSE
@@ -1,19 +0,0 @@
|
|||||||
Copyright (c) 2023
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
||||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
||||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
||||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
|
|
||||||
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
|
||||||
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
|
|
||||||
OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
615
README.md
615
README.md
@@ -1,132 +1,557 @@
|
|||||||
|
# plexapi
|
||||||
|
|
||||||
|
<div align="left">
|
||||||
|
<a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
|
||||||
|
<a href="https://mit-license.org/">
|
||||||
|
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
# PlexSDK Java SDK 0.0.1
|
<!-- Start Summary [summary] -->
|
||||||
A Java SDK for PlexSDK.
|
## Summary
|
||||||
|
|
||||||
An Open API Spec for interacting with Plex.tv and Plex Servers
|
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
||||||
|
|
||||||
- API version: 0.0.1
|
# Plex Media Server OpenAPI Specification
|
||||||
- SDK version: 0.0.1
|
|
||||||
|
|
||||||
|
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 respective repository.
|
||||||
|
|
||||||
|
| 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
|
## Table of Contents
|
||||||
- [Requirements](#requirements)
|
|
||||||
- [Installation](#installation)
|
|
||||||
- [Dependencies](#dependencies)
|
|
||||||
- [Authentication](#authentication)
|
|
||||||
- [API Key](#api-key)
|
|
||||||
- [API Endpoint Services](#api-endpoint-services)
|
|
||||||
- [API Models](#api-models)
|
|
||||||
- [Testing](#testing)
|
|
||||||
- [Configuration](#configuration)
|
|
||||||
- [Sample Usage](#sample-usage)
|
|
||||||
- [License](#license)
|
|
||||||
|
|
||||||
## Requirements
|
* [SDK Installation](#sdk-installation)
|
||||||
|
* [SDK Example Usage](#sdk-example-usage)
|
||||||
|
* [Available Resources and Operations](#available-resources-and-operations)
|
||||||
|
* [Global Parameters](#global-parameters)
|
||||||
|
* [Error Handling](#error-handling)
|
||||||
|
* [Server Selection](#server-selection)
|
||||||
|
* [Authentication](#authentication)
|
||||||
|
<!-- End Table of Contents [toc] -->
|
||||||
|
|
||||||
- Java 8
|
<!-- Start SDK Installation [installation] -->
|
||||||
- Maven
|
## SDK Installation
|
||||||
|
|
||||||
## Installation
|
### Getting started
|
||||||
|
|
||||||
If you use Maven, place the following within the <dependencies> tag in your pom.xml file:
|
JDK 11 or later is required.
|
||||||
|
|
||||||
```XML
|
The samples below show how a published SDK artifact is used:
|
||||||
|
|
||||||
|
Gradle:
|
||||||
|
```groovy
|
||||||
|
implementation 'dev.plexapi:plexapi:0.6.0'
|
||||||
|
```
|
||||||
|
|
||||||
|
Maven:
|
||||||
|
```xml
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>47.one0</groupId>
|
<groupId>dev.plexapi</groupId>
|
||||||
<artifactId>plex-sdk</artifactId>
|
<artifactId>plexapi</artifactId>
|
||||||
<version>0.0.1</version>
|
<version>0.6.0</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
```
|
```
|
||||||
|
|
||||||
If you use Gradle, paste the next line inside the dependencies block of your build.gradle file:
|
### How to build
|
||||||
|
After cloning the git repository to your file system you can build the SDK artifact from source to the `build` directory by running `./gradlew build` on *nix systems or `gradlew.bat` on Windows systems.
|
||||||
|
|
||||||
```Gradle
|
If you wish to build from source and publish the SDK artifact to your local Maven repository (on your filesystem) then use the following command (after cloning the git repo locally):
|
||||||
implementation group: "47.one0", name: "PlexSDK", version: "0.0.1"
|
|
||||||
|
On *nix:
|
||||||
|
```bash
|
||||||
|
./gradlew publishToMavenLocal -Pskip.signing
|
||||||
|
```
|
||||||
|
On Windows:
|
||||||
|
```bash
|
||||||
|
gradlew.bat publishToMavenLocal -Pskip.signing
|
||||||
|
```
|
||||||
|
<!-- End SDK Installation [installation] -->
|
||||||
|
|
||||||
|
<!-- Start SDK Example Usage [usage] -->
|
||||||
|
## SDK Example Usage
|
||||||
|
|
||||||
|
### 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 java.lang.Exception;
|
||||||
|
|
||||||
|
public class Application {
|
||||||
|
|
||||||
|
public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {
|
||||||
|
|
||||||
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
|
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||||
|
.clientName("Plex Web")
|
||||||
|
.clientVersion("4.133.0")
|
||||||
|
.clientPlatform("Chrome")
|
||||||
|
.deviceName("Linux")
|
||||||
|
.build();
|
||||||
|
|
||||||
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
|
.call();
|
||||||
|
|
||||||
|
if (res.object().isPresent()) {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
<!-- End SDK Example Usage [usage] -->
|
||||||
|
|
||||||
|
<!-- Start Available Resources and Operations [operations] -->
|
||||||
|
## Available Resources and Operations
|
||||||
|
|
||||||
|
<details open>
|
||||||
|
<summary>Available methods</summary>
|
||||||
|
|
||||||
|
### [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
|
||||||
|
|
||||||
|
### [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
|
||||||
|
* [stopTask](docs/sdks/butler/README.md#stoptask) - Stop a single Butler task
|
||||||
|
|
||||||
|
### [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
|
||||||
|
|
||||||
|
### [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
|
||||||
|
* [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
|
||||||
|
|
||||||
|
### [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
|
||||||
|
|
||||||
|
### [media()](docs/sdks/media/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
|
||||||
|
|
||||||
|
### [playlists()](docs/sdks/playlists/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
|
||||||
|
|
||||||
|
### [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
|
||||||
|
|
||||||
|
|
||||||
|
### [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
|
||||||
|
|
||||||
|
### [server()](docs/sdks/server/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
|
||||||
|
|
||||||
|
### [sessions()](docs/sdks/sessions/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
|
||||||
|
|
||||||
|
### [statistics()](docs/sdks/statistics/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
|
||||||
|
|
||||||
|
### [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
|
||||||
|
|
||||||
|
</details>
|
||||||
|
<!-- End Available Resources and Operations [operations] -->
|
||||||
|
|
||||||
|
<!-- Start Global Parameters [global-parameters] -->
|
||||||
|
## Global Parameters
|
||||||
|
|
||||||
|
Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed.
|
||||||
|
|
||||||
|
For example, you can set `ClientID` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getPin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
||||||
|
|
||||||
|
|
||||||
|
### Available Globals
|
||||||
|
|
||||||
|
The following global parameters are available.
|
||||||
|
|
||||||
|
| Name | Type | Required | Description |
|
||||||
|
| ---- | ---- |:--------:| ----------- |
|
||||||
|
| clientID | java.lang.String | | The unique identifier for the client application
|
||||||
|
This is used to track the client application and its usage
|
||||||
|
(UUID, serial number, or other number unique per device)
|
||||||
|
|
|
||||||
|
| clientName | java.lang.String | | The clientName parameter. |
|
||||||
|
| clientVersion | java.lang.String | | The clientVersion parameter. |
|
||||||
|
| clientPlatform | java.lang.String | | The clientPlatform parameter. |
|
||||||
|
| deviceName | java.lang.String | | The deviceName parameter. |
|
||||||
|
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```java
|
||||||
|
package hello.world;
|
||||||
|
|
||||||
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
|
import dev.plexapi.sdk.models.errors.GetPinBadRequest;
|
||||||
|
import dev.plexapi.sdk.models.operations.GetPinRequest;
|
||||||
|
import dev.plexapi.sdk.models.operations.GetPinResponse;
|
||||||
|
import java.lang.Exception;
|
||||||
|
|
||||||
|
public class Application {
|
||||||
|
|
||||||
|
public static void main(String[] args) throws GetPinBadRequest, Exception {
|
||||||
|
|
||||||
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
|
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||||
|
.clientName("Plex Web")
|
||||||
|
.clientVersion("4.133.0")
|
||||||
|
.clientPlatform("Chrome")
|
||||||
|
.deviceName("Linux")
|
||||||
|
.build();
|
||||||
|
|
||||||
|
GetPinRequest req = GetPinRequest.builder()
|
||||||
|
.build();
|
||||||
|
|
||||||
|
GetPinResponse res = sdk.plex().getPin()
|
||||||
|
.request(req)
|
||||||
|
.call();
|
||||||
|
|
||||||
|
if (res.authPinContainer().isPresent()) {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
<!-- End Global Parameters [global-parameters] -->
|
||||||
|
|
||||||
|
<!-- Start Error Handling [errors] -->
|
||||||
|
## Error Handling
|
||||||
|
|
||||||
|
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Exception type.
|
||||||
|
|
||||||
|
| Error Object | Status Code | Content Type |
|
||||||
|
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
|
||||||
|
| models/errors/GetServerCapabilitiesBadRequest | 400 | application/json |
|
||||||
|
| models/errors/GetServerCapabilitiesUnauthorized | 401 | application/json |
|
||||||
|
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
||||||
|
|
||||||
|
### 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 java.lang.Exception;
|
||||||
|
|
||||||
|
public class Application {
|
||||||
|
|
||||||
|
public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {
|
||||||
|
|
||||||
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
|
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||||
|
.clientName("Plex Web")
|
||||||
|
.clientVersion("4.133.0")
|
||||||
|
.clientPlatform("Chrome")
|
||||||
|
.deviceName("Linux")
|
||||||
|
.build();
|
||||||
|
|
||||||
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
|
.call();
|
||||||
|
|
||||||
|
if (res.object().isPresent()) {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
<!-- End Error Handling [errors] -->
|
||||||
|
|
||||||
|
<!-- Start Server Selection [server] -->
|
||||||
|
## Server Selection
|
||||||
|
|
||||||
|
### Select Server by Index
|
||||||
|
|
||||||
|
You can override the default server globally by passing a server index to the `serverIndex` 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 |
|
||||||
|
| - | ------ | --------- |
|
||||||
|
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `https`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
||||||
|
|
||||||
|
#### 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 java.lang.Exception;
|
||||||
|
|
||||||
|
public class Application {
|
||||||
|
|
||||||
|
public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {
|
||||||
|
|
||||||
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
|
.serverIndex(0)
|
||||||
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
|
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||||
|
.clientName("Plex Web")
|
||||||
|
.clientVersion("4.133.0")
|
||||||
|
.clientPlatform("Chrome")
|
||||||
|
.deviceName("Linux")
|
||||||
|
.build();
|
||||||
|
|
||||||
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
|
.call();
|
||||||
|
|
||||||
|
if (res.object().isPresent()) {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Variables
|
||||||
|
|
||||||
|
Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
|
||||||
|
* `ServerProtocol protocol`
|
||||||
|
* `String ip`
|
||||||
|
* `String port`
|
||||||
|
|
||||||
|
### Override Server URL Per-Client
|
||||||
|
|
||||||
|
The default server can also be overridden globally by passing a URL to the `serverURL` builder method 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 java.lang.Exception;
|
||||||
|
|
||||||
|
public class Application {
|
||||||
|
|
||||||
|
public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {
|
||||||
|
|
||||||
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
|
.serverURL("{protocol}://{ip}:{port}")
|
||||||
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
|
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||||
|
.clientName("Plex Web")
|
||||||
|
.clientVersion("4.133.0")
|
||||||
|
.clientPlatform("Chrome")
|
||||||
|
.deviceName("Linux")
|
||||||
|
.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>")
|
||||||
|
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||||
|
.clientName("Plex Web")
|
||||||
|
.clientVersion("4.133.0")
|
||||||
|
.clientPlatform("Chrome")
|
||||||
|
.deviceName("Linux")
|
||||||
|
.build();
|
||||||
|
|
||||||
|
GetCompanionsDataResponse res = sdk.plex().getCompanionsData()
|
||||||
|
.serverURL("https://plex.tv/api/v2")
|
||||||
|
.call();
|
||||||
|
|
||||||
|
if (res.responseBodies().isPresent()) {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
<!-- End Server Selection [server] -->
|
||||||
|
|
||||||
|
<!-- Start Authentication [security] -->
|
||||||
## Authentication
|
## Authentication
|
||||||
|
|
||||||
To see whether an endpoint needs a specific type of authentication check the endpoint's documentation.
|
### Per-Client Security Schemes
|
||||||
|
|
||||||
### API Key
|
This SDK supports the following security scheme globally:
|
||||||
The PlexSDK API uses API keys as a form of authentication.
|
|
||||||
An API key is a unique identifier used to authenticate a user, developer, or calling program to an API.
|
|
||||||
|
|
||||||
The API key can be set for the SDK through:
|
| Name | Type | Scheme |
|
||||||
|
| ------------- | ------------- | ------------- |
|
||||||
|
| `accessToken` | apiKey | API key |
|
||||||
|
|
||||||
```Java
|
To authenticate with the API the `accessToken` parameter must be set when initializing the SDK client instance. For example:
|
||||||
PlexSDK sdk = new PlexSDK("YOUR_API_KEY", "YOUR_API_KEY_HEADER");
|
```java
|
||||||
```
|
package hello.world;
|
||||||
|
|
||||||
## API Endpoint Services
|
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 java.lang.Exception;
|
||||||
|
|
||||||
All URIs are relative to http://10.10.10.47:32400.
|
public class Application {
|
||||||
|
|
||||||
Click the service name for a full list of the service methods.
|
public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {
|
||||||
|
|
||||||
| Service |
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
| :------ |
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
|[ServerService](src/main/java/47/one0/services/README.md#serverservice)|
|
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||||
|[MediaService](src/main/java/47/one0/services/README.md#mediaservice)|
|
.clientName("Plex Web")
|
||||||
|[ActivitiesService](src/main/java/47/one0/services/README.md#activitiesservice)|
|
.clientVersion("4.133.0")
|
||||||
|[ButlerService](src/main/java/47/one0/services/README.md#butlerservice)|
|
.clientPlatform("Chrome")
|
||||||
|[HubsService](src/main/java/47/one0/services/README.md#hubsservice)|
|
.deviceName("Linux")
|
||||||
|[SearchService](src/main/java/47/one0/services/README.md#searchservice)|
|
.build();
|
||||||
|[LibraryService](src/main/java/47/one0/services/README.md#libraryservice)|
|
|
||||||
|[LogService](src/main/java/47/one0/services/README.md#logservice)|
|
|
||||||
|[PlaylistsService](src/main/java/47/one0/services/README.md#playlistsservice)|
|
|
||||||
|[SecurityService](src/main/java/47/one0/services/README.md#securityservice)|
|
|
||||||
|[SessionsService](src/main/java/47/one0/services/README.md#sessionsservice)|
|
|
||||||
|[UpdaterService](src/main/java/47/one0/services/README.md#updaterservice)|
|
|
||||||
|[VideoService](src/main/java/47/one0/services/README.md#videoservice)|
|
|
||||||
|
|
||||||
## API Models
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
[A list documenting all API models for this SDK](src/main/java/47/one0//models/README.md#plexsdk-models).
|
.call();
|
||||||
|
|
||||||
## Testing
|
if (res.object().isPresent()) {
|
||||||
|
// handle response
|
||||||
Unit tests aren't available yet. When they are, you'll be able to run them with this command:
|
}
|
||||||
|
|
||||||
```Bash
|
|
||||||
mvn clean test
|
|
||||||
```
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
Your SDK may require some configuration changes.
|
|
||||||
|
|
||||||
|
|
||||||
This API is configured to use a security token for authorization. You should edit `examples/src/main/java/47/one0/examples/Main.java` and paste your own tokens in place of `PLEXSDK_API_KEY` & `PLEXSDK_API_KEY_HEADER`.
|
|
||||||
|
|
||||||
|
|
||||||
## Sample Usage
|
|
||||||
|
|
||||||
```Java
|
|
||||||
package 47.one0.examples;
|
|
||||||
|
|
||||||
import 47.one0.exceptions.ApiException;
|
|
||||||
import 47.one0.PlexSDK;
|
|
||||||
|
|
||||||
public class Main {
|
|
||||||
|
|
||||||
public static void main(String[] args) {
|
|
||||||
PlexSDK client = new PlexSDK(System.getenv("PLEXSDK_API_KEY"), System.getenv("PLEXSDK_API_KEY_HEADER"));
|
|
||||||
try {
|
|
||||||
Object response = client.serverService.getServerCapabilities();
|
|
||||||
System.out.println(response);
|
|
||||||
} catch(ApiException e) {
|
|
||||||
e.printStackTrace();
|
|
||||||
}
|
}
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
```
|
```
|
||||||
|
<!-- End Authentication [security] -->
|
||||||
|
|
||||||
Inside this directory is `examples/src/main/java/47/one0/examples/Main.java`. It's a simple, "hello, world" level program to demonstate this SDK. Run `install.sh` to prepare the SDK for use.
|
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
||||||
|
|
||||||
To see what other functions this SDK is capable of, look inside `src/main/java/47/one0/http/*Client.java`.
|
# Development
|
||||||
|
|
||||||
## License
|
## Maturity
|
||||||
|
|
||||||
License: MIT. See license in LICENSE.
|
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
|
||||||
|
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
|
||||||
|
looking for the latest version.
|
||||||
|
|
||||||
|
## Contributions
|
||||||
|
|
||||||
|
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
|
||||||
|
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
|
||||||
|
|
||||||
|
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
|
||||||
|
|||||||
111
RELEASES.md
Normal file
111
RELEASES.md
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
|
||||||
|
|
||||||
|
## 2024-09-13 00:24:14
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.396.6 (2.415.6) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.3.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.3.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.3.0 - .
|
||||||
|
|
||||||
|
## 2024-09-16 18:23:01
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.397.2 (2.415.8) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.3.1] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.3.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.3.1 - .
|
||||||
|
|
||||||
|
## 2024-09-16 18:32:47
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.397.2 (2.415.8) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.3.2] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.3.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.3.2 - .
|
||||||
|
|
||||||
|
## 2024-09-16 18:54:58
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.397.2 (2.415.8) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.3.3] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.3.3] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.3.3 - .
|
||||||
|
|
||||||
|
## 2024-09-16 19:14:13
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.397.3 (2.415.8) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.3.4] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.3.4] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.3.4 - .
|
||||||
|
|
||||||
|
## 2024-09-16 19:32:27
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.397.3 (2.415.8) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.3.5] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.3.5] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.3.5 - .
|
||||||
|
|
||||||
|
## 2024-09-19 00:24:42
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.399.2 (2.416.6) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.3.6] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.3.6] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.3.6 - .
|
||||||
|
|
||||||
|
## 2024-09-21 00:24:14
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.401.2 (2.421.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.4.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.4.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.4.0 - .
|
||||||
|
|
||||||
|
## 2024-09-22 00:27:50
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.401.2 (2.421.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.4.1] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.4.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.4.1 - .
|
||||||
|
|
||||||
|
## 2024-09-26 00:25:07
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.402.14 (2.422.22) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.5.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.5.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.5.0 - .
|
||||||
|
|
||||||
|
## 2024-09-28 00:25:08
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.404.5 (2.426.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.6.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.6.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.6.0 - .
|
||||||
33
USAGE.md
Normal file
33
USAGE.md
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
<!-- Start SDK Example Usage [usage] -->
|
||||||
|
```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 java.lang.Exception;
|
||||||
|
|
||||||
|
public class Application {
|
||||||
|
|
||||||
|
public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {
|
||||||
|
|
||||||
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
|
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||||
|
.clientName("Plex Web")
|
||||||
|
.clientVersion("4.133.0")
|
||||||
|
.clientPlatform("Chrome")
|
||||||
|
.deviceName("Linux")
|
||||||
|
.build();
|
||||||
|
|
||||||
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
|
.call();
|
||||||
|
|
||||||
|
if (res.object().isPresent()) {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
<!-- End SDK Example Usage [usage] -->
|
||||||
4
build-extras.gradle
Normal file
4
build-extras.gradle
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
// This file
|
||||||
|
// * is referred to in an `apply from` command in `build.gradle`
|
||||||
|
// * can be used to customise `build.gradle`
|
||||||
|
// * is generated once and not overwritten in SDK generation updates
|
||||||
162
build.gradle
Normal file
162
build.gradle
Normal file
@@ -0,0 +1,162 @@
|
|||||||
|
|
||||||
|
////////////////////////////////////////////////////////////////////////////////////////////
|
||||||
|
// This file is generated by Speakeasy and any edits will be lost in generation updates.
|
||||||
|
//
|
||||||
|
// If you wish to customize this file then place those customizations in `build-extras.gradle` which
|
||||||
|
// is not touched by generation updates.
|
||||||
|
//
|
||||||
|
// Additions to the plugins block can be made by setting the `additionalPlugins` property (an array
|
||||||
|
// of string where each string value is an additional line in the block) in gen.yaml.
|
||||||
|
////////////////////////////////////////////////////////////////////////////////////////////
|
||||||
|
|
||||||
|
plugins {
|
||||||
|
// Apply the java-library plugin for API and implementation separation.
|
||||||
|
id 'java-library'
|
||||||
|
id 'maven-publish'
|
||||||
|
id 'signing'
|
||||||
|
id 'cl.franciscosolis.sonatype-central-upload' version '1.0.3'
|
||||||
|
}
|
||||||
|
|
||||||
|
compileJava.options.encoding = "UTF-8"
|
||||||
|
compileJava.options.compilerArgs += '-Xlint:unchecked'
|
||||||
|
compileTestJava.options.encoding = "UTF-8"
|
||||||
|
|
||||||
|
repositories {
|
||||||
|
// Use Maven Central for resolving dependencies.
|
||||||
|
mavenCentral()
|
||||||
|
}
|
||||||
|
|
||||||
|
java {
|
||||||
|
sourceCompatibility = JavaVersion.VERSION_11
|
||||||
|
targetCompatibility = JavaVersion.VERSION_11
|
||||||
|
withSourcesJar()
|
||||||
|
withJavadocJar()
|
||||||
|
}
|
||||||
|
|
||||||
|
model {
|
||||||
|
tasks.generatePomFileForMavenPublication {
|
||||||
|
destination = file("$buildDir/pom.xml")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
jar {
|
||||||
|
dependsOn(":generatePomFileForMavenPublication")
|
||||||
|
archiveBaseName = "plexapi"
|
||||||
|
|
||||||
|
into("META-INF/maven/dev.plexapi/plexapi") {
|
||||||
|
from("$buildDir/pom.xml")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
javadoc {
|
||||||
|
options.encoding = "UTF-8"
|
||||||
|
|
||||||
|
if(JavaVersion.current().isJava9Compatible()) {
|
||||||
|
options.addBooleanOption('html5', true)
|
||||||
|
}
|
||||||
|
options.addStringOption('Xdoclint:none', '-quiet')
|
||||||
|
}
|
||||||
|
|
||||||
|
tasks.withType(Javadoc) {
|
||||||
|
failOnError false
|
||||||
|
options.addStringOption('Xdoclint:none', '-quiet')
|
||||||
|
}
|
||||||
|
|
||||||
|
group = "dev.plexapi"
|
||||||
|
version = "0.6.0"
|
||||||
|
|
||||||
|
sourcesJar {
|
||||||
|
archiveBaseName = "plexapi"
|
||||||
|
}
|
||||||
|
|
||||||
|
javadocJar {
|
||||||
|
archiveBaseName = "plexapi"
|
||||||
|
}
|
||||||
|
sonatypeCentralUpload {
|
||||||
|
// This is your Sonatype generated username
|
||||||
|
username = System.getenv("SONATYPE_USERNAME")
|
||||||
|
// This is your sonatype generated password
|
||||||
|
password = System.getenv("SONATYPE_PASSWORD")
|
||||||
|
|
||||||
|
// 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"
|
||||||
|
)
|
||||||
|
|
||||||
|
// This is the pom file to upload. This is required by central
|
||||||
|
pom = file("$buildDir/pom.xml")
|
||||||
|
|
||||||
|
// This is your PGP private key. This is required to sign your files
|
||||||
|
signingKey = System.getenv("SONATYPE_SIGNING_KEY")
|
||||||
|
// This is your PGP private key passphrase to decrypt your private key
|
||||||
|
signingKeyPassphrase = System.getenv("SIGNING_KEY_PASSPHRASE")
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
publishing {
|
||||||
|
|
||||||
|
publications {
|
||||||
|
maven(MavenPublication) {
|
||||||
|
groupId = 'dev.plexapi'
|
||||||
|
artifactId = 'plexapi'
|
||||||
|
version = '0.6.0'
|
||||||
|
|
||||||
|
from components.java
|
||||||
|
|
||||||
|
pom {
|
||||||
|
name = 'plexapi Java SDK'
|
||||||
|
description = 'SDK enabling Java developers to easily integrate with the plexapi API.'
|
||||||
|
url = 'https://github.com/LukeHagar/plexjava'
|
||||||
|
scm {
|
||||||
|
url = 'github.com/LukeHagar/plexjava'
|
||||||
|
connection = 'scm:git:ssh://git@github.com/LukeHagar/plexjava.git'
|
||||||
|
}
|
||||||
|
licenses {
|
||||||
|
license {
|
||||||
|
name = 'The MIT License (MIT)'
|
||||||
|
url = 'https://mit-license.org/'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
developers {
|
||||||
|
developer {
|
||||||
|
name = 'plexapi'
|
||||||
|
organization = 'plexapi'
|
||||||
|
email = 'lukeslakemail@gmail.com'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
organization {
|
||||||
|
name = 'plexapi'
|
||||||
|
url = 'plexapi.dev'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!project.hasProperty('skip.signing')) {
|
||||||
|
signing {
|
||||||
|
def signingKey = findProperty("signingKey")
|
||||||
|
def signingPassphrase = findProperty("signingPassphrase")
|
||||||
|
useInMemoryPgpKeys(signingKey, signingPassphrase)
|
||||||
|
sign publishing.publications.maven
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
dependencies {
|
||||||
|
implementation 'com.fasterxml.jackson.core:jackson-databind:2.17.2'
|
||||||
|
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.17.2'
|
||||||
|
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.17.2'
|
||||||
|
implementation 'org.openapitools:jackson-databind-nullable:0.2.6'
|
||||||
|
implementation 'org.apache.httpcomponents:httpclient:4.5.14'
|
||||||
|
implementation 'org.apache.httpcomponents:httpmime:4.5.14'
|
||||||
|
implementation 'commons-io:commons-io:2.15.1'
|
||||||
|
testImplementation 'org.junit.jupiter:junit-jupiter:5.10.2'
|
||||||
|
testImplementation 'org.mockito:mockito-core:5.12.0'
|
||||||
|
testRuntimeOnly 'org.junit.platform:junit-platform-launcher:1.10.2'
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
apply from: 'build-extras.gradle'
|
||||||
2836
codeSamples.yaml
Normal file
2836
codeSamples.yaml
Normal file
File diff suppressed because it is too large
Load Diff
11
docs/models/errors/AddPlaylistContentsBadRequest.md
Normal file
11
docs/models/errors/AddPlaylistContentsBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/AddPlaylistContentsErrors.md
Normal file
10
docs/models/errors/AddPlaylistContentsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/AddPlaylistContentsPlaylistsErrors.md
Normal file
10
docs/models/errors/AddPlaylistContentsPlaylistsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/AddPlaylistContentsUnauthorized.md
Normal file
11
docs/models/errors/AddPlaylistContentsUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/ApplyUpdatesBadRequest.md
Normal file
11
docs/models/errors/ApplyUpdatesBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/ApplyUpdatesErrors.md
Normal file
10
docs/models/errors/ApplyUpdatesErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/ApplyUpdatesUnauthorized.md
Normal file
11
docs/models/errors/ApplyUpdatesUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/ApplyUpdatesUpdaterErrors.md
Normal file
10
docs/models/errors/ApplyUpdatesUpdaterErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/CancelServerActivitiesActivitiesErrors.md
Normal file
10
docs/models/errors/CancelServerActivitiesActivitiesErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/CancelServerActivitiesBadRequest.md
Normal file
11
docs/models/errors/CancelServerActivitiesBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/CancelServerActivitiesErrors.md
Normal file
10
docs/models/errors/CancelServerActivitiesErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/CancelServerActivitiesUnauthorized.md
Normal file
11
docs/models/errors/CancelServerActivitiesUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/CheckForUpdatesBadRequest.md
Normal file
11
docs/models/errors/CheckForUpdatesBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/CheckForUpdatesErrors.md
Normal file
10
docs/models/errors/CheckForUpdatesErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/CheckForUpdatesUnauthorized.md
Normal file
11
docs/models/errors/CheckForUpdatesUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/CheckForUpdatesUpdaterErrors.md
Normal file
10
docs/models/errors/CheckForUpdatesUpdaterErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/ClearPlaylistContentsBadRequest.md
Normal file
11
docs/models/errors/ClearPlaylistContentsBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/ClearPlaylistContentsErrors.md
Normal file
10
docs/models/errors/ClearPlaylistContentsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/ClearPlaylistContentsPlaylistsErrors.md
Normal file
10
docs/models/errors/ClearPlaylistContentsPlaylistsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/ClearPlaylistContentsUnauthorized.md
Normal file
11
docs/models/errors/ClearPlaylistContentsUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/CreatePlaylistBadRequest.md
Normal file
11
docs/models/errors/CreatePlaylistBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/CreatePlaylistErrors.md
Normal file
10
docs/models/errors/CreatePlaylistErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/CreatePlaylistPlaylistsErrors.md
Normal file
10
docs/models/errors/CreatePlaylistPlaylistsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/CreatePlaylistUnauthorized.md
Normal file
11
docs/models/errors/CreatePlaylistUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/DeleteLibraryBadRequest.md
Normal file
11
docs/models/errors/DeleteLibraryBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/DeleteLibraryErrors.md
Normal file
10
docs/models/errors/DeleteLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/DeleteLibraryLibraryErrors.md
Normal file
10
docs/models/errors/DeleteLibraryLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/DeleteLibraryUnauthorized.md
Normal file
11
docs/models/errors/DeleteLibraryUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/DeletePlaylistBadRequest.md
Normal file
11
docs/models/errors/DeletePlaylistBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/DeletePlaylistErrors.md
Normal file
10
docs/models/errors/DeletePlaylistErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/DeletePlaylistPlaylistsErrors.md
Normal file
10
docs/models/errors/DeletePlaylistPlaylistsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/DeletePlaylistUnauthorized.md
Normal file
11
docs/models/errors/DeletePlaylistUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/EnablePaperTrailBadRequest.md
Normal file
11
docs/models/errors/EnablePaperTrailBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/EnablePaperTrailErrors.md
Normal file
10
docs/models/errors/EnablePaperTrailErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/EnablePaperTrailLogErrors.md
Normal file
10
docs/models/errors/EnablePaperTrailLogErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/EnablePaperTrailUnauthorized.md
Normal file
11
docs/models/errors/EnablePaperTrailUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/Errors.md
Normal file
10
docs/models/errors/Errors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# Errors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *Optional<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||||
11
docs/models/errors/GetAllLibrariesBadRequest.md
Normal file
11
docs/models/errors/GetAllLibrariesBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetAllLibrariesErrors.md
Normal file
10
docs/models/errors/GetAllLibrariesErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetAllLibrariesLibraryErrors.md
Normal file
10
docs/models/errors/GetAllLibrariesLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetAllLibrariesUnauthorized.md
Normal file
11
docs/models/errors/GetAllLibrariesUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetAvailableClientsBadRequest.md
Normal file
11
docs/models/errors/GetAvailableClientsBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetAvailableClientsErrors.md
Normal file
10
docs/models/errors/GetAvailableClientsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetAvailableClientsServerErrors.md
Normal file
10
docs/models/errors/GetAvailableClientsServerErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetAvailableClientsUnauthorized.md
Normal file
11
docs/models/errors/GetAvailableClientsUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetBandwidthStatisticsBadRequest.md
Normal file
11
docs/models/errors/GetBandwidthStatisticsBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetBandwidthStatisticsErrors.md
Normal file
10
docs/models/errors/GetBandwidthStatisticsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetBandwidthStatisticsStatisticsErrors.md
Normal file
10
docs/models/errors/GetBandwidthStatisticsStatisticsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetBandwidthStatisticsUnauthorized.md
Normal file
11
docs/models/errors/GetBandwidthStatisticsUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetBannerImageBadRequest.md
Normal file
11
docs/models/errors/GetBannerImageBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetBannerImageErrors.md
Normal file
10
docs/models/errors/GetBannerImageErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetBannerImageMediaErrors.md
Normal file
10
docs/models/errors/GetBannerImageMediaErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetBannerImageUnauthorized.md
Normal file
11
docs/models/errors/GetBannerImageUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetButlerTasksBadRequest.md
Normal file
11
docs/models/errors/GetButlerTasksBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetButlerTasksButlerErrors.md
Normal file
10
docs/models/errors/GetButlerTasksButlerErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetButlerTasksErrors.md
Normal file
10
docs/models/errors/GetButlerTasksErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetButlerTasksUnauthorized.md
Normal file
11
docs/models/errors/GetButlerTasksUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetCompanionsDataBadRequest.md
Normal file
11
docs/models/errors/GetCompanionsDataBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetCompanionsDataErrors.md
Normal file
10
docs/models/errors/GetCompanionsDataErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetCompanionsDataPlexErrors.md
Normal file
10
docs/models/errors/GetCompanionsDataPlexErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetCompanionsDataUnauthorized.md
Normal file
11
docs/models/errors/GetCompanionsDataUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetDevicesBadRequest.md
Normal file
11
docs/models/errors/GetDevicesBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetDevicesErrors.md
Normal file
10
docs/models/errors/GetDevicesErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetDevicesServerErrors.md
Normal file
10
docs/models/errors/GetDevicesServerErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetDevicesUnauthorized.md
Normal file
11
docs/models/errors/GetDevicesUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetFileHashBadRequest.md
Normal file
11
docs/models/errors/GetFileHashBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetFileHashErrors.md
Normal file
10
docs/models/errors/GetFileHashErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetFileHashLibraryErrors.md
Normal file
10
docs/models/errors/GetFileHashLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetFileHashUnauthorized.md
Normal file
11
docs/models/errors/GetFileHashUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetGeoDataBadRequest.md
Normal file
11
docs/models/errors/GetGeoDataBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetGeoDataErrors.md
Normal file
10
docs/models/errors/GetGeoDataErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetGeoDataPlexErrors.md
Normal file
10
docs/models/errors/GetGeoDataPlexErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetGeoDataUnauthorized.md
Normal file
11
docs/models/errors/GetGeoDataUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetGlobalHubsBadRequest.md
Normal file
11
docs/models/errors/GetGlobalHubsBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetGlobalHubsErrors.md
Normal file
10
docs/models/errors/GetGlobalHubsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetGlobalHubsHubsErrors.md
Normal file
10
docs/models/errors/GetGlobalHubsHubsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetGlobalHubsUnauthorized.md
Normal file
11
docs/models/errors/GetGlobalHubsUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetHomeDataBadRequest.md
Normal file
11
docs/models/errors/GetHomeDataBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetHomeDataErrors.md
Normal file
10
docs/models/errors/GetHomeDataErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
10
docs/models/errors/GetHomeDataPlexErrors.md
Normal file
10
docs/models/errors/GetHomeDataPlexErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetHomeDataUnauthorized.md
Normal file
11
docs/models/errors/GetHomeDataUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
11
docs/models/errors/GetLibraryDetailsBadRequest.md
Normal file
11
docs/models/errors/GetLibraryDetailsBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# 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 |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user