mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 20:47:45 +00:00
Compare commits
20 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
84fb18428a | ||
|
|
37569715a6 | ||
|
|
c0e915da8b | ||
|
|
0077561a6a | ||
|
|
4b28ca3416 | ||
|
|
dd781d1e27 | ||
|
|
dcdcafc044 | ||
|
|
04db2979db | ||
|
|
c2eeb488c4 | ||
|
|
8194abfa99 | ||
|
|
26e1ac258e | ||
|
|
bf77d1e2b9 | ||
|
|
3523b6a0c8 | ||
|
|
a4a2130978 | ||
|
|
f33408b177 | ||
|
|
22654201f5 | ||
|
|
9dc8821b31 | ||
|
|
412b27f162 | ||
|
|
9c8fe4c95e | ||
|
|
a60df4029d |
1
.gitattributes
vendored
1
.gitattributes
vendored
@@ -9,4 +9,3 @@
|
|||||||
|
|
||||||
# This allows generated code to be indexed correctly
|
# This allows generated code to be indexed correctly
|
||||||
*.java linguist-generated=false
|
*.java linguist-generated=false
|
||||||
|
|
||||||
|
|||||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -1,3 +1,6 @@
|
|||||||
|
**/.speakeasy/temp/
|
||||||
|
**/.speakeasy/logs/
|
||||||
|
.speakeasy/reports
|
||||||
# Ignore Gradle project-specific cache directory
|
# Ignore Gradle project-specific cache directory
|
||||||
.gradle
|
.gradle
|
||||||
# Ignore Gradle build output directory
|
# Ignore Gradle build output directory
|
||||||
|
|||||||
2023
.speakeasy/gen.lock
2023
.speakeasy/gen.lock
File diff suppressed because one or more lines are too long
@@ -4,16 +4,20 @@ generation:
|
|||||||
maintainOpenAPIOrder: true
|
maintainOpenAPIOrder: true
|
||||||
usageSnippets:
|
usageSnippets:
|
||||||
optionalPropertyRendering: withExample
|
optionalPropertyRendering: withExample
|
||||||
|
sdkInitStyle: constructor
|
||||||
useClassNamesForArrayFields: true
|
useClassNamesForArrayFields: true
|
||||||
fixes:
|
fixes:
|
||||||
nameResolutionDec2023: true
|
nameResolutionDec2023: true
|
||||||
|
nameResolutionFeb2025: false
|
||||||
parameterOrderingFeb2024: true
|
parameterOrderingFeb2024: true
|
||||||
requestResponseComponentNamesFeb2024: true
|
requestResponseComponentNamesFeb2024: true
|
||||||
|
securityFeb2025: false
|
||||||
|
sharedErrorComponentsApr2025: false
|
||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
oAuth2PasswordEnabled: false
|
oAuth2PasswordEnabled: false
|
||||||
java:
|
java:
|
||||||
version: 0.10.0
|
version: 0.17.0
|
||||||
additionalDependencies: []
|
additionalDependencies: []
|
||||||
additionalPlugins: []
|
additionalPlugins: []
|
||||||
artifactID: plexapi
|
artifactID: plexapi
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
speakeasyVersion: 1.438.1
|
speakeasyVersion: 1.555.2
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
@@ -8,19 +8,19 @@ sources:
|
|||||||
- latest
|
- latest
|
||||||
plexapi:
|
plexapi:
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:15e040d800921ded49cf84650ef2bc8fb1acf32c885ee193c42e838d754bf345
|
sourceRevisionDigest: sha256:78d07ad78ff60d0e9918696208d8c68a562e170d4e9c431797c02995fb8816d0
|
||||||
sourceBlobDigest: sha256:c178be2b4bfefb37d76c0fdaef37c51f9b6ab1410422d3698a41bb6a8d79a79f
|
sourceBlobDigest: sha256:d38dd2a36c1b2fd73409267f7b30c2d5d45d709616141803ea01db424ec68ae4
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- main
|
- speakeasy-sdk-regen-1748997072
|
||||||
targets:
|
targets:
|
||||||
plexjava:
|
plexjava:
|
||||||
source: plexapi
|
source: plexapi
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:15e040d800921ded49cf84650ef2bc8fb1acf32c885ee193c42e838d754bf345
|
sourceRevisionDigest: sha256:78d07ad78ff60d0e9918696208d8c68a562e170d4e9c431797c02995fb8816d0
|
||||||
sourceBlobDigest: sha256:c178be2b4bfefb37d76c0fdaef37c51f9b6ab1410422d3698a41bb6a8d79a79f
|
sourceBlobDigest: sha256:d38dd2a36c1b2fd73409267f7b30c2d5d45d709616141803ea01db424ec68ae4
|
||||||
codeSamplesNamespace: code-samples-java-plexjava
|
codeSamplesNamespace: code-samples-java-plexjava
|
||||||
codeSamplesRevisionDigest: sha256:59231703e7c16d75675e4ee5c84e901b3033cfa89204ba9a3326ff1dcb0d5183
|
codeSamplesRevisionDigest: sha256:2028a8fe95bd6176b8c2ff3a498715a0be7cb00919f7a1e7975778292621dce5
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
@@ -42,3 +42,5 @@ workflow:
|
|||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
|
||||||
|
labelOverride:
|
||||||
|
fixedValue: PlexJava
|
||||||
|
|||||||
@@ -18,3 +18,5 @@ targets:
|
|||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
|
||||||
|
labelOverride:
|
||||||
|
fixedValue: PlexJava
|
||||||
|
|||||||
121
README.md
121
README.md
@@ -41,13 +41,21 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
|
|||||||
|
|
||||||
<!-- Start Table of Contents [toc] -->
|
<!-- Start Table of Contents [toc] -->
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
<!-- $toc-max-depth=2 -->
|
||||||
|
* [plexapi](#plexapi)
|
||||||
|
* [Plex Media Server OpenAPI Specification](#plex-media-server-openapi-specification)
|
||||||
|
* [Documentation](#documentation)
|
||||||
|
* [SDKs](#sdks)
|
||||||
* [SDK Installation](#sdk-installation)
|
* [SDK Installation](#sdk-installation)
|
||||||
* [SDK Example Usage](#sdk-example-usage)
|
* [SDK Example Usage](#sdk-example-usage)
|
||||||
* [Available Resources and Operations](#available-resources-and-operations)
|
* [Available Resources and Operations](#available-resources-and-operations)
|
||||||
* [Error Handling](#error-handling)
|
* [Error Handling](#error-handling)
|
||||||
* [Server Selection](#server-selection)
|
* [Server Selection](#server-selection)
|
||||||
* [Authentication](#authentication)
|
* [Authentication](#authentication)
|
||||||
|
* [Development](#development)
|
||||||
|
* [Maturity](#maturity)
|
||||||
|
* [Contributions](#contributions)
|
||||||
|
|
||||||
<!-- End Table of Contents [toc] -->
|
<!-- End Table of Contents [toc] -->
|
||||||
|
|
||||||
<!-- Start SDK Installation [installation] -->
|
<!-- Start SDK Installation [installation] -->
|
||||||
@@ -61,7 +69,7 @@ The samples below show how a published SDK artifact is used:
|
|||||||
|
|
||||||
Gradle:
|
Gradle:
|
||||||
```groovy
|
```groovy
|
||||||
implementation 'dev.plexapi:plexapi:0.10.0'
|
implementation 'dev.plexapi:plexapi:0.17.0'
|
||||||
```
|
```
|
||||||
|
|
||||||
Maven:
|
Maven:
|
||||||
@@ -69,7 +77,7 @@ Maven:
|
|||||||
<dependency>
|
<dependency>
|
||||||
<groupId>dev.plexapi</groupId>
|
<groupId>dev.plexapi</groupId>
|
||||||
<artifactId>plexapi</artifactId>
|
<artifactId>plexapi</artifactId>
|
||||||
<version>0.10.0</version>
|
<version>0.17.0</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -86,6 +94,29 @@ On Windows:
|
|||||||
```bash
|
```bash
|
||||||
gradlew.bat publishToMavenLocal -Pskip.signing
|
gradlew.bat publishToMavenLocal -Pskip.signing
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Logging
|
||||||
|
A logging framework/facade has not yet been adopted but is under consideration.
|
||||||
|
|
||||||
|
For request and response logging (especially json bodies) use:
|
||||||
|
```java
|
||||||
|
SpeakeasyHTTPClient.setDebugLogging(true); // experimental API only (may change without warning)
|
||||||
|
```
|
||||||
|
Example output:
|
||||||
|
```
|
||||||
|
Sending request: http://localhost:35123/bearer#global GET
|
||||||
|
Request headers: {Accept=[application/json], Authorization=[******], Client-Level-Header=[added by client], Idempotency-Key=[some-key], x-speakeasy-user-agent=[speakeasy-sdk/java 0.0.1 internal 0.1.0 org.openapis.openapi]}
|
||||||
|
Received response: (GET http://localhost:35123/bearer#global) 200
|
||||||
|
Response headers: {access-control-allow-credentials=[true], access-control-allow-origin=[*], connection=[keep-alive], content-length=[50], content-type=[application/json], date=[Wed, 09 Apr 2025 01:43:29 GMT], server=[gunicorn/19.9.0]}
|
||||||
|
Response body:
|
||||||
|
{
|
||||||
|
"authenticated": true,
|
||||||
|
"token": "global"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
WARNING: This should only used for temporary debugging purposes. Leaving this option on in a production system could expose credentials/secrets in logs. <i>Authorization</i> headers are redacted by default and there is the ability to specify redacted header names via `SpeakeasyHTTPClient.setRedactedHeaders`.
|
||||||
|
|
||||||
|
Another option is to set the System property `-Djdk.httpclient.HttpClient.log=all`. However, this second option does not log bodies.
|
||||||
<!-- End SDK Installation [installation] -->
|
<!-- End SDK Installation [installation] -->
|
||||||
|
|
||||||
<!-- Start SDK Example Usage [usage] -->
|
<!-- Start SDK Example Usage [usage] -->
|
||||||
@@ -108,11 +139,6 @@ public class Application {
|
|||||||
|
|
||||||
PlexAPI sdk = PlexAPI.builder()
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
|
||||||
.clientName("Plex for Roku")
|
|
||||||
.clientVersion("2.4.1")
|
|
||||||
.platform("Roku")
|
|
||||||
.deviceNickname("Roku 3")
|
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
@@ -166,13 +192,20 @@ public class Application {
|
|||||||
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||||
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||||
|
* [getLibrarySectionsAll](docs/sdks/library/README.md#getlibrarysectionsall) - Get Library section media by tag ALL
|
||||||
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||||
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||||
|
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
||||||
|
* [getCountriesLibrary](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
|
||||||
|
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
|
||||||
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||||
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
* [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
||||||
|
* [getMediaArts](docs/sdks/library/README.md#getmediaarts) - Get Media Background Artwork
|
||||||
|
* [postMediaArts](docs/sdks/library/README.md#postmediaarts) - Upload Media Background Artwork
|
||||||
|
* [getMediaPosters](docs/sdks/library/README.md#getmediaposters) - Get Media Posters
|
||||||
|
* [postMediaPoster](docs/sdks/library/README.md#postmediaposter) - Upload Media Poster
|
||||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||||
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||||
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
|
||||||
|
|
||||||
### [log()](docs/sdks/log/README.md)
|
### [log()](docs/sdks/log/README.md)
|
||||||
|
|
||||||
@@ -248,6 +281,10 @@ public class Application {
|
|||||||
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
||||||
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
||||||
|
|
||||||
|
### [users()](docs/sdks/users/README.md)
|
||||||
|
|
||||||
|
* [getUsers](docs/sdks/users/README.md#getusers) - Get list of all connected users
|
||||||
|
|
||||||
### [video()](docs/sdks/video/README.md)
|
### [video()](docs/sdks/video/README.md)
|
||||||
|
|
||||||
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
||||||
@@ -290,11 +327,6 @@ public class Application {
|
|||||||
|
|
||||||
PlexAPI sdk = PlexAPI.builder()
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
|
||||||
.clientName("Plex for Roku")
|
|
||||||
.clientVersion("2.4.1")
|
|
||||||
.platform("Roku")
|
|
||||||
.deviceNickname("Roku 3")
|
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
@@ -314,13 +346,49 @@ public class Application {
|
|||||||
### Server Variables
|
### Server Variables
|
||||||
|
|
||||||
The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following builder methods are available when initializing the SDK client instance:
|
The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following builder methods are available when initializing the SDK client instance:
|
||||||
* `protocol(ServerProtocol protocol)`
|
|
||||||
* `ip(String ip)`
|
| Variable | BuilderMethod | Supported Values | Default | Description |
|
||||||
* `port(String port)`
|
| ---------- | ----------------------------------- | -------------------------- | --------------- | ---------------------------------------------- |
|
||||||
|
| `protocol` | `protocol(ServerProtocol protocol)` | - `"http"`<br/>- `"https"` | `"https"` | The protocol to use for the server connection |
|
||||||
|
| `ip` | `ip(String ip)` | java.lang.String | `"10.10.10.47"` | The IP address or hostname of your Plex Server |
|
||||||
|
| `port` | `port(String port)` | java.lang.String | `"32400"` | The port of your Plex Server |
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
```java
|
||||||
|
package hello.world;
|
||||||
|
|
||||||
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
|
import dev.plexapi.sdk.SDK.Builder.ServerProtocol;
|
||||||
|
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesBadRequest;
|
||||||
|
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesUnauthorized;
|
||||||
|
import dev.plexapi.sdk.models.operations.GetServerCapabilitiesResponse;
|
||||||
|
import java.lang.Exception;
|
||||||
|
|
||||||
|
public class Application {
|
||||||
|
|
||||||
|
public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {
|
||||||
|
|
||||||
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
|
.protocol(ServerProtocol.HTTPS)
|
||||||
|
.ip("4982:bc2a:b4f8:efb5:2394:5bc3:ab4f:0e6d")
|
||||||
|
.port("44765")
|
||||||
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
|
.build();
|
||||||
|
|
||||||
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
|
.call();
|
||||||
|
|
||||||
|
if (res.object().isPresent()) {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### Override Server URL Per-Client
|
### Override Server URL Per-Client
|
||||||
|
|
||||||
The default server can also be overridden globally using the `.serverURL(String serverUrl)` builder method when initializing the SDK client instance. For example:
|
The default server can be overridden globally using the `.serverURL(String serverUrl)` builder method when initializing the SDK client instance. For example:
|
||||||
```java
|
```java
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
@@ -337,11 +405,6 @@ public class Application {
|
|||||||
PlexAPI sdk = PlexAPI.builder()
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
.serverURL("https://10.10.10.47:32400")
|
.serverURL("https://10.10.10.47:32400")
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
|
||||||
.clientName("Plex for Roku")
|
|
||||||
.clientVersion("2.4.1")
|
|
||||||
.platform("Roku")
|
|
||||||
.deviceNickname("Roku 3")
|
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
@@ -372,11 +435,6 @@ public class Application {
|
|||||||
|
|
||||||
PlexAPI sdk = PlexAPI.builder()
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
|
||||||
.clientName("Plex for Roku")
|
|
||||||
.clientVersion("2.4.1")
|
|
||||||
.platform("Roku")
|
|
||||||
.deviceNickname("Roku 3")
|
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetCompanionsDataResponse res = sdk.plex().getCompanionsData()
|
GetCompanionsDataResponse res = sdk.plex().getCompanionsData()
|
||||||
@@ -418,11 +476,6 @@ public class Application {
|
|||||||
|
|
||||||
PlexAPI sdk = PlexAPI.builder()
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
|
||||||
.clientName("Plex for Roku")
|
|
||||||
.clientVersion("2.4.1")
|
|
||||||
.platform("Roku")
|
|
||||||
.deviceNickname("Roku 3")
|
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
|
|||||||
190
RELEASES.md
190
RELEASES.md
@@ -169,3 +169,193 @@ Based on:
|
|||||||
- [java v0.10.0] .
|
- [java v0.10.0] .
|
||||||
### Releases
|
### Releases
|
||||||
- [Maven Central v0.10.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.10.0 - .
|
- [Maven Central v0.10.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.10.0 - .
|
||||||
|
|
||||||
|
## 2024-11-14 00:25:48
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.439.0 (2.457.9) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.10.1] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.10.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.10.1 - .
|
||||||
|
|
||||||
|
## 2024-12-21 00:25:42
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.459.2 (2.483.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.11.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.11.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.0 - .
|
||||||
|
|
||||||
|
## 2024-12-22 00:28:49
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.459.2 (2.483.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.11.1] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.11.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.1 - .
|
||||||
|
|
||||||
|
## 2025-01-24 00:25:37
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.474.0 (2.495.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.11.2] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.11.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.2 - .
|
||||||
|
|
||||||
|
## 2025-01-27 00:26:34
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.476.1 (2.495.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.11.3] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.11.3] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.3 - .
|
||||||
|
|
||||||
|
## 2025-02-05 00:25:55
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.11.4] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.11.4] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.4 - .
|
||||||
|
|
||||||
|
## 2025-02-06 00:26:06
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.11.5] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.11.5] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.5 - .
|
||||||
|
|
||||||
|
## 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 - .
|
||||||
5
USAGE.md
5
USAGE.md
@@ -14,11 +14,6 @@ public class Application {
|
|||||||
|
|
||||||
PlexAPI sdk = PlexAPI.builder()
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
|
||||||
.clientName("Plex for Roku")
|
|
||||||
.clientVersion("2.4.1")
|
|
||||||
.platform("Roku")
|
|
||||||
.deviceNickname("Roku 3")
|
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
|
|||||||
43
build.gradle
43
build.gradle
@@ -39,9 +39,12 @@ model {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
version = "${version}"
|
||||||
|
group = "${groupId}"
|
||||||
|
|
||||||
jar {
|
jar {
|
||||||
dependsOn(":generatePomFileForMavenPublication")
|
dependsOn(":generatePomFileForMavenPublication")
|
||||||
archiveBaseName = "plexapi"
|
archiveBaseName = "${artifactId}"
|
||||||
|
|
||||||
into("META-INF/maven/dev.plexapi/plexapi") {
|
into("META-INF/maven/dev.plexapi/plexapi") {
|
||||||
from("$buildDir/pom.xml")
|
from("$buildDir/pom.xml")
|
||||||
@@ -62,15 +65,12 @@ tasks.withType(Javadoc) {
|
|||||||
options.addStringOption('Xdoclint:none', '-quiet')
|
options.addStringOption('Xdoclint:none', '-quiet')
|
||||||
}
|
}
|
||||||
|
|
||||||
group = "dev.plexapi"
|
|
||||||
version = "0.10.0"
|
|
||||||
|
|
||||||
sourcesJar {
|
sourcesJar {
|
||||||
archiveBaseName = "plexapi"
|
archiveBaseName = "${artifactId}"
|
||||||
}
|
}
|
||||||
|
|
||||||
javadocJar {
|
javadocJar {
|
||||||
archiveBaseName = "plexapi"
|
archiveBaseName = "${artifactId}"
|
||||||
}
|
}
|
||||||
sonatypeCentralUpload {
|
sonatypeCentralUpload {
|
||||||
// This is your Sonatype generated username
|
// This is your Sonatype generated username
|
||||||
@@ -80,9 +80,9 @@ sonatypeCentralUpload {
|
|||||||
|
|
||||||
// This is a list of files to upload. Ideally you would point to your jar file, source and javadoc jar (required by central)
|
// 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(
|
archives = files(
|
||||||
"$buildDir/libs/plexapi-${version}.jar",
|
"$buildDir/libs/${artifactId}-${version}.jar",
|
||||||
"$buildDir/libs/plexapi-${version}-sources.jar",
|
"$buildDir/libs/${artifactId}-${version}-sources.jar",
|
||||||
"$buildDir/libs/plexapi-${version}-javadoc.jar"
|
"$buildDir/libs/${artifactId}-${version}-javadoc.jar"
|
||||||
)
|
)
|
||||||
|
|
||||||
// This is the pom file to upload. This is required by central
|
// This is the pom file to upload. This is required by central
|
||||||
@@ -99,9 +99,11 @@ publishing {
|
|||||||
|
|
||||||
publications {
|
publications {
|
||||||
maven(MavenPublication) {
|
maven(MavenPublication) {
|
||||||
groupId = 'dev.plexapi'
|
// note that properties can't yet be used below!
|
||||||
artifactId = 'plexapi'
|
// https://github.com/gradle/gradle/issues/18619
|
||||||
version = '0.10.0'
|
groupId = "dev.plexapi"
|
||||||
|
artifactId = "plexapi"
|
||||||
|
version = "0.17.0"
|
||||||
|
|
||||||
from components.java
|
from components.java
|
||||||
|
|
||||||
@@ -144,16 +146,15 @@ if (!project.hasProperty('skip.signing')) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
dependencies {
|
dependencies {
|
||||||
implementation 'com.fasterxml.jackson.core:jackson-databind:2.17.2'
|
api 'com.fasterxml.jackson.core:jackson-annotations:2.18.2'
|
||||||
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.17.2'
|
implementation 'com.fasterxml.jackson.core:jackson-databind:2.18.2'
|
||||||
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.17.2'
|
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.18.2'
|
||||||
implementation 'org.openapitools:jackson-databind-nullable:0.2.6'
|
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.18.2'
|
||||||
implementation 'org.apache.httpcomponents:httpclient:4.5.14'
|
api('org.openapitools:jackson-databind-nullable:0.2.6') {exclude group: 'com.fasterxml.jackson.core', module: 'jackson-databind'}
|
||||||
implementation 'org.apache.httpcomponents:httpmime:4.5.14'
|
implementation 'commons-io:commons-io:2.18.0'
|
||||||
implementation 'commons-io:commons-io:2.15.1'
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
apply from: 'build-extras.gradle'
|
apply from: 'build-extras.gradle'
|
||||||
|
|||||||
1690
codeSamples.yaml
1690
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
@@ -1,4 +1,4 @@
|
|||||||
# GetMetaDataByRatingKeyBadRequest
|
# GetActorsLibraryBadRequest
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
@@ -7,5 +7,5 @@ Bad Request - A parameter was not specified, or was specified incorrectly.
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | List\<[GetMetaDataByRatingKeyErrors](../../models/errors/GetMetaDataByRatingKeyErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | List\<[GetActorsLibraryErrors](../../models/errors/GetActorsLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetMetaDataByRatingKeyErrors
|
# GetActorsLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetMetaDataByRatingKeyLibraryErrors
|
# GetActorsLibraryLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetMetaDataByRatingKeyUnauthorized
|
# GetActorsLibraryUnauthorized
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
@@ -7,5 +7,5 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | List\<[GetMetaDataByRatingKeyLibraryErrors](../../models/errors/GetMetaDataByRatingKeyLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | List\<[GetActorsLibraryLibraryErrors](../../models/errors/GetActorsLibraryLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
11
docs/models/errors/GetCountriesLibraryBadRequest.md
Normal file
11
docs/models/errors/GetCountriesLibraryBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetCountriesLibraryBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | List\<[GetCountriesLibraryErrors](../../models/errors/GetCountriesLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/models/errors/GetCountriesLibraryErrors.md
Normal file
10
docs/models/errors/GetCountriesLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetCountriesLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/models/errors/GetCountriesLibraryLibraryErrors.md
Normal file
10
docs/models/errors/GetCountriesLibraryLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetCountriesLibraryLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/models/errors/GetCountriesLibraryUnauthorized.md
Normal file
11
docs/models/errors/GetCountriesLibraryUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetCountriesLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | List\<[GetCountriesLibraryLibraryErrors](../../models/errors/GetCountriesLibraryLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
11
docs/models/errors/GetGenresLibraryBadRequest.md
Normal file
11
docs/models/errors/GetGenresLibraryBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetGenresLibraryBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | List\<[GetGenresLibraryErrors](../../models/errors/GetGenresLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/models/errors/GetGenresLibraryErrors.md
Normal file
10
docs/models/errors/GetGenresLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetGenresLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/models/errors/GetGenresLibraryLibraryErrors.md
Normal file
10
docs/models/errors/GetGenresLibraryLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetGenresLibraryLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/models/errors/GetGenresLibraryUnauthorized.md
Normal file
11
docs/models/errors/GetGenresLibraryUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetGenresLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | List\<[GetGenresLibraryLibraryErrors](../../models/errors/GetGenresLibraryLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
11
docs/models/errors/GetLibrarySectionsAllBadRequest.md
Normal file
11
docs/models/errors/GetLibrarySectionsAllBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibrarySectionsAllBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | List\<[GetLibrarySectionsAllErrors](../../models/errors/GetLibrarySectionsAllErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/models/errors/GetLibrarySectionsAllErrors.md
Normal file
10
docs/models/errors/GetLibrarySectionsAllErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibrarySectionsAllErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/models/errors/GetLibrarySectionsAllLibraryErrors.md
Normal file
10
docs/models/errors/GetLibrarySectionsAllLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibrarySectionsAllLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/models/errors/GetLibrarySectionsAllUnauthorized.md
Normal file
11
docs/models/errors/GetLibrarySectionsAllUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibrarySectionsAllUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | List\<[GetLibrarySectionsAllLibraryErrors](../../models/errors/GetLibrarySectionsAllLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
11
docs/models/errors/GetMediaMetaDataBadRequest.md
Normal file
11
docs/models/errors/GetMediaMetaDataBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetMediaMetaDataBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | List\<[GetMediaMetaDataErrors](../../models/errors/GetMediaMetaDataErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/models/errors/GetMediaMetaDataErrors.md
Normal file
10
docs/models/errors/GetMediaMetaDataErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetMediaMetaDataErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/models/errors/GetMediaMetaDataLibraryErrors.md
Normal file
10
docs/models/errors/GetMediaMetaDataLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetMediaMetaDataLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/models/errors/GetMediaMetaDataUnauthorized.md
Normal file
11
docs/models/errors/GetMediaMetaDataUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetMediaMetaDataUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | List\<[GetMediaMetaDataLibraryErrors](../../models/errors/GetMediaMetaDataLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetOnDeckBadRequest
|
# GetUsersBadRequest
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
@@ -7,5 +7,5 @@ Bad Request - A parameter was not specified, or was specified incorrectly.
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | List\<[GetOnDeckErrors](../../models/errors/GetOnDeckErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | List\<[GetUsersErrors](../../models/errors/GetUsersErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetOnDeckErrors
|
# GetUsersErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetOnDeckUnauthorized
|
# GetUsersUnauthorized
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
@@ -7,5 +7,5 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | List\<[GetOnDeckLibraryErrors](../../models/errors/GetOnDeckLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | List\<[GetUsersUsersErrors](../../models/errors/GetUsersUsersErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetOnDeckLibraryErrors
|
# GetUsersUsersErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
11
docs/models/operations/AllLibraries.md
Normal file
11
docs/models/operations/AllLibraries.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# AllLibraries
|
||||||
|
|
||||||
|
Indicates if the user has access to all libraries.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
11
docs/models/operations/AllowCameraUpload.md
Normal file
11
docs/models/operations/AllowCameraUpload.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# AllowCameraUpload
|
||||||
|
|
||||||
|
Indicates if the user is allowed to upload from a camera.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
11
docs/models/operations/AllowChannels.md
Normal file
11
docs/models/operations/AllowChannels.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# AllowChannels
|
||||||
|
|
||||||
|
Indicates if the user has access to channels.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
11
docs/models/operations/AllowSubtitleAdmin.md
Normal file
11
docs/models/operations/AllowSubtitleAdmin.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# AllowSubtitleAdmin
|
||||||
|
|
||||||
|
Indicates if the user can manage subtitles.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
11
docs/models/operations/AllowSync.md
Normal file
11
docs/models/operations/AllowSync.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# AllowSync
|
||||||
|
|
||||||
|
Indicates if the user is allowed to sync media.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
11
docs/models/operations/AllowTuners.md
Normal file
11
docs/models/operations/AllowTuners.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# AllowTuners
|
||||||
|
|
||||||
|
Indicates if the user is allowed to use tuners.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
11
docs/models/operations/Attributes.md
Normal file
11
docs/models/operations/Attributes.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# Attributes
|
||||||
|
|
||||||
|
Attributes associated with the marker.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | The identifier for the attributes. | 306970 |
|
||||||
|
| `version` | *Optional\<Long>* | :heavy_minus_sign: | The version number of the marker attributes. | 4 |
|
||||||
15
docs/models/operations/Chapter.md
Normal file
15
docs/models/operations/Chapter.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# Chapter
|
||||||
|
|
||||||
|
The thumbnail for the chapter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | N/A | 4 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | N/A | thumb=4 |
|
||||||
|
| `index` | *long* | :heavy_check_mark: | N/A | 1 |
|
||||||
|
| `startTimeOffset` | *long* | :heavy_check_mark: | N/A | 0 |
|
||||||
|
| `endTimeOffset` | *long* | :heavy_check_mark: | N/A | 100100 |
|
||||||
|
| `thumb` | *String* | :heavy_check_mark: | N/A | /library/media/46883/chapterImages/1 |
|
||||||
@@ -4,5 +4,5 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | Working NL Subs |
|
| `tag` | *String* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||||
@@ -1,8 +1,12 @@
|
|||||||
# Country
|
# Country
|
||||||
|
|
||||||
|
The filter query string for country media items.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | United States of America |
|
| `id` | *int* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | N/A | country=19 |
|
||||||
@@ -4,5 +4,9 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | James Cameron |
|
| `id` | *int* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | The filter string used to query this director. | director=235876 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||||
|
| `tagKey` | *String* | :heavy_check_mark: | A unique 24-character hexadecimal key associated with the director's tag, used for internal identification. | 5d776831151a60001f24d031 |
|
||||||
|
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||||
11
docs/models/operations/EnableCreditsMarkerGeneration.md
Normal file
11
docs/models/operations/EnableCreditsMarkerGeneration.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# EnableCreditsMarkerGeneration
|
||||||
|
|
||||||
|
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------- | ---------------- |
|
||||||
|
| `LibraryDefault` | -1 |
|
||||||
|
| `Disabled` | 0 |
|
||||||
12
docs/models/operations/EpisodeSort.md
Normal file
12
docs/models/operations/EpisodeSort.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# EpisodeSort
|
||||||
|
|
||||||
|
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------- | ---------------- |
|
||||||
|
| `LibraryDefault` | -1 |
|
||||||
|
| `OldestFirst` | 0 |
|
||||||
|
| `NewestFirst` | 1 |
|
||||||
8
docs/models/operations/Extras.md
Normal file
8
docs/models/operations/Extras.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Extras
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
|
||||||
|
| `size` | *Optional\<Long>* | :heavy_minus_sign: | The size of the extras. | 1 |
|
||||||
@@ -1,9 +1,12 @@
|
|||||||
# FlattenSeasons
|
# FlattenSeasons
|
||||||
|
|
||||||
|
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| ------- | ------- |
|
| ---------------- | ---------------- |
|
||||||
| `False` | 0 |
|
| `LibraryDefault` | -1 |
|
||||||
| `True` | 1 |
|
| `Hide` | 0 |
|
||||||
|
| `Show` | 1 |
|
||||||
@@ -1,8 +1,12 @@
|
|||||||
# Genre
|
# Genre
|
||||||
|
|
||||||
|
The filter query string for similar items.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | Adventure |
|
| `id` | *int* | :heavy_check_mark: | The unique identifier for the genre.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | N/A | genre=19 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||||
11
docs/models/operations/GetActorsLibraryDirectory.md
Normal file
11
docs/models/operations/GetActorsLibraryDirectory.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetActorsLibraryDirectory
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
|
| `fastKey` | *String* | :heavy_check_mark: | A fast lookup key for the actor relative url. | /library/sections/2/all?actor=134671 |
|
||||||
|
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the actor. | https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | A unique key representing the actor. | 134671 |
|
||||||
|
| `title` | *String* | :heavy_check_mark: | The name of the actor. | Aaron Paul |
|
||||||
20
docs/models/operations/GetActorsLibraryMediaContainer.md
Normal file
20
docs/models/operations/GetActorsLibraryMediaContainer.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# GetActorsLibraryMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
|
| `art` | *String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
|
| `identifier` | *String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
|
| `mediaTagPrefix` | *String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
|
| `mediaTagVersion` | *long* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
|
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||||
|
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
|
| `title1` | *String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
|
| `title2` | *String* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||||
|
| `viewGroup` | *String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||||
|
| `viewMode` | *String* | :heavy_check_mark: | Identifier for the view mode. | 131131 |
|
||||||
|
| `directory` | List\<[GetActorsLibraryDirectory](../../models/operations/GetActorsLibraryDirectory.md)> | :heavy_minus_sign: | An array of actor entries for media items. | |
|
||||||
24
docs/models/operations/GetActorsLibraryQueryParamType.md
Normal file
24
docs/models/operations/GetActorsLibraryQueryParamType.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# GetActorsLibraryQueryParamType
|
||||||
|
|
||||||
|
The type of media to retrieve or filter by.
|
||||||
|
1 = movie
|
||||||
|
2 = show
|
||||||
|
3 = season
|
||||||
|
4 = episode
|
||||||
|
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Movie` | 1 |
|
||||||
|
| `TvShow` | 2 |
|
||||||
|
| `Season` | 3 |
|
||||||
|
| `Episode` | 4 |
|
||||||
|
| `Artist` | 5 |
|
||||||
|
| `Album` | 6 |
|
||||||
|
| `Track` | 7 |
|
||||||
|
| `PhotoAlbum` | 8 |
|
||||||
|
| `Photo` | 9 |
|
||||||
9
docs/models/operations/GetActorsLibraryRequest.md
Normal file
9
docs/models/operations/GetActorsLibraryRequest.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetActorsLibraryRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
|
| `type` | [GetActorsLibraryQueryParamType](../../models/operations/GetActorsLibraryQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||||
11
docs/models/operations/GetActorsLibraryResponse.md
Normal file
11
docs/models/operations/GetActorsLibraryResponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetActorsLibraryResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [Optional\<GetActorsLibraryResponseBody>](../../models/operations/GetActorsLibraryResponseBody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||||
10
docs/models/operations/GetActorsLibraryResponseBody.md
Normal file
10
docs/models/operations/GetActorsLibraryResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetActorsLibraryResponseBody
|
||||||
|
|
||||||
|
Successful response containing media container data.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `mediaContainer` | [Optional\<GetActorsLibraryMediaContainer>](../../models/operations/GetActorsLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -4,25 +4,25 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `art` | *String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
| `art` | *String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
| `composite` | *String* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
|
| `composite` | *String* | :heavy_check_mark: | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
|
||||||
| `filters` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `filters` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||||
| `refreshing` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `refreshing` | *boolean* | :heavy_check_mark: | Indicates whether the library is currently being refreshed or updated | true |
|
||||||
| `thumb` | *String* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | 1 |
|
| `key` | *String* | :heavy_check_mark: | The library key representing the unique identifier | 1 |
|
||||||
| `type` | *String* | :heavy_check_mark: | N/A | movie |
|
| `type` | [GetAllLibrariesType](../../models/operations/GetAllLibrariesType.md) | :heavy_check_mark: | N/A | movie |
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | Movies |
|
| `title` | *String* | :heavy_check_mark: | The title of the library | Movies |
|
||||||
| `agent` | *String* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
|
| `agent` | *String* | :heavy_check_mark: | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
|
||||||
| `scanner` | *String* | :heavy_check_mark: | N/A | Plex Movie |
|
| `scanner` | *String* | :heavy_check_mark: | UNKNOWN | Plex Movie |
|
||||||
| `language` | *String* | :heavy_check_mark: | N/A | en-US |
|
| `language` | *String* | :heavy_check_mark: | The Plex library language that has been set | en-US |
|
||||||
| `uuid` | *String* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
| `uuid` | *String* | :heavy_check_mark: | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-01e7d3cc34d6 |
|
||||||
| `updatedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
| `updatedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `createdAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
| `createdAt` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1556281940 |
|
||||||
| `scannedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
| `scannedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `content` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `content` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||||
| `directory` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `directory` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||||
| `contentChangedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
| `contentChangedAt` | *long* | :heavy_check_mark: | Timestamp (in seconds) representing the last time the content was modified.<br/>NOTE: Some Plex server have some absurd values for this field, like 8457612157633039800 so it should be int64<br/> | 9173960 |
|
||||||
| `hidden` | *int* | :heavy_check_mark: | N/A | 0 |
|
| `hidden` | [Optional\<Hidden>](../../models/operations/Hidden.md) | :heavy_minus_sign: | The Plex library visibility setting | 1 |
|
||||||
| `location` | List\<[GetAllLibrariesLocation](../../models/operations/GetAllLibrariesLocation.md)> | :heavy_check_mark: | N/A | |
|
| `location` | List\<[GetAllLibrariesLocation](../../models/operations/GetAllLibrariesLocation.md)> | :heavy_check_mark: | N/A | |
|
||||||
@@ -4,6 +4,6 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- |
|
||||||
| `id` | *int* | :heavy_check_mark: | N/A | 1 |
|
| `id` | *int* | :heavy_check_mark: | The ID of the location. | 1 |
|
||||||
| `path` | *String* | :heavy_check_mark: | N/A | /movies |
|
| `path` | *String* | :heavy_check_mark: | The path to the media item. | /Movies |
|
||||||
@@ -5,7 +5,7 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||||
| `size` | *int* | :heavy_check_mark: | N/A | 5 |
|
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `title1` | *String* | :heavy_check_mark: | N/A | Plex Library |
|
| `title1` | *String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
| `directory` | List\<[GetAllLibrariesDirectory](../../models/operations/GetAllLibrariesDirectory.md)> | :heavy_check_mark: | N/A | |
|
| `directory` | List\<[GetAllLibrariesDirectory](../../models/operations/GetAllLibrariesDirectory.md)> | :heavy_minus_sign: | N/A | |
|
||||||
@@ -6,5 +6,5 @@ The libraries available on the Server
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||||
| `mediaContainer` | [GetAllLibrariesMediaContainer](../../models/operations/GetAllLibrariesMediaContainer.md) | :heavy_check_mark: | N/A |
|
| `mediaContainer` | [Optional\<GetAllLibrariesMediaContainer>](../../models/operations/GetAllLibrariesMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||||
19
docs/models/operations/GetAllLibrariesType.md
Normal file
19
docs/models/operations/GetAllLibrariesType.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# GetAllLibrariesType
|
||||||
|
|
||||||
|
The library type
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Movie` | movie |
|
||||||
|
| `TvShow` | show |
|
||||||
|
| `Season` | season |
|
||||||
|
| `Episode` | episode |
|
||||||
|
| `Artist` | artist |
|
||||||
|
| `Album` | album |
|
||||||
|
| `Track` | track |
|
||||||
|
| `PhotoAlbum` | photoalbum |
|
||||||
|
| `Photo` | photo |
|
||||||
|
| `Collection` | collection |
|
||||||
10
docs/models/operations/GetCountriesLibraryDirectory.md
Normal file
10
docs/models/operations/GetCountriesLibraryDirectory.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetCountriesLibraryDirectory
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
|
||||||
|
| `fastKey` | *String* | :heavy_check_mark: | N/A | /library/sections/2/all?country=15491 |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | N/A | 15491 |
|
||||||
|
| `title` | *String* | :heavy_check_mark: | N/A | Japan |
|
||||||
20
docs/models/operations/GetCountriesLibraryMediaContainer.md
Normal file
20
docs/models/operations/GetCountriesLibraryMediaContainer.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# GetCountriesLibraryMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
|
| `art` | *String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
|
| `content` | *String* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||||
|
| `identifier` | *String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
|
| `mediaTagPrefix` | *String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
|
| `mediaTagVersion` | *long* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
|
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||||
|
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
|
| `title1` | *String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
|
| `title2` | *String* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||||
|
| `viewGroup` | *String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||||
|
| `directory` | List\<[GetCountriesLibraryDirectory](../../models/operations/GetCountriesLibraryDirectory.md)> | :heavy_minus_sign: | N/A | |
|
||||||
24
docs/models/operations/GetCountriesLibraryQueryParamType.md
Normal file
24
docs/models/operations/GetCountriesLibraryQueryParamType.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# GetCountriesLibraryQueryParamType
|
||||||
|
|
||||||
|
The type of media to retrieve or filter by.
|
||||||
|
1 = movie
|
||||||
|
2 = show
|
||||||
|
3 = season
|
||||||
|
4 = episode
|
||||||
|
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Movie` | 1 |
|
||||||
|
| `TvShow` | 2 |
|
||||||
|
| `Season` | 3 |
|
||||||
|
| `Episode` | 4 |
|
||||||
|
| `Artist` | 5 |
|
||||||
|
| `Album` | 6 |
|
||||||
|
| `Track` | 7 |
|
||||||
|
| `PhotoAlbum` | 8 |
|
||||||
|
| `Photo` | 9 |
|
||||||
9
docs/models/operations/GetCountriesLibraryRequest.md
Normal file
9
docs/models/operations/GetCountriesLibraryRequest.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetCountriesLibraryRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
|
| `type` | [GetCountriesLibraryQueryParamType](../../models/operations/GetCountriesLibraryQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||||
11
docs/models/operations/GetCountriesLibraryResponse.md
Normal file
11
docs/models/operations/GetCountriesLibraryResponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetCountriesLibraryResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [Optional\<GetCountriesLibraryResponseBody>](../../models/operations/GetCountriesLibraryResponseBody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||||
10
docs/models/operations/GetCountriesLibraryResponseBody.md
Normal file
10
docs/models/operations/GetCountriesLibraryResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetCountriesLibraryResponseBody
|
||||||
|
|
||||||
|
Successful response containing media container data.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `mediaContainer` | [Optional\<GetCountriesLibraryMediaContainer>](../../models/operations/GetCountriesLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||||
11
docs/models/operations/GetGenresLibraryDirectory.md
Normal file
11
docs/models/operations/GetGenresLibraryDirectory.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetGenresLibraryDirectory
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
|
||||||
|
| `fastKey` | *String* | :heavy_check_mark: | N/A | /library/sections/10/all?genre=89 |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | N/A | 89 |
|
||||||
|
| `title` | *String* | :heavy_check_mark: | N/A | Action |
|
||||||
|
| `type` | *String* | :heavy_check_mark: | N/A | genre |
|
||||||
20
docs/models/operations/GetGenresLibraryMediaContainer.md
Normal file
20
docs/models/operations/GetGenresLibraryMediaContainer.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# GetGenresLibraryMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
|
| `art` | *String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
|
| `content` | *String* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||||
|
| `identifier` | *String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
|
| `mediaTagPrefix` | *String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
|
| `mediaTagVersion` | *long* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
|
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||||
|
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
|
| `title1` | *String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
|
| `title2` | *String* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||||
|
| `viewGroup` | *String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||||
|
| `directory` | List\<[GetGenresLibraryDirectory](../../models/operations/GetGenresLibraryDirectory.md)> | :heavy_minus_sign: | N/A | |
|
||||||
24
docs/models/operations/GetGenresLibraryQueryParamType.md
Normal file
24
docs/models/operations/GetGenresLibraryQueryParamType.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# GetGenresLibraryQueryParamType
|
||||||
|
|
||||||
|
The type of media to retrieve or filter by.
|
||||||
|
1 = movie
|
||||||
|
2 = show
|
||||||
|
3 = season
|
||||||
|
4 = episode
|
||||||
|
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Movie` | 1 |
|
||||||
|
| `TvShow` | 2 |
|
||||||
|
| `Season` | 3 |
|
||||||
|
| `Episode` | 4 |
|
||||||
|
| `Artist` | 5 |
|
||||||
|
| `Album` | 6 |
|
||||||
|
| `Track` | 7 |
|
||||||
|
| `PhotoAlbum` | 8 |
|
||||||
|
| `Photo` | 9 |
|
||||||
9
docs/models/operations/GetGenresLibraryRequest.md
Normal file
9
docs/models/operations/GetGenresLibraryRequest.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetGenresLibraryRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
|
| `type` | [GetGenresLibraryQueryParamType](../../models/operations/GetGenresLibraryQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||||
11
docs/models/operations/GetGenresLibraryResponse.md
Normal file
11
docs/models/operations/GetGenresLibraryResponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetGenresLibraryResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [Optional\<GetGenresLibraryResponseBody>](../../models/operations/GetGenresLibraryResponseBody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||||
10
docs/models/operations/GetGenresLibraryResponseBody.md
Normal file
10
docs/models/operations/GetGenresLibraryResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetGenresLibraryResponseBody
|
||||||
|
|
||||||
|
Successful response containing media container data.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `mediaContainer` | [Optional\<GetGenresLibraryMediaContainer>](../../models/operations/GetGenresLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -4,6 +4,6 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `includeDetails` | [Optional\<IncludeDetails>](../../models/operations/IncludeDetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts).<br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
| `includeDetails` | [Optional\<IncludeDetails>](../../models/operations/IncludeDetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts).<br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
||||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
@@ -10,3 +10,4 @@
|
|||||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | Genre |
|
| `title` | *String* | :heavy_check_mark: | N/A | Genre |
|
||||||
| `type` | *String* | :heavy_check_mark: | N/A | filter |
|
| `type` | *String* | :heavy_check_mark: | N/A | filter |
|
||||||
|
| `advanced` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||||
@@ -1,14 +1,20 @@
|
|||||||
# GetLibraryItemsLibraryType
|
# GetLibraryItemsLibraryType
|
||||||
|
|
||||||
The type of media content
|
The type of media content in the Plex library. This can represent videos, music, or photos.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------- | --------- |
|
| ------------ | ------------ |
|
||||||
| `Movie` | movie |
|
| `Movie` | movie |
|
||||||
| `TvShow` | show |
|
| `TvShow` | show |
|
||||||
| `Season` | season |
|
| `Season` | season |
|
||||||
| `Episode` | episode |
|
| `Episode` | episode |
|
||||||
|
| `Artist` | artist |
|
||||||
|
| `Album` | album |
|
||||||
|
| `Track` | track |
|
||||||
|
| `PhotoAlbum` | photoalbum |
|
||||||
|
| `Photo` | photo |
|
||||||
|
| `Collection` | collection |
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# GetLibraryItemsMediaGuid
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
|
||||||
| `id` | *String* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetLibraryItemsMetaDataRating
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
|
||||||
| `image` | *String* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
|
|
||||||
| `value` | *float* | :heavy_check_mark: | The value of the rating. | 3 |
|
|
||||||
| `type` | *String* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
|
||||||
@@ -13,7 +13,7 @@
|
|||||||
| `librarySectionID` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1 |
|
| `librarySectionID` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `librarySectionTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Movies |
|
| `librarySectionTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Movies |
|
||||||
| `librarySectionKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
| `librarySectionKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||||
| `type` | [GetLibraryItemsLibraryType](../../models/operations/GetLibraryItemsLibraryType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
| `type` | [GetLibraryItemsLibraryType](../../models/operations/GetLibraryItemsLibraryType.md) | :heavy_check_mark: | The type of media content in the Plex library. This can represent videos, music, or photos.<br/> | movie |
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
| `title` | *String* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||||
| `slug` | *Optional\<String>* | :heavy_minus_sign: | N/A | 4-for-texas |
|
| `slug` | *Optional\<String>* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||||
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | N/A | PG-13 |
|
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | N/A | PG-13 |
|
||||||
@@ -23,8 +23,10 @@
|
|||||||
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
||||||
| `seasonCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
| `seasonCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
||||||
| `tagline` | *Optional\<String>* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
| `tagline` | *Optional\<String>* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||||
| `flattenSeasons` | [Optional\<GetLibraryItemsFlattenSeasons>](../../models/operations/GetLibraryItemsFlattenSeasons.md) | :heavy_minus_sign: | N/A | 1 |
|
| `flattenSeasons` | [Optional\<FlattenSeasons>](../../models/operations/FlattenSeasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
|
||||||
| `showOrdering` | [Optional\<GetLibraryItemsShowOrdering>](../../models/operations/GetLibraryItemsShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
|
| `episodeSort` | [Optional\<EpisodeSort>](../../models/operations/EpisodeSort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
|
||||||
|
| `enableCreditsMarkerGeneration` | [Optional\<EnableCreditsMarkerGeneration>](../../models/operations/EnableCreditsMarkerGeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
||||||
|
| `showOrdering` | [Optional\<ShowOrdering>](../../models/operations/ShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
|
||||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||||
| `art` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
| `art` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||||
| `banner` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
| `banner` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||||
@@ -53,9 +55,9 @@
|
|||||||
| `collection` | List\<[GetLibraryItemsCollection](../../models/operations/GetLibraryItemsCollection.md)> | :heavy_minus_sign: | N/A | |
|
| `collection` | List\<[GetLibraryItemsCollection](../../models/operations/GetLibraryItemsCollection.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `role` | List\<[GetLibraryItemsRole](../../models/operations/GetLibraryItemsRole.md)> | :heavy_minus_sign: | N/A | |
|
| `role` | List\<[GetLibraryItemsRole](../../models/operations/GetLibraryItemsRole.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `location` | List\<[GetLibraryItemsLocation](../../models/operations/GetLibraryItemsLocation.md)> | :heavy_minus_sign: | N/A | |
|
| `location` | List\<[GetLibraryItemsLocation](../../models/operations/GetLibraryItemsLocation.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `mediaGuid` | List\<[GetLibraryItemsMediaGuid](../../models/operations/GetLibraryItemsMediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
| `mediaGuid` | List\<[MediaGuid](../../models/operations/MediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||||
| `ultraBlurColors` | [Optional\<GetLibraryItemsUltraBlurColors>](../../models/operations/GetLibraryItemsUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
| `ultraBlurColors` | [Optional\<GetLibraryItemsUltraBlurColors>](../../models/operations/GetLibraryItemsUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `metaDataRating` | List\<[GetLibraryItemsMetaDataRating](../../models/operations/GetLibraryItemsMetaDataRating.md)> | :heavy_minus_sign: | N/A | |
|
| `metaDataRating` | List\<[MetaDataRating](../../models/operations/MetaDataRating.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `image` | List\<[GetLibraryItemsImage](../../models/operations/GetLibraryItemsImage.md)> | :heavy_minus_sign: | N/A | |
|
| `image` | List\<[GetLibraryItemsImage](../../models/operations/GetLibraryItemsImage.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `titleSort` | *Optional\<String>* | :heavy_minus_sign: | N/A | Whale |
|
| `titleSort` | *Optional\<String>* | :heavy_minus_sign: | N/A | Whale |
|
||||||
| `viewCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
| `viewCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# GetLibraryItemsQueryParamType
|
# GetLibraryItemsQueryParamType
|
||||||
|
|
||||||
The type of media to retrieve.
|
The type of media to retrieve or filter by.
|
||||||
1 = movie
|
1 = movie
|
||||||
2 = show
|
2 = show
|
||||||
3 = season
|
3 = season
|
||||||
@@ -12,9 +12,13 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
|||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------- | --------- |
|
| ------------ | ------------ |
|
||||||
| `Movie` | 1 |
|
| `Movie` | 1 |
|
||||||
| `TvShow` | 2 |
|
| `TvShow` | 2 |
|
||||||
| `Season` | 3 |
|
| `Season` | 3 |
|
||||||
| `Episode` | 4 |
|
| `Episode` | 4 |
|
||||||
| `Audio` | 8 |
|
| `Artist` | 5 |
|
||||||
|
| `Album` | 6 |
|
||||||
|
| `Track` | 7 |
|
||||||
|
| `PhotoAlbum` | 8 |
|
||||||
|
| `Photo` | 9 |
|
||||||
@@ -4,10 +4,10 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `tag` | [Tag](../../models/operations/Tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
| `tag` | [Tag](../../models/operations/Tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||||
| `includeGuids` | [Optional\<IncludeGuids>](../../models/operations/IncludeGuids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
| `includeGuids` | [Optional\<IncludeGuids>](../../models/operations/IncludeGuids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||||
| `type` | [Optional\<GetLibraryItemsQueryParamType>](../../models/operations/GetLibraryItemsQueryParamType.md) | :heavy_minus_sign: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
| `type` | [GetLibraryItemsQueryParamType](../../models/operations/GetLibraryItemsQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
| `includeMeta` | [Optional\<GetLibraryItemsQueryParamIncludeMeta>](../../models/operations/GetLibraryItemsQueryParamIncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
| `includeMeta` | [Optional\<GetLibraryItemsQueryParamIncludeMeta>](../../models/operations/GetLibraryItemsQueryParamIncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||||
| `xPlexContainerStart` | *Optional\<Integer>* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
| `xPlexContainerStart` | *Optional\<Integer>* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
||||||
|
|||||||
@@ -1,20 +0,0 @@
|
|||||||
# GetLibraryItemsShowOrdering
|
|
||||||
|
|
||||||
Setting that indicates the episode ordering for the show
|
|
||||||
None = Library default,
|
|
||||||
tmdbAiring = The Movie Database (Aired),
|
|
||||||
aired = TheTVDB (Aired),
|
|
||||||
dvd = TheTVDB (DVD),
|
|
||||||
absolute = TheTVDB (Absolute)).
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------ | ------------ |
|
|
||||||
| `None` | None |
|
|
||||||
| `TmdbAiring` | tmdbAiring |
|
|
||||||
| `Aired` | aired |
|
|
||||||
| `Dvd` | dvd |
|
|
||||||
| `Absolute` | absolute |
|
|
||||||
@@ -6,7 +6,8 @@
|
|||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||||
| `type` | *String* | :heavy_check_mark: | N/A | show |
|
| `type` | *String* | :heavy_check_mark: | N/A | filter |
|
||||||
|
| `subtype` | *Optional\<String>* | :heavy_minus_sign: | N/A | clip |
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | TV Shows |
|
| `title` | *String* | :heavy_check_mark: | N/A | TV Shows |
|
||||||
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||||
| `filter` | List\<[GetLibraryItemsFilter](../../models/operations/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |
|
| `filter` | List\<[GetLibraryItemsFilter](../../models/operations/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
|||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibrarySectionsAllActiveDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibrarySectionsAllCollection
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||||
8
docs/models/operations/GetLibrarySectionsAllCountry.md
Normal file
8
docs/models/operations/GetLibrarySectionsAllCountry.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibrarySectionsAllCountry
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibrarySectionsAllDefaultDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
8
docs/models/operations/GetLibrarySectionsAllDirector.md
Normal file
8
docs/models/operations/GetLibrarySectionsAllDirector.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibrarySectionsAllDirector
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||||
11
docs/models/operations/GetLibrarySectionsAllField.md
Normal file
11
docs/models/operations/GetLibrarySectionsAllField.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibrarySectionsAllField
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | N/A | show.title |
|
||||||
|
| `title` | *String* | :heavy_check_mark: | N/A | Show Title |
|
||||||
|
| `type` | *String* | :heavy_check_mark: | N/A | string |
|
||||||
|
| `subType` | *Optional\<String>* | :heavy_minus_sign: | N/A | rating |
|
||||||
9
docs/models/operations/GetLibrarySectionsAllFieldType.md
Normal file
9
docs/models/operations/GetLibrarySectionsAllFieldType.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibrarySectionsAllFieldType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||||
|
| `type` | *String* | :heavy_check_mark: | N/A | tag |
|
||||||
|
| `operator` | List\<[GetLibrarySectionsAllOperator](../../models/operations/GetLibrarySectionsAllOperator.md)> | :heavy_check_mark: | N/A | |
|
||||||
13
docs/models/operations/GetLibrarySectionsAllFilter.md
Normal file
13
docs/models/operations/GetLibrarySectionsAllFilter.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# GetLibrarySectionsAllFilter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | N/A | genre |
|
||||||
|
| `filterType` | *String* | :heavy_check_mark: | N/A | string |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||||
|
| `title` | *String* | :heavy_check_mark: | N/A | Genre |
|
||||||
|
| `type` | *String* | :heavy_check_mark: | N/A | filter |
|
||||||
|
| `advanced` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||||
8
docs/models/operations/GetLibrarySectionsAllGenre.md
Normal file
8
docs/models/operations/GetLibrarySectionsAllGenre.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibrarySectionsAllGenre
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||||
8
docs/models/operations/GetLibrarySectionsAllGuids.md
Normal file
8
docs/models/operations/GetLibrarySectionsAllGuids.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibrarySectionsAllGuids
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *String* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |
|
||||||
11
docs/models/operations/GetLibrarySectionsAllHasThumbnail.md
Normal file
11
docs/models/operations/GetLibrarySectionsAllHasThumbnail.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibrarySectionsAllHasThumbnail
|
||||||
|
|
||||||
|
Indicates if the part has a thumbnail.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------- | ------- |
|
||||||
|
| `False` | 0 |
|
||||||
|
| `True` | 1 |
|
||||||
10
docs/models/operations/GetLibrarySectionsAllImage.md
Normal file
10
docs/models/operations/GetLibrarySectionsAllImage.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibrarySectionsAllImage
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `alt` | *String* | :heavy_check_mark: | N/A | Episode 1 |
|
||||||
|
| `type` | [GetLibrarySectionsAllLibraryResponseType](../../models/operations/GetLibrarySectionsAllLibraryResponseType.md) | :heavy_check_mark: | N/A | background |
|
||||||
|
| `url` | *String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
# GetLibrarySectionsAllLibraryOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibrarySectionsAllLibraryResponseType
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| -------------- | -------------- |
|
||||||
|
| `COVER_POSTER` | coverPoster |
|
||||||
|
| `BACKGROUND` | background |
|
||||||
|
| `SNAPSHOT` | snapshot |
|
||||||
|
| `CLEAR_LOGO` | clearLogo |
|
||||||
20
docs/models/operations/GetLibrarySectionsAllLibraryType.md
Normal file
20
docs/models/operations/GetLibrarySectionsAllLibraryType.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# GetLibrarySectionsAllLibraryType
|
||||||
|
|
||||||
|
The type of media content in the Plex library. This can represent videos, music, or photos.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Movie` | movie |
|
||||||
|
| `TvShow` | show |
|
||||||
|
| `Season` | season |
|
||||||
|
| `Episode` | episode |
|
||||||
|
| `Artist` | artist |
|
||||||
|
| `Album` | album |
|
||||||
|
| `Track` | track |
|
||||||
|
| `PhotoAlbum` | photoalbum |
|
||||||
|
| `Photo` | photo |
|
||||||
|
| `Collection` | collection |
|
||||||
26
docs/models/operations/GetLibrarySectionsAllMedia.md
Normal file
26
docs/models/operations/GetLibrarySectionsAllMedia.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# GetLibrarySectionsAllMedia
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||||
|
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||||
|
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||||
|
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||||
|
| `height` | *Optional\<Integer>* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||||
|
| `aspectRatio` | *Optional\<Float>* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||||
|
| `audioChannels` | *Optional\<Integer>* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||||
|
| `displayOffset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 50 |
|
||||||
|
| `audioCodec` | *Optional\<String>* | :heavy_minus_sign: | Audio codec used. | eac3 |
|
||||||
|
| `videoCodec` | *Optional\<String>* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||||
|
| `videoResolution` | *Optional\<String>* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||||
|
| `container` | *Optional\<String>* | :heavy_minus_sign: | File container type. | mkv |
|
||||||
|
| `videoFrameRate` | *Optional\<String>* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||||
|
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||||
|
| `hasVoiceActivity` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||||
|
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
|
| `optimizedForStreaming` | [Optional\<GetLibrarySectionsAllOptimizedForStreaming>](../../models/operations/GetLibrarySectionsAllOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
|
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `part` | List\<[GetLibrarySectionsAllPart](../../models/operations/GetLibrarySectionsAllPart.md)> | :heavy_minus_sign: | An array of parts for this media item. | |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user