mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-07 20:47:45 +00:00
Compare commits
1 Commits
v0.21.1
...
liblab-cod
| Author | SHA1 | Date | |
|---|---|---|---|
|
d8697f3fa9 |
22
.devcontainer/devcontainer.json
Normal file
22
.devcontainer/devcontainer.json
Normal file
@@ -0,0 +1,22 @@
|
||||
// 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"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
2
.env.example
Normal file
2
.env.example
Normal file
@@ -0,0 +1,2 @@
|
||||
PLEXSDK_API_KEY=
|
||||
PLEXSDK_API_KEY_HEADER=
|
||||
11
.gitattributes
vendored
11
.gitattributes
vendored
@@ -1,11 +0,0 @@
|
||||
#
|
||||
# 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
|
||||
23
.github/workflows/codesee-arch-diagram.yml
vendored
Normal file
23
.github/workflows/codesee-arch-diagram.yml
vendored
Normal file
@@ -0,0 +1,23 @@
|
||||
# This workflow was added by CodeSee. Learn more at https://codesee.io/
|
||||
# This is v2.0 of this workflow file
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
pull_request_target:
|
||||
types: [opened, synchronize, reopened]
|
||||
|
||||
name: CodeSee
|
||||
|
||||
permissions: read-all
|
||||
|
||||
jobs:
|
||||
codesee:
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
name: Analyze the repo with CodeSee
|
||||
steps:
|
||||
- uses: Codesee-io/codesee-action@v2
|
||||
with:
|
||||
codesee-token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}
|
||||
codesee-url: https://app.codesee.io
|
||||
33
.github/workflows/sdk_generation.yaml
vendored
33
.github/workflows/sdk_generation.yaml
vendored
@@ -1,33 +0,0 @@
|
||||
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
22
.github/workflows/sdk_publish.yaml
vendored
@@ -1,22 +0,0 @@
|
||||
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 }}
|
||||
38
.gitignore
vendored
38
.gitignore
vendored
@@ -1,14 +1,24 @@
|
||||
.env
|
||||
.env.local
|
||||
**/.speakeasy/temp/
|
||||
**/.speakeasy/logs/
|
||||
.speakeasy/reports
|
||||
# Ignore Gradle project-specific cache directory
|
||||
.gradle
|
||||
# Ignore Gradle build output directory
|
||||
build
|
||||
bin/
|
||||
# Ignore IDE-specific configs
|
||||
.project
|
||||
.settings/
|
||||
.DS_Store
|
||||
# Compiled class file
|
||||
*.class
|
||||
|
||||
# Log file
|
||||
*.log
|
||||
|
||||
# BlueJ files
|
||||
*.ctxt
|
||||
|
||||
# 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*
|
||||
|
||||
8402
.speakeasy/gen.lock
8402
.speakeasy/gen.lock
File diff suppressed because one or more lines are too long
@@ -1,67 +0,0 @@
|
||||
configVersion: 2.0.0
|
||||
generation:
|
||||
sdkClassName: Plex-API
|
||||
maintainOpenAPIOrder: true
|
||||
usageSnippets:
|
||||
optionalPropertyRendering: withExample
|
||||
sdkInitStyle: constructor
|
||||
useClassNamesForArrayFields: true
|
||||
fixes:
|
||||
nameResolutionDec2023: true
|
||||
nameResolutionFeb2025: false
|
||||
parameterOrderingFeb2024: true
|
||||
requestResponseComponentNamesFeb2024: true
|
||||
securityFeb2025: false
|
||||
sharedErrorComponentsApr2025: false
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
oAuth2PasswordEnabled: false
|
||||
hoistGlobalSecurity: true
|
||||
tests:
|
||||
generateTests: true
|
||||
generateNewTests: false
|
||||
skipResponseBodyAssertions: false
|
||||
requestBodyFieldName: ""
|
||||
schemas:
|
||||
allOfMergeStrategy: shallowMerge
|
||||
java:
|
||||
version: 0.21.1
|
||||
additionalDependencies: []
|
||||
additionalPlugins: []
|
||||
artifactID: plexapi
|
||||
asyncMode: enabled
|
||||
baseErrorName: PlexAPIError
|
||||
clientServerStatusCodesAsErrors: true
|
||||
companyEmail: lukeslakemail@gmail.com
|
||||
companyName: plexapi
|
||||
companyURL: plexapi.dev
|
||||
defaultErrorName: SDKError
|
||||
enableCustomCodeRegions: false
|
||||
enableStreamingUploads: false
|
||||
enhancedUnionMemberResolution: true
|
||||
flattenGlobalSecurity: true
|
||||
generateOptionalUnionAccessors: false
|
||||
generateSpringBootStarter: 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
|
||||
languageVersion: 11
|
||||
license:
|
||||
name: The MIT License (MIT)
|
||||
shortName: MIT
|
||||
url: https://mit-license.org/
|
||||
maxMethodParams: 4
|
||||
nullFriendlyParameters: false
|
||||
openUnions: true
|
||||
outputModelSuffix: output
|
||||
packageName: dev.plexapi.sdk
|
||||
projectName: plexapi
|
||||
templateVersion: v2
|
||||
@@ -1,49 +0,0 @@
|
||||
speakeasyVersion: 1.615.2
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
sourceRevisionDigest: sha256:893baf00932f1b8e49b2e60af272be6a9a62934af6eb3a2f96dd9f2302ef69c5
|
||||
sourceBlobDigest: sha256:f689cdc9c740f4e5120422720722d2d256d56ceb62bc13370713ec1661a433df
|
||||
tags:
|
||||
- latest
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:56fc783b16af019db4eb0fe52df504315e8e7c7ae41e319a61bba8823f19df4b
|
||||
sourceBlobDigest: sha256:b62613477fd824bb42cf0bf5d0f9980448259c9c7456e03ca6a10eef39a3994f
|
||||
tags:
|
||||
- latest
|
||||
- speakeasy-sdk-regen-1762993854
|
||||
- 1.1.1
|
||||
targets:
|
||||
plexjava:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:56fc783b16af019db4eb0fe52df504315e8e7c7ae41e319a61bba8823f19df4b
|
||||
sourceBlobDigest: sha256:b62613477fd824bb42cf0bf5d0f9980448259c9c7456e03ca6a10eef39a3994f
|
||||
codeSamplesNamespace: code-samples-java-plexjava
|
||||
codeSamplesRevisionDigest: sha256:d498e8e83e2cc9e1ffee0af580b876cb3f60cda1e757ed33a6b600395b9cfd78
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
sources:
|
||||
plexapi:
|
||||
inputs:
|
||||
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/plex-api-spec.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
|
||||
targets:
|
||||
plexjava:
|
||||
target: java
|
||||
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
|
||||
labelOverride:
|
||||
fixedValue: PlexJava
|
||||
@@ -1,24 +0,0 @@
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
sources:
|
||||
plexapi:
|
||||
inputs:
|
||||
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/plex-api-spec.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
|
||||
targets:
|
||||
plexjava:
|
||||
target: java
|
||||
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
|
||||
labelOverride:
|
||||
fixedValue: PlexJava
|
||||
@@ -1,26 +0,0 @@
|
||||
# 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
Normal file
19
LICENSE
Normal file
@@ -0,0 +1,19 @@
|
||||
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.
|
||||
411
RELEASES.md
411
RELEASES.md
@@ -1,411 +0,0 @@
|
||||
|
||||
|
||||
## 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 - .
|
||||
|
||||
## 2024-09-29 00:28:35
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.404.5 (2.426.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.6.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.6.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.6.1 - .
|
||||
|
||||
## 2024-09-30 00:26:54
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.404.5 (2.426.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.6.2] .
|
||||
### Releases
|
||||
- [Maven Central v0.6.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.6.2 - .
|
||||
|
||||
## 2024-10-01 00:28:45
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.7.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.7.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.7.0 - .
|
||||
|
||||
## 2024-10-03 00:26:50
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.8.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.8.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.8.0 - .
|
||||
|
||||
## 2024-10-04 00:25:27
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.9.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.9.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.9.0 - .
|
||||
|
||||
## 2024-11-12 00:25:12
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.438.1 (2.457.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.10.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.10.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.10.0 - .
|
||||
|
||||
## 2024-11-14 00:25:48
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.439.0 (2.457.9) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.10.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.10.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.10.1 - .
|
||||
|
||||
## 2024-12-21 00:25:42
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.459.2 (2.483.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.11.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.11.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.0 - .
|
||||
|
||||
## 2024-12-22 00:28:49
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.459.2 (2.483.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.11.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.11.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.1 - .
|
||||
|
||||
## 2025-01-24 00:25:37
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.474.0 (2.495.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.11.2] .
|
||||
### Releases
|
||||
- [Maven Central v0.11.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.2 - .
|
||||
|
||||
## 2025-01-27 00:26:34
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.476.1 (2.495.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.11.3] .
|
||||
### Releases
|
||||
- [Maven Central v0.11.3] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.3 - .
|
||||
|
||||
## 2025-02-05 00:25:55
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.11.4] .
|
||||
### Releases
|
||||
- [Maven Central v0.11.4] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.4 - .
|
||||
|
||||
## 2025-02-06 00:26:06
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.11.5] .
|
||||
### Releases
|
||||
- [Maven Central v0.11.5] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.5 - .
|
||||
|
||||
## 2025-02-07 00:26:07
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.487.0 (2.506.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.11.6] .
|
||||
### Releases
|
||||
- [Maven Central v0.11.6] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.6 - .
|
||||
|
||||
## 2025-02-10 00:27:03
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.487.1 (2.506.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.12.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.12.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.12.0 - .
|
||||
|
||||
## 2025-03-07 00:27:17
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.513.2 (2.545.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.13.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.13.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.13.0 - .
|
||||
|
||||
## 2025-03-09 00:24:27
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.513.4 (2.545.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.13.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.13.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.13.1 - .
|
||||
|
||||
## 2025-03-31 17:07:30
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.14.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.14.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.14.0 - .
|
||||
|
||||
## 2025-04-03 00:27:41
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.528.1 (2.565.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.14.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.14.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.14.1 - .
|
||||
|
||||
## 2025-04-06 00:30:19
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.529.1 (2.566.5) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.14.2] .
|
||||
### Releases
|
||||
- [Maven Central v0.14.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.14.2 - .
|
||||
|
||||
## 2025-04-14 00:30:37
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.531.4 (2.570.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.15.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.15.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.15.0 - .
|
||||
|
||||
## 2025-04-19 00:27:27
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.535.1 (2.585.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.16.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.16.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.16.0 - .
|
||||
|
||||
## 2025-05-01 00:32:51
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.541.2 (2.595.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.16.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.16.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.16.1 - .
|
||||
|
||||
## 2025-05-05 00:31:37
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.542.1 (2.597.9) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.16.2] .
|
||||
### Releases
|
||||
- [Maven Central v0.16.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.16.2 - .
|
||||
|
||||
## 2025-06-04 00:30:54
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.555.2 (2.620.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.17.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.17.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.17.0 - .
|
||||
|
||||
## 2025-06-09 00:32:43
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.557.0 (2.623.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.17.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.17.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.17.1 - .
|
||||
|
||||
## 2025-09-16 00:27:57
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.615.2 (2.698.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.18.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.18.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.18.0 - .
|
||||
|
||||
## 2025-10-12 06:49:36
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.615.2 (2.698.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.19.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.19.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.19.1 - .
|
||||
|
||||
## 2025-10-13 00:31:03
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.615.2 (2.698.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.20.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.20.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.20.1 - .
|
||||
|
||||
## 2025-11-13 00:30:34
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.615.2 (2.698.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.21.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.21.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.21.1 - .
|
||||
71
USAGE.md
71
USAGE.md
@@ -1,71 +0,0 @@
|
||||
<!-- Start SDK Example Usage [usage] -->
|
||||
```java
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.sdk.PlexAPI;
|
||||
import dev.plexapi.sdk.models.operations.*;
|
||||
import dev.plexapi.sdk.models.shared.*;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) throws Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accepts(Accepts.APPLICATION_XML)
|
||||
.clientIdentifier("abc123")
|
||||
.product("Plex for Roku")
|
||||
.version("2.4.1")
|
||||
.platform("Roku")
|
||||
.platformVersion("4.3 build 1057")
|
||||
.device("Roku 3")
|
||||
.model("4200X")
|
||||
.deviceVendor("Roku")
|
||||
.deviceName("Living Room TV")
|
||||
.marketplace("googlePlay")
|
||||
.token(System.getenv().getOrDefault("TOKEN", ""))
|
||||
.build();
|
||||
|
||||
StartTranscodeSessionRequest req = StartTranscodeSessionRequest.builder()
|
||||
.transcodeType(TranscodeType.MUSIC)
|
||||
.extension(Extension.MPD)
|
||||
.advancedSubtitles(AdvancedSubtitles.BURN)
|
||||
.audioBoost(50L)
|
||||
.audioChannelCount(5L)
|
||||
.autoAdjustQuality(BoolInt.ONE)
|
||||
.autoAdjustSubtitle(BoolInt.ONE)
|
||||
.directPlay(BoolInt.ONE)
|
||||
.directStream(BoolInt.ONE)
|
||||
.directStreamAudio(BoolInt.ONE)
|
||||
.disableResolutionRotation(BoolInt.ONE)
|
||||
.hasMDE(BoolInt.ONE)
|
||||
.location(StartTranscodeSessionQueryParamLocation.WAN)
|
||||
.mediaBufferSize(102400L)
|
||||
.mediaIndex(0L)
|
||||
.musicBitrate(5000L)
|
||||
.offset(90.5)
|
||||
.partIndex(0L)
|
||||
.path("/library/metadata/151671")
|
||||
.peakBitrate(12000L)
|
||||
.photoResolution("1080x1080")
|
||||
.protocol(StartTranscodeSessionQueryParamProtocol.DASH)
|
||||
.secondsPerSegment(5L)
|
||||
.subtitleSize(50L)
|
||||
.videoBitrate(12000L)
|
||||
.videoQuality(50L)
|
||||
.videoResolution("1080x1080")
|
||||
.xPlexClientProfileExtra("add-limitation(scope=videoCodec&scopeName=*&type=upperBound&name=video.frameRate&value=60&replace=true)+append-transcode-target-codec(type=videoProfile&context=streaming&videoCodec=h264%2Chevc&audioCodec=aac&protocol=dash)")
|
||||
.xPlexClientProfileName("generic")
|
||||
.build();
|
||||
|
||||
StartTranscodeSessionResponse res = sdk.transcoder().startTranscodeSession()
|
||||
.request(req)
|
||||
.call();
|
||||
|
||||
if (res.responseStream().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
<!-- End SDK Example Usage [usage] -->
|
||||
@@ -1,4 +0,0 @@
|
||||
// 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
|
||||
167
build.gradle
167
build.gradle
@@ -1,167 +0,0 @@
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// 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 {
|
||||
withSourcesJar()
|
||||
withJavadocJar()
|
||||
}
|
||||
|
||||
model {
|
||||
tasks.generatePomFileForMavenPublication {
|
||||
destination = file("$buildDir/pom.xml")
|
||||
}
|
||||
}
|
||||
|
||||
version = "${version}"
|
||||
group = "${groupId}"
|
||||
|
||||
jar {
|
||||
dependsOn(":generatePomFileForMavenPublication")
|
||||
archiveBaseName = "${artifactId}"
|
||||
|
||||
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')
|
||||
}
|
||||
|
||||
tasks.withType(JavaCompile).configureEach {
|
||||
options.release = 11
|
||||
}
|
||||
|
||||
sourcesJar {
|
||||
archiveBaseName = "${artifactId}"
|
||||
}
|
||||
|
||||
javadocJar {
|
||||
archiveBaseName = "${artifactId}"
|
||||
}
|
||||
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/${artifactId}-${version}.jar",
|
||||
"$buildDir/libs/${artifactId}-${version}-sources.jar",
|
||||
"$buildDir/libs/${artifactId}-${version}-javadoc.jar"
|
||||
)
|
||||
|
||||
// This is the pom file to upload. This is required by central
|
||||
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) {
|
||||
// note that properties can't yet be used below!
|
||||
// https://github.com/gradle/gradle/issues/18619
|
||||
groupId = "dev.plexapi"
|
||||
artifactId = "plexapi"
|
||||
version = "0.21.1"
|
||||
|
||||
from components.java
|
||||
|
||||
pom {
|
||||
properties = [
|
||||
'maven.compiler.source': '11',
|
||||
'maven.compiler.target': '11',
|
||||
]
|
||||
name = 'plexapi Java SDK'
|
||||
description = 'SDK enabling Java developers to easily integrate with the plexapi API.'
|
||||
url = 'https://github.com/LukeHagar/plexjava'
|
||||
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 {
|
||||
api 'com.fasterxml.jackson.core:jackson-annotations:2.18.2'
|
||||
implementation 'com.fasterxml.jackson.core:jackson-databind:2.18.2'
|
||||
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.18.2'
|
||||
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.18.2'
|
||||
api('org.openapitools:jackson-databind-nullable:0.2.6') {exclude group: 'com.fasterxml.jackson.core', module: 'jackson-databind'}
|
||||
implementation 'commons-io:commons-io:2.18.0'
|
||||
api 'org.reactivestreams:reactive-streams:1.0.4'
|
||||
}
|
||||
|
||||
apply from: 'build-extras.gradle'
|
||||
10687
codeSamples.yaml
10687
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
@@ -1,9 +0,0 @@
|
||||
# Account
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `globalViewCount` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
| `id` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
@@ -1,12 +0,0 @@
|
||||
# Action
|
||||
|
||||
The action to perform for this item on this optimizer queue
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| `REPROCESS` | reprocess |
|
||||
| `DISABLE` | disable |
|
||||
| `ENABLE` | enable |
|
||||
@@ -1,16 +0,0 @@
|
||||
# Activity
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `cancellable` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether this activity can be cancelled |
|
||||
| `context` | Map\<String, *Object*> | :heavy_minus_sign: | An object with additional values |
|
||||
| `progress` | *Optional\<Double>* | :heavy_minus_sign: | A progress percentage. A value of -1 means the progress is indeterminate |
|
||||
| `response` | Map\<String, *Object*> | :heavy_minus_sign: | An object with the response to the async opperation |
|
||||
| `subtitle` | *Optional\<String>* | :heavy_minus_sign: | A user-friendly sub-title for this activity |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | A user-friendly title for this activity |
|
||||
| `type` | *Optional\<String>* | :heavy_minus_sign: | The type of activity |
|
||||
| `userID` | *Optional\<Long>* | :heavy_minus_sign: | The user this activity belongs to |
|
||||
| `uuid` | *Optional\<String>* | :heavy_minus_sign: | The ID of the activity |
|
||||
@@ -1,20 +0,0 @@
|
||||
# AddCollectionItemsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `collectionId` | *long* | :heavy_check_mark: | The collection id | |
|
||||
| `uri` | *String* | :heavy_check_mark: | The URI describing the items to add to this collection | |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AddCollectionItemsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `mediaContainerWithMetadata` | [Optional\<MediaContainerWithMetadata>](../../models/shared/MediaContainerWithMetadata.md) | :heavy_minus_sign: | OK |
|
||||
@@ -1,19 +0,0 @@
|
||||
# AddDeviceRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `uri` | *Optional\<String>* | :heavy_minus_sign: | The URI of the device. | http://10.0.0.5 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AddDeviceResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `mediaContainerWithDevice` | [Optional\<MediaContainerWithDevice>](../../models/shared/MediaContainerWithDevice.md) | :heavy_minus_sign: | OK |
|
||||
@@ -1,12 +0,0 @@
|
||||
# AddDeviceToDVRDVR
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| `device` | List\<[Device](../../models/shared/Device.md)> | :heavy_minus_sign: | N/A |
|
||||
| `key` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `language` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `lineup` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `uuid` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
@@ -1,17 +0,0 @@
|
||||
# AddDeviceToDVRDVRsMediaContainer
|
||||
|
||||
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
|
||||
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
|
||||
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
|
||||
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `identifier` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `offset` | *Optional\<Long>* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
|
||||
| `size` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
| `totalSize` | *Optional\<Long>* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
|
||||
| `status` | *Optional\<Long>* | :heavy_minus_sign: | A status indicator. If present and non-zero, indicates an error |
|
||||
@@ -1,9 +0,0 @@
|
||||
# AddDeviceToDVRMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [Optional\<AddDeviceToDVRDVRsMediaContainer>](../../models/operations/AddDeviceToDVRDVRsMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
| `dvr` | List\<[AddDeviceToDVRDVR](../../models/operations/AddDeviceToDVRDVR.md)> | :heavy_minus_sign: | N/A |
|
||||
@@ -1,20 +0,0 @@
|
||||
# AddDeviceToDVRRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `dvrId` | *long* | :heavy_check_mark: | The ID of the DVR. | |
|
||||
| `deviceId` | *long* | :heavy_check_mark: | The ID of the device to add. | |
|
||||
@@ -1,12 +0,0 @@
|
||||
# AddDeviceToDVRResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [Optional\<AddDeviceToDVRResponseBody>](../../models/operations/AddDeviceToDVRResponseBody.md) | :heavy_minus_sign: | OK |
|
||||
| `headers` | Map\<String, List\\<*String*>> | :heavy_check_mark: | N/A |
|
||||
@@ -1,10 +0,0 @@
|
||||
# AddDeviceToDVRResponseBody
|
||||
|
||||
OK
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [Optional\<AddDeviceToDVRMediaContainer>](../../models/operations/AddDeviceToDVRMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,17 +0,0 @@
|
||||
# AddDownloadQueueItemsMediaContainer
|
||||
|
||||
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
|
||||
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
|
||||
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
|
||||
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `identifier` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `offset` | *Optional\<Long>* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
|
||||
| `size` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
| `totalSize` | *Optional\<Long>* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
|
||||
| `addedQueueItems` | List\<[AddedQueueItems](../../models/operations/AddedQueueItems.md)> | :heavy_minus_sign: | N/A |
|
||||
@@ -1,46 +0,0 @@
|
||||
# AddDownloadQueueItemsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `queueId` | *long* | :heavy_check_mark: | The queue id | |
|
||||
| `keys` | List\<*String*> | :heavy_check_mark: | Keys to add | [<br/>"/library/metadata/3",<br/>"/library/metadata/6"<br/>] |
|
||||
| `advancedSubtitles` | [Optional\<AdvancedSubtitles>](../../models/shared/AdvancedSubtitles.md) | :heavy_minus_sign: | Indicates how incompatible advanced subtitles (such as ass/ssa) should be included: * 'burn' - Burn incompatible advanced text subtitles into the video stream * 'text' - Transcode incompatible advanced text subtitles to a compatible text format, even if some markup is lost<br/> | burn |
|
||||
| `audioBoost` | *Optional\<Long>* | :heavy_minus_sign: | Percentage of original audio loudness to use when transcoding (100 is equivalent to original volume, 50 is half, 200 is double, etc) | 50 |
|
||||
| `audioChannelCount` | *Optional\<Long>* | :heavy_minus_sign: | Target video number of audio channels. | 5 |
|
||||
| `autoAdjustQuality` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Indicates the client supports ABR. | 1 |
|
||||
| `autoAdjustSubtitle` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Indicates if the server should adjust subtitles based on Voice Activity Data. | 1 |
|
||||
| `directPlay` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Indicates the client supports direct playing the indicated content. | 1 |
|
||||
| `directStream` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Indicates the client supports direct streaming the video of the indicated content. | 1 |
|
||||
| `directStreamAudio` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Indicates the client supports direct streaming the audio of the indicated content. | 1 |
|
||||
| `disableResolutionRotation` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Indicates if resolution should be adjusted for orientation. | 1 |
|
||||
| `hasMDE` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Ignore client profiles when determining if direct play is possible. Only has an effect when directPlay=1 and both mediaIndex and partIndex are specified and neither are -1 | 1 |
|
||||
| `location` | [Optional\<Location>](../../models/shared/Location.md) | :heavy_minus_sign: | Network type of the client, can be used to help determine target bitrate. | wan |
|
||||
| `mediaBufferSize` | *Optional\<Long>* | :heavy_minus_sign: | Buffer size used in playback (in KB). Clients should specify a lower bound if not known exactly. This value could make the difference between transcoding and direct play on bandwidth constrained networks. | 102400 |
|
||||
| `mediaIndex` | *Optional\<Long>* | :heavy_minus_sign: | Index of the media to transcode. -1 or not specified indicates let the server choose. | 0 |
|
||||
| `musicBitrate` | *Optional\<Long>* | :heavy_minus_sign: | Target bitrate for audio only files (in kbps, used to transcode). | 5000 |
|
||||
| `offset` | *Optional\<Double>* | :heavy_minus_sign: | Offset from the start of the media (in seconds). | 90.5 |
|
||||
| `partIndex` | *Optional\<Long>* | :heavy_minus_sign: | Index of the part to transcode. -1 or not specified indicates the server should join parts together in a transcode | 0 |
|
||||
| `path` | *Optional\<String>* | :heavy_minus_sign: | Internal PMS path of the media to transcode. | /library/metadata/151671 |
|
||||
| `peakBitrate` | *Optional\<Long>* | :heavy_minus_sign: | Maximum bitrate (in kbps) to use in ABR. | 12000 |
|
||||
| `photoResolution` | *Optional\<String>* | :heavy_minus_sign: | Target photo resolution. | 1080x1080 |
|
||||
| `protocol` | [Optional\<Protocol>](../../models/shared/Protocol.md) | :heavy_minus_sign: | Indicates the network streaming protocol to be used for the transcode session: * 'http' - include the file in the http response such as MKV streaming * 'hls' - hls stream (RFC 8216) * 'dash' - dash stream (ISO/IEC 23009-1:2022)<br/> | dash |
|
||||
| `secondsPerSegment` | *Optional\<Long>* | :heavy_minus_sign: | Number of seconds to include in each transcoded segment | 5 |
|
||||
| `subtitleSize` | *Optional\<Long>* | :heavy_minus_sign: | Percentage of original subtitle size to use when burning subtitles (100 is equivalent to original size, 50 is half, ect) | 50 |
|
||||
| `subtitles` | [Optional\<Subtitles>](../../models/shared/Subtitles.md) | :heavy_minus_sign: | Indicates how subtitles should be included: * 'auto' - Compute the appropriate subtitle setting automatically * 'burn' - Burn the selected subtitle; auto if no selected subtitle * 'none' - Ignore all subtitle streams * 'sidecar' - The selected subtitle should be provided as a sidecar * 'embedded' - The selected subtitle should be provided as an embedded stream * 'segmented' - The selected subtitle should be provided as a segmented stream<br/> | Burn |
|
||||
| `videoBitrate` | *Optional\<Long>* | :heavy_minus_sign: | Target video bitrate (in kbps). | 12000 |
|
||||
| `videoQuality` | *Optional\<Long>* | :heavy_minus_sign: | Target photo quality. | 50 |
|
||||
| `videoResolution` | *Optional\<String>* | :heavy_minus_sign: | Target maximum video resolution. | 1080x1080 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AddDownloadQueueItemsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [Optional\<AddDownloadQueueItemsResponseBody>](../../models/operations/AddDownloadQueueItemsResponseBody.md) | :heavy_minus_sign: | OK |
|
||||
@@ -1,10 +0,0 @@
|
||||
# AddDownloadQueueItemsResponseBody
|
||||
|
||||
OK
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [Optional\<AddDownloadQueueItemsMediaContainer>](../../models/operations/AddDownloadQueueItemsMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,22 +0,0 @@
|
||||
# AddExtrasRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `ids` | *String* | :heavy_check_mark: | N/A | |
|
||||
| `extraType` | *Optional\<Long>* | :heavy_minus_sign: | The metadata type of the extra | |
|
||||
| `url` | *String* | :heavy_check_mark: | The URL of the extra | |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | The title to filter by or assign | |
|
||||
@@ -1,10 +0,0 @@
|
||||
# AddExtrasResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,12 +0,0 @@
|
||||
# AddLineupDVR
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| `device` | List\<[Device](../../models/shared/Device.md)> | :heavy_minus_sign: | N/A |
|
||||
| `key` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `language` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `lineup` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `uuid` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
@@ -1,17 +0,0 @@
|
||||
# AddLineupDVRsMediaContainer
|
||||
|
||||
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
|
||||
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
|
||||
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
|
||||
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `identifier` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `offset` | *Optional\<Long>* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
|
||||
| `size` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
| `totalSize` | *Optional\<Long>* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
|
||||
| `status` | *Optional\<Long>* | :heavy_minus_sign: | A status indicator. If present and non-zero, indicates an error |
|
||||
@@ -1,9 +0,0 @@
|
||||
# AddLineupMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `mediaContainer` | [Optional\<AddLineupDVRsMediaContainer>](../../models/operations/AddLineupDVRsMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
| `dvr` | List\<[AddLineupDVR](../../models/operations/AddLineupDVR.md)> | :heavy_minus_sign: | N/A |
|
||||
@@ -1,20 +0,0 @@
|
||||
# AddLineupRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `dvrId` | *long* | :heavy_check_mark: | The ID of the DVR. | |
|
||||
| `lineup` | *String* | :heavy_check_mark: | The lineup to delete | |
|
||||
@@ -1,12 +0,0 @@
|
||||
# AddLineupResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [Optional\<AddLineupResponseBody>](../../models/operations/AddLineupResponseBody.md) | :heavy_minus_sign: | OK |
|
||||
| `headers` | Map\<String, List\\<*String*>> | :heavy_check_mark: | N/A |
|
||||
@@ -1,10 +0,0 @@
|
||||
# AddLineupResponseBody
|
||||
|
||||
OK
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [Optional\<AddLineupMediaContainer>](../../models/operations/AddLineupMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,21 +0,0 @@
|
||||
# AddPlaylistItemsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `playlistId` | *long* | :heavy_check_mark: | The ID of the playlist | |
|
||||
| `uri` | *Optional\<String>* | :heavy_minus_sign: | The content URI for the playlist. | |
|
||||
| `playQueueID` | *Optional\<Long>* | :heavy_minus_sign: | The play queue to add to a playlist. | |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AddPlaylistItemsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `mediaContainerWithPlaylistMetadata` | [Optional\<MediaContainerWithPlaylistMetadata>](../../models/shared/MediaContainerWithPlaylistMetadata.md) | :heavy_minus_sign: | OK |
|
||||
@@ -1,19 +0,0 @@
|
||||
# AddProviderRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `url` | *String* | :heavy_check_mark: | The URL of the media provider to add. | |
|
||||
@@ -1,10 +0,0 @@
|
||||
# AddProviderResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,28 +0,0 @@
|
||||
# AddSectionRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `name` | *String* | :heavy_check_mark: | The name of the new section | |
|
||||
| `type` | *long* | :heavy_check_mark: | The type of library section | |
|
||||
| `scanner` | *Optional\<String>* | :heavy_minus_sign: | The scanner this section should use | |
|
||||
| `agent` | *String* | :heavy_check_mark: | The agent this section should use for metadata | |
|
||||
| `metadataAgentProviderGroupId` | *Optional\<String>* | :heavy_minus_sign: | The agent group id for this section | |
|
||||
| `language` | *String* | :heavy_check_mark: | The language of this section | |
|
||||
| `locations` | List\<*String*> | :heavy_minus_sign: | The locations on disk to add to this section | [<br/>"O:\\fatboy\\Media\\Ripped\\Music",<br/>"O:\\fatboy\\Media\\My Music"<br/>] |
|
||||
| `prefs` | [Optional\<QueryParamPrefs>](../../models/operations/QueryParamPrefs.md) | :heavy_minus_sign: | The preferences for this section | {<br/>"collectionMode": 2,<br/>"hidden": 0<br/>} |
|
||||
| `relative` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | If set, paths are relative to `Media Upload` path | 1 |
|
||||
| `importFromiTunes` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | If set, import media from iTunes. | 1 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AddSectionResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `slashGetResponses200` | [Optional\<SlashGetResponses200>](../../models/shared/SlashGetResponses200.md) | :heavy_minus_sign: | OK |
|
||||
@@ -1,26 +0,0 @@
|
||||
# AddSubtitlesRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `ids` | *String* | :heavy_check_mark: | N/A | |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
|
||||
| `language` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
|
||||
| `mediaItemID` | *Optional\<Long>* | :heavy_minus_sign: | N/A | |
|
||||
| `url` | *Optional\<String>* | :heavy_minus_sign: | The URL of the subtitle. If not provided, the contents of the subtitle must be in the post body | |
|
||||
| `format` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
|
||||
| `forced` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `hearingImpaired` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# AddSubtitlesResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,22 +0,0 @@
|
||||
# AddToPlayQueueRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `playQueueId` | *long* | :heavy_check_mark: | The ID of the play queue. | |
|
||||
| `uri` | *Optional\<String>* | :heavy_minus_sign: | The content URI for what we're adding to the queue. | |
|
||||
| `playlistID` | *Optional\<String>* | :heavy_minus_sign: | The ID of the playlist to add to the playQueue. | |
|
||||
| `next` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Play this item next (defaults to 0 - queueing at the end of manually queued items). | 1 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AddToPlayQueueResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `mediaContainerWithPlaylistMetadata` | [Optional\<MediaContainerWithPlaylistMetadata>](../../models/shared/MediaContainerWithPlaylistMetadata.md) | :heavy_minus_sign: | OK |
|
||||
@@ -1,9 +0,0 @@
|
||||
# AddedQueueItems
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *Optional\<Long>* | :heavy_minus_sign: | The queue item id that was added or the existing one if an item already exists in this queue with the same parameters |
|
||||
| `key` | *Optional\<String>* | :heavy_minus_sign: | The key added to the queue |
|
||||
@@ -1,13 +0,0 @@
|
||||
# AdvancedSubtitles
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| `AUTO` | auto |
|
||||
| `BURN` | burn |
|
||||
| `NONE` | none |
|
||||
| `SIDECAR` | sidecar |
|
||||
| `EMBEDDED` | embedded |
|
||||
| `SEGMENTED` | segmented |
|
||||
@@ -1,21 +0,0 @@
|
||||
# AnalyzeMetadataRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `ids` | *String* | :heavy_check_mark: | N/A | |
|
||||
| `thumbOffset` | *Optional\<Double>* | :heavy_minus_sign: | Set the offset to be used for thumbnails | |
|
||||
| `artOffset` | *Optional\<Double>* | :heavy_minus_sign: | Set the offset to be used for artwork | |
|
||||
@@ -1,10 +0,0 @@
|
||||
# AnalyzeMetadataResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,20 +0,0 @@
|
||||
# ApplyUpdatesRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `tonight` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install immediately. | 1 |
|
||||
| `skip` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The <Release> entry for this version will have the `state` set to `skipped`. | 1 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# ApplyUpdatesResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,9 +0,0 @@
|
||||
# Args
|
||||
|
||||
The new values for the metadata item
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
@@ -1,9 +0,0 @@
|
||||
# Attributes
|
||||
|
||||
The attributes to assign to this marker
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
@@ -1,22 +0,0 @@
|
||||
# AutocompleteRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `sectionId` | *long* | :heavy_check_mark: | Section identifier | |
|
||||
| `type` | *Optional\<Long>* | :heavy_minus_sign: | Item type | |
|
||||
| `fieldQuery` | *Optional\<String>* | :heavy_minus_sign: | The "field" stands in for any field, the value is a partial string for matching | |
|
||||
| `mediaQuery` | [Optional\<MediaQuery>](../../models/shared/MediaQuery.md) | :heavy_minus_sign: | This is a complex query built of several parameters. See [API Info section](#section/API-Info/Media-Queries) for information on building media queries | |
|
||||
@@ -1,12 +0,0 @@
|
||||
# AutocompleteResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `mediaContainerWithMetadata` | [Optional\<MediaContainerWithMetadata>](../../models/shared/MediaContainerWithMetadata.md) | :heavy_minus_sign: | OK |
|
||||
| `headers` | Map\<String, List\\<*String*>> | :heavy_check_mark: | N/A |
|
||||
@@ -1,10 +0,0 @@
|
||||
# Bandwidth
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
|
||||
| `bandwidth` | *Optional\<Long>* | :heavy_minus_sign: | The bandwidth at this time in kbps |
|
||||
| `resolution` | *Optional\<String>* | :heavy_minus_sign: | The user-friendly resolution at this time |
|
||||
| `time` | *Optional\<Long>* | :heavy_minus_sign: | Media playback time where this bandwidth started |
|
||||
@@ -1,10 +0,0 @@
|
||||
# Bandwidths
|
||||
|
||||
A list of media times and bandwidths when trascoding is using with auto adjustment of bandwidth
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `bandwidth` | List\<[Bandwidth](../../models/operations/Bandwidth.md)> | :heavy_minus_sign: | N/A |
|
||||
@@ -1,13 +0,0 @@
|
||||
# ButlerTask
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `description` | *Optional\<String>* | :heavy_minus_sign: | A user-friendly description of the task |
|
||||
| `enabled` | *Optional\<Boolean>* | :heavy_minus_sign: | Whether this task is enabled or not |
|
||||
| `interval` | *Optional\<Long>* | :heavy_minus_sign: | The interval (in days) of when this task is run. A value of 1 is run every day, 7 is every week, etc. |
|
||||
| `name` | *Optional\<String>* | :heavy_minus_sign: | The name of the task |
|
||||
| `scheduleRandomized` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether the timing of the task is randomized within the butler interval |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | A user-friendly title of the task |
|
||||
@@ -1,8 +0,0 @@
|
||||
# ButlerTasks
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| `butlerTask` | List\<[ButlerTask](../../models/operations/ButlerTask.md)> | :heavy_minus_sign: | N/A |
|
||||
@@ -1,19 +0,0 @@
|
||||
# CancelActivityRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `activityId` | *String* | :heavy_check_mark: | The UUID of the activity to cancel. | d6199ba1-fb5e-4cae-bf17-1a5369c1cf1e |
|
||||
@@ -1,10 +0,0 @@
|
||||
# CancelActivityResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,19 +0,0 @@
|
||||
# CancelGrabRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `operationId` | *String* | :heavy_check_mark: | The ID of the operation. | |
|
||||
@@ -1,10 +0,0 @@
|
||||
# CancelGrabResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,19 +0,0 @@
|
||||
# CancelRefreshRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `sectionId` | *long* | :heavy_check_mark: | Section identifier | |
|
||||
@@ -1,10 +0,0 @@
|
||||
# CancelRefreshResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,9 +0,0 @@
|
||||
# ChannelMapping
|
||||
|
||||
The mapping of changes, passed as a map of device channel to lineup VCN.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
@@ -1,9 +0,0 @@
|
||||
# ChannelMappingByKey
|
||||
|
||||
The mapping of changes, passed as a map of device channel to lineup key.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
@@ -1,19 +0,0 @@
|
||||
# CheckUpdatesRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `download` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# CheckUpdatesResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,18 +0,0 @@
|
||||
# ChromaSubsampling
|
||||
|
||||
Use the specified chroma subsambling.
|
||||
- 0: 411
|
||||
- 1: 420
|
||||
- 2: 422
|
||||
- 3: 444
|
||||
Defaults to 3 (444)
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `ZERO` | 0 |
|
||||
| `ONE` | 1 |
|
||||
| `TWO` | 2 |
|
||||
| `THREE` | 3 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# CleanBundlesResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,19 +0,0 @@
|
||||
# ClearPlayQueueRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `playQueueId` | *long* | :heavy_check_mark: | The ID of the play queue. | |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ClearPlayQueueResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `mediaContainerWithPlaylistMetadata` | [Optional\<MediaContainerWithPlaylistMetadata>](../../models/shared/MediaContainerWithPlaylistMetadata.md) | :heavy_minus_sign: | OK |
|
||||
@@ -1,19 +0,0 @@
|
||||
# ClearPlaylistItemsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `playlistId` | *long* | :heavy_check_mark: | The ID of the playlist | |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ClearPlaylistItemsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `mediaContainerWithPlaylistMetadata` | [Optional\<MediaContainerWithPlaylistMetadata>](../../models/shared/MediaContainerWithPlaylistMetadata.md) | :heavy_minus_sign: | OK |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ComputeChannelMapChannelMapping
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
|
||||
| `channelKey` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `deviceIdentifier` | *Optional\<String>* | :heavy_minus_sign: | The channel description on the device |
|
||||
| `favorite` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A |
|
||||
| `lineupIdentifier` | *Optional\<String>* | :heavy_minus_sign: | The channel identifier in the lineup |
|
||||
@@ -1,17 +0,0 @@
|
||||
# ComputeChannelMapMediaContainer
|
||||
|
||||
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
|
||||
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
|
||||
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
|
||||
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `identifier` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `offset` | *Optional\<Long>* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
|
||||
| `size` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
| `totalSize` | *Optional\<Long>* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
|
||||
| `channelMapping` | List\<[ComputeChannelMapChannelMapping](../../models/operations/ComputeChannelMapChannelMapping.md)> | :heavy_minus_sign: | N/A |
|
||||
@@ -1,20 +0,0 @@
|
||||
# ComputeChannelMapRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `deviceQueryParameter` | *String* | :heavy_check_mark: | The URI describing the device | |
|
||||
| `lineup` | *String* | :heavy_check_mark: | The URI describing the lineup | |
|
||||
@@ -1,12 +0,0 @@
|
||||
# ComputeChannelMapResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [Optional\<ComputeChannelMapResponseBody>](../../models/operations/ComputeChannelMapResponseBody.md) | :heavy_minus_sign: | OK |
|
||||
| `headers` | Map\<String, List\\<*String*>> | :heavy_check_mark: | N/A |
|
||||
@@ -1,10 +0,0 @@
|
||||
# ComputeChannelMapResponseBody
|
||||
|
||||
OK
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [Optional\<ComputeChannelMapMediaContainer>](../../models/operations/ComputeChannelMapMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,19 +0,0 @@
|
||||
# ConnectWebSocketRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `filter` | List\<*String*> | :heavy_minus_sign: | By default, all events except logs are sent. A rich filtering mechanism is provided to allow clients to opt into or out of each event type using the `filters` parameter. For example:<br/><br/>- `filters=-log`: All event types except logs (the default).<br/>- `filters=foo,bar`: Only the foo and bar event types.<br/>- `filters=`: All events types.<br/>- `filters=-foo,bar`: All event types except foo and bar.<br/> | |
|
||||
@@ -1,11 +0,0 @@
|
||||
# ConnectWebSocketResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `responseStream` | *Optional\<InputStream>* | :heavy_minus_sign: | OK |
|
||||
@@ -1,13 +0,0 @@
|
||||
# Connection
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `address` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `local` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the connection is the server's LAN address |
|
||||
| `port` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
| `protocol` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `relay` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates the connection is over a relayed connection |
|
||||
| `uri` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
@@ -1,15 +0,0 @@
|
||||
# Country
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `code` | *Optional\<String>* | :heavy_minus_sign: | Three letter code |
|
||||
| `example` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `flavor` | [Optional\<Flavor>](../../models/operations/Flavor.md) | :heavy_minus_sign: | - `0`: The country is divided into regions, and following the key will lead to a list of regions.<br/>- `1`: The county is divided by postal codes, and an example code is returned in `example`.<br/>- `2`: The country has a single postal code, returned in `example`.<br/> |
|
||||
| `key` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `language` | *Optional\<String>* | :heavy_minus_sign: | Three letter language code |
|
||||
| `languageTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the language |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `type` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
@@ -1,23 +0,0 @@
|
||||
# CreateCollectionRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `sectionId` | *String* | :heavy_check_mark: | The section where this collection will be created | |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | The title to filter by or assign | |
|
||||
| `smart` | *Optional\<Boolean>* | :heavy_minus_sign: | Whether this is a smart collection/playlist | |
|
||||
| `uri` | *Optional\<String>* | :heavy_minus_sign: | The URI for processing the smart collection. Required for a smart collection | |
|
||||
| `type` | *Optional\<Long>* | :heavy_minus_sign: | The metadata type to filter by | |
|
||||
@@ -1,11 +0,0 @@
|
||||
# CreateCollectionResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `mediaContainerWithMetadata` | [Optional\<MediaContainerWithMetadata>](../../models/shared/MediaContainerWithMetadata.md) | :heavy_minus_sign: | OK |
|
||||
@@ -1,23 +0,0 @@
|
||||
# CreateCustomHubRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `sectionId` | *long* | :heavy_check_mark: | The section ID for the hubs to reorder | |
|
||||
| `metadataItemId` | *long* | :heavy_check_mark: | The metadata item on which to base this hub. This must currently be a collection | |
|
||||
| `promotedToRecommended` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Whether this hub should be displayed in recommended | 1 |
|
||||
| `promotedToOwnHome` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Whether this hub should be displayed in admin's home | 1 |
|
||||
| `promotedToSharedHome` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Whether this hub should be displayed in shared user's home | 1 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# CreateCustomHubResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,21 +0,0 @@
|
||||
# CreateDVRRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
||||
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
||||
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
||||
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
||||
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
|
||||
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
||||
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
||||
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
|
||||
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
||||
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
||||
| `lineup` | *Optional\<String>* | :heavy_minus_sign: | The EPG lineup. | lineup://tv.plex.providers.epg.onconnect/USA-HI51418-DEFAULT |
|
||||
| `deviceQueryParameter` | List\<*String*> | :heavy_minus_sign: | The device. | device[]=device://tv.plex.grabbers.hdhomerun/1053C0CA |
|
||||
| `language` | *Optional\<String>* | :heavy_minus_sign: | The language. | eng |
|
||||
@@ -1,12 +0,0 @@
|
||||
# CreateDVRResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `dvrRequestHandlerSlashGetResponses200` | [Optional\<DvrRequestHandlerSlashGetResponses200>](../../models/shared/DvrRequestHandlerSlashGetResponses200.md) | :heavy_minus_sign: | OK |
|
||||
| `headers` | Map\<String, List\\<*String*>> | :heavy_check_mark: | N/A |
|
||||
@@ -1,17 +0,0 @@
|
||||
# CreateDownloadQueueMediaContainer
|
||||
|
||||
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
|
||||
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
|
||||
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
|
||||
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `identifier` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `offset` | *Optional\<Long>* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
|
||||
| `size` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
| `totalSize` | *Optional\<Long>* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
|
||||
| `downloadQueue` | List\<[DownloadQueue](../../models/operations/DownloadQueue.md)> | :heavy_minus_sign: | N/A |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user