mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 20:47:45 +00:00
Compare commits
7 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
025b6c4640 | ||
|
|
2e4350c8c4 | ||
|
|
fa542f04e1 | ||
|
|
64bc159be2 | ||
|
|
8100bcbf96 | ||
|
|
10a61122c2 | ||
|
|
fbca010d26 |
File diff suppressed because one or more lines are too long
@@ -12,7 +12,7 @@ generation:
|
|||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
java:
|
java:
|
||||||
version: 0.4.1
|
version: 0.9.0
|
||||||
additionalDependencies: []
|
additionalDependencies: []
|
||||||
additionalPlugins: []
|
additionalPlugins: []
|
||||||
artifactID: plexapi
|
artifactID: plexapi
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
speakeasyVersion: 1.401.2
|
speakeasyVersion: 1.406.0
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
@@ -8,8 +8,8 @@ sources:
|
|||||||
- latest
|
- latest
|
||||||
plexapi:
|
plexapi:
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:fc6eebe661455e23b1aa352a91c14ef773fa72331330ec4caeddc2c460dc16bb
|
sourceRevisionDigest: sha256:790c7c67b0edef8c35ed69943d43e9c5bda385414c06f9c90410f93f546e5e4f
|
||||||
sourceBlobDigest: sha256:2e81e86c83d7f4e8842efca0d43a2db84a4932534c8439e3737e1f65c873f855
|
sourceBlobDigest: sha256:3e48471b7e058840fc598ccd75b2cbf8187961c7e625fe7b606555ce9a9bf109
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- main
|
- main
|
||||||
@@ -17,10 +17,10 @@ targets:
|
|||||||
plexjava:
|
plexjava:
|
||||||
source: plexapi
|
source: plexapi
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:fc6eebe661455e23b1aa352a91c14ef773fa72331330ec4caeddc2c460dc16bb
|
sourceRevisionDigest: sha256:790c7c67b0edef8c35ed69943d43e9c5bda385414c06f9c90410f93f546e5e4f
|
||||||
sourceBlobDigest: sha256:2e81e86c83d7f4e8842efca0d43a2db84a4932534c8439e3737e1f65c873f855
|
sourceBlobDigest: sha256:3e48471b7e058840fc598ccd75b2cbf8187961c7e625fe7b606555ce9a9bf109
|
||||||
codeSamplesNamespace: code-samples-java-plexjava
|
codeSamplesNamespace: code-samples-java-plexjava
|
||||||
codeSamplesRevisionDigest: sha256:0206006395b8e85b824f653a9a582e1949fe4f57636a54ea65105c11c0cc0018
|
codeSamplesRevisionDigest: sha256:1be6f3e64a42e2f5a878957fcaa19df7ee718649f6503954dad2c4a934e4eed3
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
|
|||||||
166
README.md
166
README.md
@@ -12,6 +12,31 @@
|
|||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
||||||
|
|
||||||
|
# Plex Media Server OpenAPI Specification
|
||||||
|
|
||||||
|
An Open Source OpenAPI Specification for Plex Media Server
|
||||||
|
|
||||||
|
Automation and SDKs provided by [Speakeasy](https://speakeasyapi.dev/)
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
[API Documentation](https://plexapi.dev)
|
||||||
|
|
||||||
|
## SDKs
|
||||||
|
|
||||||
|
The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the [main specification Repository](https://github.com/LukeHagar/plex-api-spec).
|
||||||
|
|
||||||
|
| Language | Repository | Releases | Other |
|
||||||
|
| --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
|
||||||
|
| Python | [GitHub](https://github.com/LukeHagar/plexpy) | [PyPI](https://pypi.org/project/plex-api-client/) | - |
|
||||||
|
| JavaScript/TypeScript | [GitHub](https://github.com/LukeHagar/plexjs) | [NPM](https://www.npmjs.com/package/@lukehagar/plexjs) \ [JSR](https://jsr.io/@lukehagar/plexjs) | - |
|
||||||
|
| Go | [GitHub](https://github.com/LukeHagar/plexgo) | [Releases](https://github.com/LukeHagar/plexgo/releases) | [GoDoc](https://pkg.go.dev/github.com/LukeHagar/plexgo) |
|
||||||
|
| Ruby | [GitHub](https://github.com/LukeHagar/plexruby) | [Releases](https://github.com/LukeHagar/plexruby/releases) | - |
|
||||||
|
| Swift | [GitHub](https://github.com/LukeHagar/plexswift) | [Releases](https://github.com/LukeHagar/plexswift/releases) | - |
|
||||||
|
| PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - |
|
||||||
|
| Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - |
|
||||||
|
| C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -
|
||||||
<!-- End Summary [summary] -->
|
<!-- End Summary [summary] -->
|
||||||
|
|
||||||
<!-- Start Table of Contents [toc] -->
|
<!-- Start Table of Contents [toc] -->
|
||||||
@@ -20,7 +45,6 @@ Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
|||||||
* [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)
|
||||||
* [Global Parameters](#global-parameters)
|
|
||||||
* [Error Handling](#error-handling)
|
* [Error Handling](#error-handling)
|
||||||
* [Server Selection](#server-selection)
|
* [Server Selection](#server-selection)
|
||||||
* [Authentication](#authentication)
|
* [Authentication](#authentication)
|
||||||
@@ -37,7 +61,7 @@ The samples below show how a published SDK artifact is used:
|
|||||||
|
|
||||||
Gradle:
|
Gradle:
|
||||||
```groovy
|
```groovy
|
||||||
implementation 'dev.plexapi:plexapi:0.4.1'
|
implementation 'dev.plexapi:plexapi:0.9.0'
|
||||||
```
|
```
|
||||||
|
|
||||||
Maven:
|
Maven:
|
||||||
@@ -45,7 +69,7 @@ Maven:
|
|||||||
<dependency>
|
<dependency>
|
||||||
<groupId>dev.plexapi</groupId>
|
<groupId>dev.plexapi</groupId>
|
||||||
<artifactId>plexapi</artifactId>
|
<artifactId>plexapi</artifactId>
|
||||||
<version>0.4.1</version>
|
<version>0.9.0</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -84,11 +108,11 @@ public class Application {
|
|||||||
|
|
||||||
PlexAPI sdk = PlexAPI.builder()
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||||
.clientName("Plex Web")
|
.clientName("Plex for Roku")
|
||||||
.clientVersion("4.133.0")
|
.clientVersion("2.4.1")
|
||||||
.clientPlatform("Chrome")
|
.platform("Roku")
|
||||||
.deviceName("Linux")
|
.deviceNickname("Roku 3")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
@@ -131,18 +155,20 @@ public class Application {
|
|||||||
### [hubs()](docs/sdks/hubs/README.md)
|
### [hubs()](docs/sdks/hubs/README.md)
|
||||||
|
|
||||||
* [getGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
|
* [getGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
|
||||||
|
* [getRecentlyAdded](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
|
||||||
* [getLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
* [getLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
||||||
|
|
||||||
### [library()](docs/sdks/library/README.md)
|
### [library()](docs/sdks/library/README.md)
|
||||||
|
|
||||||
* [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
* [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||||
* [getRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded) - Get Recently Added
|
* [getRecentlyAddedLibrary](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
|
||||||
* [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
* [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
||||||
* [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
|
||||||
* [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
|
||||||
|
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||||
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
||||||
* [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
|
||||||
@@ -234,78 +260,18 @@ public class Application {
|
|||||||
</details>
|
</details>
|
||||||
<!-- End Available Resources and Operations [operations] -->
|
<!-- End Available Resources and Operations [operations] -->
|
||||||
|
|
||||||
<!-- Start Global Parameters [global-parameters] -->
|
|
||||||
## Global Parameters
|
|
||||||
|
|
||||||
Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed.
|
|
||||||
|
|
||||||
For example, you can set `ClientID` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getPin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
|
||||||
|
|
||||||
|
|
||||||
### Available Globals
|
|
||||||
|
|
||||||
The following global parameters are available.
|
|
||||||
|
|
||||||
| Name | Type | Required | Description |
|
|
||||||
| ---- | ---- |:--------:| ----------- |
|
|
||||||
| clientID | java.lang.String | | The unique identifier for the client application
|
|
||||||
This is used to track the client application and its usage
|
|
||||||
(UUID, serial number, or other number unique per device)
|
|
||||||
|
|
|
||||||
| clientName | java.lang.String | | The clientName parameter. |
|
|
||||||
| clientVersion | java.lang.String | | The clientVersion parameter. |
|
|
||||||
| clientPlatform | java.lang.String | | The clientPlatform parameter. |
|
|
||||||
| deviceName | java.lang.String | | The deviceName parameter. |
|
|
||||||
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
```java
|
|
||||||
package hello.world;
|
|
||||||
|
|
||||||
import dev.plexapi.sdk.PlexAPI;
|
|
||||||
import dev.plexapi.sdk.models.errors.GetPinBadRequest;
|
|
||||||
import dev.plexapi.sdk.models.operations.GetPinRequest;
|
|
||||||
import dev.plexapi.sdk.models.operations.GetPinResponse;
|
|
||||||
import java.lang.Exception;
|
|
||||||
|
|
||||||
public class Application {
|
|
||||||
|
|
||||||
public static void main(String[] args) throws GetPinBadRequest, Exception {
|
|
||||||
|
|
||||||
PlexAPI sdk = PlexAPI.builder()
|
|
||||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
|
||||||
.clientName("Plex Web")
|
|
||||||
.clientVersion("4.133.0")
|
|
||||||
.clientPlatform("Chrome")
|
|
||||||
.deviceName("Linux")
|
|
||||||
.build();
|
|
||||||
|
|
||||||
GetPinRequest req = GetPinRequest.builder()
|
|
||||||
.build();
|
|
||||||
|
|
||||||
GetPinResponse res = sdk.plex().getPin()
|
|
||||||
.request(req)
|
|
||||||
.call();
|
|
||||||
|
|
||||||
if (res.authPinContainer().isPresent()) {
|
|
||||||
// handle response
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
<!-- End Global Parameters [global-parameters] -->
|
|
||||||
|
|
||||||
<!-- Start Error Handling [errors] -->
|
<!-- Start Error Handling [errors] -->
|
||||||
## Error Handling
|
## Error Handling
|
||||||
|
|
||||||
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Exception type.
|
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
|
||||||
|
|
||||||
| Error Object | Status Code | Content Type |
|
By default, an API error will throw a `models/errors/SDKError` exception. When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `getServerCapabilities` method throws the following exceptions:
|
||||||
|
|
||||||
|
| Error Type | Status Code | Content Type |
|
||||||
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
|
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
|
||||||
| models/errors/GetServerCapabilitiesBadRequest | 400 | application/json |
|
| models/errors/GetServerCapabilitiesBadRequest | 400 | application/json |
|
||||||
| models/errors/GetServerCapabilitiesUnauthorized | 401 | application/json |
|
| models/errors/GetServerCapabilitiesUnauthorized | 401 | application/json |
|
||||||
| models/errors/SDKError | 4xx-5xx | \*\/* |
|
| models/errors/SDKError | 4XX, 5XX | \*/\* |
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
|
||||||
@@ -324,11 +290,11 @@ public class Application {
|
|||||||
|
|
||||||
PlexAPI sdk = PlexAPI.builder()
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||||
.clientName("Plex Web")
|
.clientName("Plex for Roku")
|
||||||
.clientVersion("4.133.0")
|
.clientVersion("2.4.1")
|
||||||
.clientPlatform("Chrome")
|
.platform("Roku")
|
||||||
.deviceName("Linux")
|
.deviceNickname("Roku 3")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
@@ -371,11 +337,11 @@ public class Application {
|
|||||||
PlexAPI sdk = PlexAPI.builder()
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
.serverIndex(0)
|
.serverIndex(0)
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||||
.clientName("Plex Web")
|
.clientName("Plex for Roku")
|
||||||
.clientVersion("4.133.0")
|
.clientVersion("2.4.1")
|
||||||
.clientPlatform("Chrome")
|
.platform("Roku")
|
||||||
.deviceName("Linux")
|
.deviceNickname("Roku 3")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
@@ -414,11 +380,11 @@ public class Application {
|
|||||||
PlexAPI sdk = PlexAPI.builder()
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
.serverURL("{protocol}://{ip}:{port}")
|
.serverURL("{protocol}://{ip}:{port}")
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||||
.clientName("Plex Web")
|
.clientName("Plex for Roku")
|
||||||
.clientVersion("4.133.0")
|
.clientVersion("2.4.1")
|
||||||
.clientPlatform("Chrome")
|
.platform("Roku")
|
||||||
.deviceName("Linux")
|
.deviceNickname("Roku 3")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
@@ -449,15 +415,15 @@ public class Application {
|
|||||||
|
|
||||||
PlexAPI sdk = PlexAPI.builder()
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||||
.clientName("Plex Web")
|
.clientName("Plex for Roku")
|
||||||
.clientVersion("4.133.0")
|
.clientVersion("2.4.1")
|
||||||
.clientPlatform("Chrome")
|
.platform("Roku")
|
||||||
.deviceName("Linux")
|
.deviceNickname("Roku 3")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetCompanionsDataResponse res = sdk.plex().getCompanionsData()
|
GetCompanionsDataResponse res = sdk.plex().getCompanionsData()
|
||||||
.serverURL("https://plex.tv/api/v2/")
|
.serverURL("https://plex.tv/api/v2")
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
if (res.responseBodies().isPresent()) {
|
if (res.responseBodies().isPresent()) {
|
||||||
@@ -495,11 +461,11 @@ public class Application {
|
|||||||
|
|
||||||
PlexAPI sdk = PlexAPI.builder()
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||||
.clientName("Plex Web")
|
.clientName("Plex for Roku")
|
||||||
.clientVersion("4.133.0")
|
.clientVersion("2.4.1")
|
||||||
.clientPlatform("Chrome")
|
.platform("Roku")
|
||||||
.deviceName("Linux")
|
.deviceNickname("Roku 3")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
|
|||||||
70
RELEASES.md
70
RELEASES.md
@@ -89,3 +89,73 @@ Based on:
|
|||||||
- [java v0.4.1] .
|
- [java v0.4.1] .
|
||||||
### Releases
|
### Releases
|
||||||
- [Maven Central v0.4.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.4.1 - .
|
- [Maven Central v0.4.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.4.1 - .
|
||||||
|
|
||||||
|
## 2024-09-26 00:25:07
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.402.14 (2.422.22) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.5.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.5.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.5.0 - .
|
||||||
|
|
||||||
|
## 2024-09-28 00:25:08
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.404.5 (2.426.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.6.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.6.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.6.0 - .
|
||||||
|
|
||||||
|
## 2024-09-29 00:28:35
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.404.5 (2.426.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.6.1] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.6.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.6.1 - .
|
||||||
|
|
||||||
|
## 2024-09-30 00:26:54
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.404.5 (2.426.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.6.2] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.6.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.6.2 - .
|
||||||
|
|
||||||
|
## 2024-10-01 00:28:45
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.7.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.7.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.7.0 - .
|
||||||
|
|
||||||
|
## 2024-10-03 00:26:50
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.8.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.8.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.8.0 - .
|
||||||
|
|
||||||
|
## 2024-10-04 00:25:27
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.9.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.9.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.9.0 - .
|
||||||
10
USAGE.md
10
USAGE.md
@@ -14,11 +14,11 @@ public class Application {
|
|||||||
|
|
||||||
PlexAPI sdk = PlexAPI.builder()
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||||
.clientName("Plex Web")
|
.clientName("Plex for Roku")
|
||||||
.clientVersion("4.133.0")
|
.clientVersion("2.4.1")
|
||||||
.clientPlatform("Chrome")
|
.platform("Roku")
|
||||||
.deviceName("Linux")
|
.deviceNickname("Roku 3")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
|
|||||||
@@ -63,7 +63,7 @@ tasks.withType(Javadoc) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
group = "dev.plexapi"
|
group = "dev.plexapi"
|
||||||
version = "0.4.1"
|
version = "0.9.0"
|
||||||
|
|
||||||
sourcesJar {
|
sourcesJar {
|
||||||
archiveBaseName = "plexapi"
|
archiveBaseName = "plexapi"
|
||||||
@@ -101,7 +101,7 @@ publishing {
|
|||||||
maven(MavenPublication) {
|
maven(MavenPublication) {
|
||||||
groupId = 'dev.plexapi'
|
groupId = 'dev.plexapi'
|
||||||
artifactId = 'plexapi'
|
artifactId = 'plexapi'
|
||||||
version = '0.4.1'
|
version = '0.9.0'
|
||||||
|
|
||||||
from components.java
|
from components.java
|
||||||
|
|
||||||
|
|||||||
913
codeSamples.yaml
913
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
@@ -1,6 +1,6 @@
|
|||||||
# GetRecentlyAddedUnauthorized
|
# GetRecentlyAddedLibraryBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -4,7 +4,7 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *Optional<String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *Optional<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/models/errors/GetRecentlyAddedLibraryLibraryErrors.md
Normal file
10
docs/models/errors/GetRecentlyAddedLibraryLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetRecentlyAddedLibraryLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## 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/GetRecentlyAddedLibraryUnauthorized.md
Normal file
11
docs/models/errors/GetRecentlyAddedLibraryUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetRecentlyAddedLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | List<[GetRecentlyAddedLibraryLibraryErrors](../../models/errors/GetRecentlyAddedLibraryLibraryErrors.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 @@
|
|||||||
# GetRecentlyAddedBadRequest
|
# GetSearchAllLibrariesBadRequest
|
||||||
|
|
||||||
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<[GetRecentlyAddedErrors](../../models/errors/GetRecentlyAddedErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | List<[GetSearchAllLibrariesErrors](../../models/errors/GetSearchAllLibrariesErrors.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 @@
|
|||||||
# GetRecentlyAddedErrors
|
# GetSearchAllLibrariesErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
10
docs/models/errors/GetSearchAllLibrariesLibraryErrors.md
Normal file
10
docs/models/errors/GetSearchAllLibrariesLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetSearchAllLibrariesLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## 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/GetSearchAllLibrariesUnauthorized.md
Normal file
11
docs/models/errors/GetSearchAllLibrariesUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetSearchAllLibrariesUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | List<[GetSearchAllLibrariesLibraryErrors](../../models/errors/GetSearchAllLibrariesLibraryErrors.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 |
|
||||||
@@ -3,12 +3,12 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
| `protocol` | [Protocol](../../models/operations/Protocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) |
|
| `protocol` | [Protocol](../../models/operations/Protocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) | http |
|
||||||
| `address` | *String* | :heavy_check_mark: | The (ip) address or domain name used for the connection |
|
| `address` | *String* | :heavy_check_mark: | The (ip) address or domain name used for the connection | |
|
||||||
| `port` | *int* | :heavy_check_mark: | The port used for the connection |
|
| `port` | *int* | :heavy_check_mark: | The port used for the connection | |
|
||||||
| `uri` | *String* | :heavy_check_mark: | The full URI of the connection |
|
| `uri` | *String* | :heavy_check_mark: | The full URI of the connection | |
|
||||||
| `local` | *boolean* | :heavy_check_mark: | If the connection is local address |
|
| `local` | *boolean* | :heavy_check_mark: | If the connection is local address | |
|
||||||
| `relay` | *boolean* | :heavy_check_mark: | If the connection is relayed through plex.direct |
|
| `relay` | *boolean* | :heavy_check_mark: | If the connection is relayed through plex.direct | |
|
||||||
| `iPv6` | *boolean* | :heavy_check_mark: | If the connection is using IPv6 |
|
| `iPv6` | *boolean* | :heavy_check_mark: | If the connection is using IPv6 | |
|
||||||
@@ -5,4 +5,4 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Peyton Reed |
|
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | James Cameron |
|
||||||
@@ -1,66 +0,0 @@
|
|||||||
# Features
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ----------------------------------------- | ----------------------------------------- |
|
|
||||||
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
|
|
||||||
| `ANDROID_PI_P` | Android - PiP |
|
|
||||||
| `CU_SUNSET` | CU Sunset |
|
|
||||||
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
|
|
||||||
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
|
|
||||||
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
|
|
||||||
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
|
|
||||||
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
|
|
||||||
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
|
|
||||||
| `AVOD_NEW_MEDIA` | avod-new-media |
|
|
||||||
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
|
|
||||||
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
|
|
||||||
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
|
|
||||||
| `COLLECTIONS` | collections |
|
|
||||||
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
|
|
||||||
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
|
|
||||||
| `COMPANIONS_SONOS` | companions_sonos |
|
|
||||||
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
|
|
||||||
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
|
|
||||||
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
|
|
||||||
| `DRM_SUPPORT` | drm_support |
|
|
||||||
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
|
|
||||||
| `FEDERATED_AUTH` | federated-auth |
|
|
||||||
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
|
|
||||||
| `GUIDED_UPGRADE` | guided-upgrade |
|
|
||||||
| `HOME` | home |
|
|
||||||
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
|
|
||||||
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
|
|
||||||
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
|
|
||||||
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
|
|
||||||
| `KEVIN_BACON` | kevin-bacon |
|
|
||||||
| `KOREA_CONSENT` | korea-consent |
|
|
||||||
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
|
|
||||||
| `LETS_ENCRYPT` | lets_encrypt |
|
|
||||||
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
|
|
||||||
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
|
|
||||||
| `LIVETV` | livetv |
|
|
||||||
| `METADATA_SEARCH` | metadata_search |
|
|
||||||
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
|
|
||||||
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
|
|
||||||
| `PHOTOS_FAVORITES` | photos-favorites |
|
|
||||||
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
|
|
||||||
| `PMS_HEALTH` | pms_health |
|
|
||||||
| `RADIO` | radio |
|
|
||||||
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
|
|
||||||
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
|
|
||||||
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
|
|
||||||
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
|
|
||||||
| `SIGNIN_WITH_APPLE` | signin_with_apple |
|
|
||||||
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
|
|
||||||
| `TRANSCODER_CACHE` | transcoder_cache |
|
|
||||||
| `TUNER_SHARING` | tuner-sharing |
|
|
||||||
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
|
|
||||||
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
|
|
||||||
| `UPGRADE3DS2` | upgrade-3ds2 |
|
|
||||||
| `VOD_SCHEMA` | vod-schema |
|
|
||||||
| `VOD_CLOUDFLARE` | vod_cloudflare |
|
|
||||||
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
|
|
||||||
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |
|
|
||||||
@@ -5,7 +5,7 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | label |
|
| `key` | *String* | :heavy_check_mark: | N/A | show.title |
|
||||||
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Label |
|
| `title` | *String* | :heavy_check_mark: | N/A | Show Title |
|
||||||
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | tag |
|
| `type` | *String* | :heavy_check_mark: | N/A | string |
|
||||||
| `subType` | *Optional<String>* | :heavy_minus_sign: | N/A | bitrate |
|
| `subType` | *Optional<String>* | :heavy_minus_sign: | N/A | rating |
|
||||||
@@ -5,5 +5,5 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||||
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | resolution |
|
| `type` | *String* | :heavy_check_mark: | N/A | tag |
|
||||||
| `operator` | List<[Operator](../../models/operations/Operator.md)> | :heavy_minus_sign: | N/A | |
|
| `operator` | List<[Operator](../../models/operations/Operator.md)> | :heavy_check_mark: | N/A | |
|
||||||
@@ -5,4 +5,4 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Comedy |
|
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Adventure |
|
||||||
@@ -4,7 +4,7 @@
|
|||||||
## 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: | N/A | true |
|
||||||
| `art` | *String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
| `art` | *String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||||
| `composite` | *String* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
|
| `composite` | *String* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
|
||||||
@@ -23,6 +23,6 @@
|
|||||||
| `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: | N/A | true |
|
||||||
| `directory` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `directory` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||||
| `contentChangedAt` | *int* | :heavy_check_mark: | N/A | 3192854 |
|
| `contentChangedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `hidden` | *int* | :heavy_check_mark: | N/A | 0 |
|
| `hidden` | *int* | :heavy_check_mark: | N/A | 0 |
|
||||||
| `location` | List<[Location](../../models/operations/Location.md)> | :heavy_check_mark: | N/A | |
|
| `location` | List<[GetAllLibrariesLocation](../../models/operations/GetAllLibrariesLocation.md)> | :heavy_check_mark: | N/A | |
|
||||||
9
docs/models/operations/GetAllLibrariesLocation.md
Normal file
9
docs/models/operations/GetAllLibrariesLocation.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetAllLibrariesLocation
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *int* | :heavy_check_mark: | N/A | 1 |
|
||||||
|
| `path` | *String* | :heavy_check_mark: | N/A | /movies |
|
||||||
@@ -10,4 +10,4 @@
|
|||||||
| `height` | *long* | :heavy_check_mark: | N/A | 396 |
|
| `height` | *long* | :heavy_check_mark: | N/A | 396 |
|
||||||
| `minSize` | *long* | :heavy_check_mark: | N/A | 1 |
|
| `minSize` | *long* | :heavy_check_mark: | N/A | 1 |
|
||||||
| `upscale` | *long* | :heavy_check_mark: | N/A | 1 |
|
| `upscale` | *long* | :heavy_check_mark: | N/A | 1 |
|
||||||
| `xPlexToken` | *String* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
|
| `xPlexToken` | *String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
|
||||||
11
docs/models/operations/GetLibraryDetailsField.md
Normal file
11
docs/models/operations/GetLibraryDetailsField.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibraryDetailsField
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | label |
|
||||||
|
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Label |
|
||||||
|
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | tag |
|
||||||
|
| `subType` | *Optional<String>* | :heavy_minus_sign: | N/A | bitrate |
|
||||||
9
docs/models/operations/GetLibraryDetailsFieldType.md
Normal file
9
docs/models/operations/GetLibraryDetailsFieldType.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibraryDetailsFieldType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||||
|
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | resolution |
|
||||||
|
| `operator` | List<[GetLibraryDetailsOperator](../../models/operations/GetLibraryDetailsOperator.md)> | :heavy_minus_sign: | N/A | |
|
||||||
@@ -19,4 +19,4 @@
|
|||||||
| `viewMode` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 65592 |
|
| `viewMode` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 65592 |
|
||||||
| `directory` | List<[GetLibraryDetailsDirectory](../../models/operations/GetLibraryDetailsDirectory.md)> | :heavy_minus_sign: | N/A | |
|
| `directory` | List<[GetLibraryDetailsDirectory](../../models/operations/GetLibraryDetailsDirectory.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `type` | List<[GetLibraryDetailsType](../../models/operations/GetLibraryDetailsType.md)> | :heavy_minus_sign: | N/A | |
|
| `type` | List<[GetLibraryDetailsType](../../models/operations/GetLibraryDetailsType.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `fieldType` | List<[FieldType](../../models/operations/FieldType.md)> | :heavy_minus_sign: | N/A | |
|
| `fieldType` | List<[GetLibraryDetailsFieldType](../../models/operations/GetLibraryDetailsFieldType.md)> | :heavy_minus_sign: | N/A | |
|
||||||
9
docs/models/operations/GetLibraryDetailsOperator.md
Normal file
9
docs/models/operations/GetLibraryDetailsOperator.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibraryDetailsOperator
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | = |
|
||||||
|
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | is |
|
||||||
@@ -5,5 +5,5 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| 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 |
|
|
||||||
| `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 |
|
||||||
13
docs/models/operations/GetLibraryDetailsSort.md
Normal file
13
docs/models/operations/GetLibraryDetailsSort.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# GetLibraryDetailsSort
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||||
|
| `default_` | *Optional<String>* | :heavy_minus_sign: | N/A | asc |
|
||||||
|
| `defaultDirection` | *Optional<String>* | :heavy_minus_sign: | N/A | desc |
|
||||||
|
| `descKey` | *Optional<String>* | :heavy_minus_sign: | N/A | random:desc |
|
||||||
|
| `firstCharacterKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/sections/1/firstCharacter |
|
||||||
|
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | random |
|
||||||
|
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Randomly |
|
||||||
@@ -10,5 +10,5 @@
|
|||||||
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Movies |
|
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Movies |
|
||||||
| `active` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `active` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
| `filter` | List<[GetLibraryDetailsFilter](../../models/operations/GetLibraryDetailsFilter.md)> | :heavy_minus_sign: | N/A | |
|
| `filter` | List<[GetLibraryDetailsFilter](../../models/operations/GetLibraryDetailsFilter.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `sort` | List<[Sort](../../models/operations/Sort.md)> | :heavy_minus_sign: | N/A | |
|
| `sort` | List<[GetLibraryDetailsSort](../../models/operations/GetLibraryDetailsSort.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `field` | List<[Field](../../models/operations/Field.md)> | :heavy_minus_sign: | N/A | |
|
| `field` | List<[GetLibraryDetailsField](../../models/operations/GetLibraryDetailsField.md)> | :heavy_minus_sign: | N/A | |
|
||||||
12
docs/models/operations/GetLibraryItemsActiveDirection.md
Normal file
12
docs/models/operations/GetLibraryItemsActiveDirection.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibraryItemsActiveDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
8
docs/models/operations/GetLibraryItemsCollection.md
Normal file
8
docs/models/operations/GetLibraryItemsCollection.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibraryItemsCollection
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||||
12
docs/models/operations/GetLibraryItemsDefaultDirection.md
Normal file
12
docs/models/operations/GetLibraryItemsDefaultDirection.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibraryItemsDefaultDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
9
docs/models/operations/GetLibraryItemsFlattenSeasons.md
Normal file
9
docs/models/operations/GetLibraryItemsFlattenSeasons.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibraryItemsFlattenSeasons
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------- | ------- |
|
||||||
|
| `False` | 0 |
|
||||||
|
| `True` | 1 |
|
||||||
9
docs/models/operations/GetLibraryItemsHasThumbnail.md
Normal file
9
docs/models/operations/GetLibraryItemsHasThumbnail.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibraryItemsHasThumbnail
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------- | ------- |
|
||||||
|
| `False` | 0 |
|
||||||
|
| `True` | 1 |
|
||||||
@@ -4,7 +4,7 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||||
| `alt` | *String* | :heavy_check_mark: | N/A | Episode 1 |
|
| `alt` | *String* | :heavy_check_mark: | N/A | Episode 1 |
|
||||||
| `type` | [GetLibraryItemsLibraryResponseType](../../models/operations/GetLibraryItemsLibraryResponseType.md) | :heavy_check_mark: | N/A | background |
|
| `type` | [GetLibraryItemsLibraryResponse200Type](../../models/operations/GetLibraryItemsLibraryResponse200Type.md) | :heavy_check_mark: | N/A | background |
|
||||||
| `url` | *String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
| `url` | *String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibraryItemsLibraryActiveDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibraryItemsLibraryDefaultDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
11
docs/models/operations/GetLibraryItemsLibraryField.md
Normal file
11
docs/models/operations/GetLibraryItemsLibraryField.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibraryItemsLibraryField
|
||||||
|
|
||||||
|
|
||||||
|
## 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 |
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibraryItemsLibraryFieldType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||||
|
| `type` | *String* | :heavy_check_mark: | N/A | tag |
|
||||||
|
| `operator` | List<[GetLibraryItemsLibraryOperator](../../models/operations/GetLibraryItemsLibraryOperator.md)> | :heavy_check_mark: | N/A | |
|
||||||
12
docs/models/operations/GetLibraryItemsLibraryFilter.md
Normal file
12
docs/models/operations/GetLibraryItemsLibraryFilter.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibraryItemsLibraryFilter
|
||||||
|
|
||||||
|
|
||||||
|
## 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 |
|
||||||
9
docs/models/operations/GetLibraryItemsLibraryOperator.md
Normal file
9
docs/models/operations/GetLibraryItemsLibraryOperator.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibraryItemsLibraryOperator
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | N/A | = |
|
||||||
|
| `title` | *String* | :heavy_check_mark: | N/A | is |
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibraryItemsLibraryResponse200Type
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| -------------- | -------------- |
|
||||||
|
| `COVER_POSTER` | coverPoster |
|
||||||
|
| `BACKGROUND` | background |
|
||||||
|
| `SNAPSHOT` | snapshot |
|
||||||
|
| `CLEAR_LOGO` | clearLogo |
|
||||||
@@ -1,11 +1,14 @@
|
|||||||
# GetLibraryItemsLibraryResponseType
|
# GetLibraryItemsLibraryResponseType
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Fields
|
||||||
|
|
||||||
| Name | Value |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------- | -------------- |
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
| `COVER_POSTER` | coverPoster |
|
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||||
| `BACKGROUND` | background |
|
| `type` | *String* | :heavy_check_mark: | N/A | show |
|
||||||
| `SNAPSHOT` | snapshot |
|
| `title` | *String* | :heavy_check_mark: | N/A | TV Shows |
|
||||||
| `CLEAR_LOGO` | clearLogo |
|
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||||
|
| `filter` | List<[GetLibraryItemsLibraryFilter](../../models/operations/GetLibraryItemsLibraryFilter.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `sort` | List<[GetLibraryItemsLibrarySort](../../models/operations/GetLibraryItemsLibrarySort.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `field` | List<[GetLibraryItemsLibraryField](../../models/operations/GetLibraryItemsLibraryField.md)> | :heavy_minus_sign: | N/A | |
|
||||||
15
docs/models/operations/GetLibraryItemsLibrarySort.md
Normal file
15
docs/models/operations/GetLibraryItemsLibrarySort.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# GetLibraryItemsLibrarySort
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `default_` | *Optional<String>* | :heavy_minus_sign: | N/A | asc |
|
||||||
|
| `active` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `activeDirection` | [Optional<GetLibraryItemsLibraryActiveDirection>](../../models/operations/GetLibraryItemsLibraryActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||||
|
| `defaultDirection` | [Optional<GetLibraryItemsLibraryDefaultDirection>](../../models/operations/GetLibraryItemsLibraryDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||||
|
| `descKey` | *Optional<String>* | :heavy_minus_sign: | N/A | titleSort:desc |
|
||||||
|
| `firstCharacterKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | N/A | titleSort |
|
||||||
|
| `title` | *String* | :heavy_check_mark: | N/A | Title |
|
||||||
@@ -1,14 +1,14 @@
|
|||||||
# GetLibraryItemsLibraryType
|
# GetLibraryItemsLibraryType
|
||||||
|
|
||||||
|
The type of media content
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
## Values
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
|
||||||
| `type` | *String* | :heavy_check_mark: | N/A | show |
|
| Name | Value |
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | TV Shows |
|
| --------- | --------- |
|
||||||
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `Movie` | movie |
|
||||||
| `filter` | List<[GetLibraryItemsFilter](../../models/operations/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |
|
| `TvShow` | show |
|
||||||
| `sort` | List<[GetLibraryItemsSort](../../models/operations/GetLibraryItemsSort.md)> | :heavy_minus_sign: | N/A | |
|
| `Season` | season |
|
||||||
| `field` | List<[GetLibraryItemsField](../../models/operations/GetLibraryItemsField.md)> | :heavy_minus_sign: | N/A | |
|
| `Episode` | episode |
|
||||||
8
docs/models/operations/GetLibraryItemsLocation.md
Normal file
8
docs/models/operations/GetLibraryItemsLocation.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibraryItemsLocation
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `path` | *Optional<String>* | :heavy_minus_sign: | N/A | /TV Shows/House |
|
||||||
@@ -4,20 +4,22 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
|
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
|
||||||
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
|
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
||||||
| `bitrate` | *int* | :heavy_check_mark: | N/A | 25025 |
|
| `bitrate` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 25025 |
|
||||||
| `width` | *int* | :heavy_check_mark: | N/A | 3840 |
|
| `width` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 3840 |
|
||||||
| `height` | *int* | :heavy_check_mark: | N/A | 2072 |
|
| `height` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2072 |
|
||||||
| `aspectRatio` | *double* | :heavy_check_mark: | N/A | 1.85 |
|
| `aspectRatio` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1.85 |
|
||||||
| `audioProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | dts |
|
| `audioProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | dts |
|
||||||
| `audioChannels` | *int* | :heavy_check_mark: | N/A | 6 |
|
| `audioChannels` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 6 |
|
||||||
| `audioCodec` | *String* | :heavy_check_mark: | N/A | eac3 |
|
| `audioCodec` | *Optional<String>* | :heavy_minus_sign: | N/A | eac3 |
|
||||||
| `videoCodec` | *String* | :heavy_check_mark: | N/A | hevc |
|
| `videoCodec` | *Optional<String>* | :heavy_minus_sign: | N/A | hevc |
|
||||||
| `videoResolution` | *String* | :heavy_check_mark: | N/A | 4k |
|
| `videoResolution` | *Optional<String>* | :heavy_minus_sign: | N/A | 4k |
|
||||||
| `container` | *String* | :heavy_check_mark: | N/A | mkv |
|
| `container` | *String* | :heavy_check_mark: | N/A | mkv |
|
||||||
| `videoFrameRate` | *String* | :heavy_check_mark: | N/A | 24p |
|
| `videoFrameRate` | *Optional<String>* | :heavy_minus_sign: | N/A | 24p |
|
||||||
| `videoProfile` | *String* | :heavy_check_mark: | N/A | main 10 |
|
| `videoProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | main 10 |
|
||||||
| `hasVoiceActivity` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `hasVoiceActivity` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `optimizedForStreaming` | [Optional<GetLibraryItemsOptimizedForStreaming>](../../models/operations/GetLibraryItemsOptimizedForStreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `has64bitOffsets` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
| `part` | List<[GetLibraryItemsPart](../../models/operations/GetLibraryItemsPart.md)> | :heavy_check_mark: | N/A | |
|
| `part` | List<[GetLibraryItemsPart](../../models/operations/GetLibraryItemsPart.md)> | :heavy_check_mark: | N/A | |
|
||||||
@@ -1,10 +1,15 @@
|
|||||||
# GetLibraryItemsMediaContainer
|
# GetLibraryItemsMediaContainer
|
||||||
|
|
||||||
|
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||||
|
| `type` | List<[GetLibraryItemsType](../../models/operations/GetLibraryItemsType.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `fieldType` | List<[GetLibraryItemsFieldType](../../models/operations/GetLibraryItemsFieldType.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `size` | *int* | :heavy_check_mark: | N/A | 70 |
|
| `size` | *int* | :heavy_check_mark: | N/A | 70 |
|
||||||
| `totalSize` | *int* | :heavy_check_mark: | N/A | 170 |
|
| `totalSize` | *int* | :heavy_check_mark: | N/A | 170 |
|
||||||
| `offset` | *int* | :heavy_check_mark: | N/A | 0 |
|
| `offset` | *int* | :heavy_check_mark: | N/A | 0 |
|
||||||
@@ -13,7 +18,7 @@
|
|||||||
| `nocache` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
|
| `nocache` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||||
| `art` | *String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
| `art` | *String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||||
| `identifier` | *String* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
| `identifier` | *String* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
||||||
| `librarySectionID` | [LibrarySectionID](../../models/operations/LibrarySectionID.md) | :heavy_check_mark: | N/A | |
|
| `librarySectionID` | *long* | :heavy_check_mark: | N/A | 1 |
|
||||||
| `librarySectionTitle` | *String* | :heavy_check_mark: | N/A | Movies |
|
| `librarySectionTitle` | *String* | :heavy_check_mark: | N/A | Movies |
|
||||||
| `librarySectionUUID` | *String* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
| `librarySectionUUID` | *String* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||||
| `mediaTagPrefix` | *String* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
| `mediaTagPrefix` | *String* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
||||||
@@ -24,5 +29,5 @@
|
|||||||
| `viewGroup` | *String* | :heavy_check_mark: | N/A | movie |
|
| `viewGroup` | *String* | :heavy_check_mark: | N/A | movie |
|
||||||
| `viewMode` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 65592 |
|
| `viewMode` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 65592 |
|
||||||
| `mixedParents` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
|
| `mixedParents` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||||
| `metadata` | List<[GetLibraryItemsMetadata](../../models/operations/GetLibraryItemsMetadata.md)> | :heavy_check_mark: | N/A | |
|
| `metadata` | List<[GetLibraryItemsMetadata](../../models/operations/GetLibraryItemsMetadata.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `meta` | [Optional<Meta>](../../models/operations/Meta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
| `meta` | [Optional<GetLibraryItemsMeta>](../../models/operations/GetLibraryItemsMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||||
8
docs/models/operations/GetLibraryItemsMediaGuid.md
Normal file
8
docs/models/operations/GetLibraryItemsMediaGuid.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# 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 |
|
||||||
12
docs/models/operations/GetLibraryItemsMeta.md
Normal file
12
docs/models/operations/GetLibraryItemsMeta.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibraryItemsMeta
|
||||||
|
|
||||||
|
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `type` | List<[GetLibraryItemsLibraryResponseType](../../models/operations/GetLibraryItemsLibraryResponseType.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `fieldType` | List<[GetLibraryItemsLibraryFieldType](../../models/operations/GetLibraryItemsLibraryFieldType.md)> | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/GetLibraryItemsMetaDataRating.md
Normal file
10
docs/models/operations/GetLibraryItemsMetaDataRating.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
@@ -10,7 +10,10 @@
|
|||||||
| `guid` | *String* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
| `guid` | *String* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||||
| `studio` | *Optional<String>* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
| `studio` | *Optional<String>* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||||
| `skipChildren` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `skipChildren` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
| `type` | [GetLibraryItemsType](../../models/operations/GetLibraryItemsType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
| `librarySectionID` | *Optional<Long>* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `librarySectionTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | Movies |
|
||||||
|
| `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 |
|
||||||
| `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 |
|
||||||
@@ -20,8 +23,8 @@
|
|||||||
| `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<FlattenSeasons>](../../models/operations/FlattenSeasons.md) | :heavy_minus_sign: | N/A | 1 |
|
| `flattenSeasons` | [Optional<GetLibraryItemsFlattenSeasons>](../../models/operations/GetLibraryItemsFlattenSeasons.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `showOrdering` | [Optional<ShowOrdering>](../../models/operations/ShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
|
| `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 |
|
||||||
| `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 |
|
||||||
@@ -38,6 +41,7 @@
|
|||||||
| `grandparentKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
| `grandparentKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||||
| `grandparentTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | Caprica |
|
| `grandparentTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | Caprica |
|
||||||
| `grandparentThumb` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
| `grandparentThumb` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||||
|
| `parentSlug` | *Optional<String>* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||||
| `grandparentSlug` | *Optional<String>* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
| `grandparentSlug` | *Optional<String>* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||||
| `grandparentArt` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
| `grandparentArt` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||||
| `grandparentTheme` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
| `grandparentTheme` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||||
@@ -46,10 +50,12 @@
|
|||||||
| `country` | List<[GetLibraryItemsCountry](../../models/operations/GetLibraryItemsCountry.md)> | :heavy_minus_sign: | N/A | |
|
| `country` | List<[GetLibraryItemsCountry](../../models/operations/GetLibraryItemsCountry.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `director` | List<[GetLibraryItemsDirector](../../models/operations/GetLibraryItemsDirector.md)> | :heavy_minus_sign: | N/A | |
|
| `director` | List<[GetLibraryItemsDirector](../../models/operations/GetLibraryItemsDirector.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `writer` | List<[GetLibraryItemsWriter](../../models/operations/GetLibraryItemsWriter.md)> | :heavy_minus_sign: | N/A | |
|
| `writer` | List<[GetLibraryItemsWriter](../../models/operations/GetLibraryItemsWriter.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `collection` | List<[Collection](../../models/operations/Collection.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 | |
|
||||||
| `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/> | |
|
| `location` | List<[GetLibraryItemsLocation](../../models/operations/GetLibraryItemsLocation.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `ultraBlurColors` | [Optional<UltraBlurColors>](../../models/operations/UltraBlurColors.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/> | |
|
||||||
|
| `ultraBlurColors` | [Optional<GetLibraryItemsUltraBlurColors>](../../models/operations/GetLibraryItemsUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `metaDataRating` | List<[GetLibraryItemsMetaDataRating](../../models/operations/GetLibraryItemsMetaDataRating.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 |
|
||||||
|
|||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibraryItemsOptimizedForStreaming
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
@@ -7,11 +7,14 @@
|
|||||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *int* | :heavy_check_mark: | N/A | 119542 |
|
| `id` | *int* | :heavy_check_mark: | N/A | 119542 |
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
| `key` | *String* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||||
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
|
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
||||||
| `file` | *String* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
| `file` | *String* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||||
| `size` | *long* | :heavy_check_mark: | N/A | 36158371307 |
|
| `size` | *long* | :heavy_check_mark: | N/A | 36158371307 |
|
||||||
| `container` | *String* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
| `container` | *String* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
||||||
| `audioProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | dts |
|
| `audioProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | dts |
|
||||||
| `videoProfile` | *String* | :heavy_check_mark: | N/A | main 10 |
|
| `has64bitOffsets` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `optimizedForStreaming` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `videoProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | main 10 |
|
||||||
| `indexes` | *Optional<String>* | :heavy_minus_sign: | N/A | sd |
|
| `indexes` | *Optional<String>* | :heavy_minus_sign: | N/A | sd |
|
||||||
| `hasThumbnail` | [Optional<HasThumbnail>](../../models/operations/HasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
| `hasThumbnail` | [Optional<GetLibraryItemsHasThumbnail>](../../models/operations/GetLibraryItemsHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `stream` | List<[GetLibraryItemsStream](../../models/operations/GetLibraryItemsStream.md)> | :heavy_minus_sign: | N/A | |
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibraryItemsQueryParamIncludeMeta
|
||||||
|
|
||||||
|
Adds the Meta object to the response
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
19
docs/models/operations/GetLibraryItemsQueryParamType.md
Normal file
19
docs/models/operations/GetLibraryItemsQueryParamType.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# GetLibraryItemsQueryParamType
|
||||||
|
|
||||||
|
The type of media to retrieve.
|
||||||
|
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 |
|
||||||
@@ -5,10 +5,10 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| 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 |
|
|
||||||
| `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 |
|
||||||
| `includeMeta` | [Optional<IncludeMeta>](../../models/operations/IncludeMeta.md) | :heavy_minus_sign: | Adds the Meta 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` | [Optional<Type>](../../models/operations/Type.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 |
|
| `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 |
|
||||||
| `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 |
|
||||||
| `xPlexContainerSize` | *Optional<Integer>* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
| `xPlexContainerSize` | *Optional<Integer>* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
||||||
@@ -4,5 +4,10 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Sigourney Weaver |
|
| `id` | *Optional<Long>* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 |
|
||||||
|
| `filter` | *Optional<String>* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 |
|
||||||
|
| `thumb` | *Optional<String>* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
|
||||||
|
| `tag` | *Optional<String>* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
|
||||||
|
| `tagKey` | *Optional<String>* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
|
||||||
|
| `role` | *Optional<String>* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |
|
||||||
20
docs/models/operations/GetLibraryItemsShowOrdering.md
Normal file
20
docs/models/operations/GetLibraryItemsShowOrdering.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# GetLibraryItemsShowOrdering
|
||||||
|
|
||||||
|
Setting that indicates the episode ordering for the show
|
||||||
|
None = Library default,
|
||||||
|
tmdbAiring = The Movie Database (Aired),
|
||||||
|
aired = TheTVDB (Aired),
|
||||||
|
dvd = TheTVDB (DVD),
|
||||||
|
absolute = TheTVDB (Absolute)).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `None` | None |
|
||||||
|
| `TmdbAiring` | tmdbAiring |
|
||||||
|
| `Aired` | aired |
|
||||||
|
| `Dvd` | dvd |
|
||||||
|
| `Absolute` | absolute |
|
||||||
@@ -4,11 +4,11 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||||
| `default_` | *Optional<String>* | :heavy_minus_sign: | N/A | asc |
|
| `default_` | *Optional<String>* | :heavy_minus_sign: | N/A | asc |
|
||||||
| `active` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `active` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
| `activeDirection` | [Optional<ActiveDirection>](../../models/operations/ActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
| `activeDirection` | [Optional<GetLibraryItemsActiveDirection>](../../models/operations/GetLibraryItemsActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||||
| `defaultDirection` | [Optional<DefaultDirection>](../../models/operations/DefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
| `defaultDirection` | [Optional<GetLibraryItemsDefaultDirection>](../../models/operations/GetLibraryItemsDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||||
| `descKey` | *Optional<String>* | :heavy_minus_sign: | N/A | titleSort:desc |
|
| `descKey` | *Optional<String>* | :heavy_minus_sign: | N/A | titleSort:desc |
|
||||||
| `firstCharacterKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
| `firstCharacterKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | titleSort |
|
| `key` | *String* | :heavy_check_mark: | N/A | titleSort |
|
||||||
|
|||||||
45
docs/models/operations/GetLibraryItemsStream.md
Normal file
45
docs/models/operations/GetLibraryItemsStream.md
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
# GetLibraryItemsStream
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | N/A | 272796 |
|
||||||
|
| `streamType` | *long* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
|
||||||
|
| `default_` | *Optional<Boolean>* | :heavy_minus_sign: | Indicates if this is the default stream | true |
|
||||||
|
| `selected` | *Optional<Boolean>* | :heavy_minus_sign: | Indicates if the stream is selected | true |
|
||||||
|
| `codec` | *String* | :heavy_check_mark: | Codec used by the stream | h264 |
|
||||||
|
| `index` | *long* | :heavy_check_mark: | The index of the stream | 0 |
|
||||||
|
| `bitrate` | *Optional<Long>* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
|
||||||
|
| `colorPrimaries` | *Optional<String>* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
|
||||||
|
| `colorRange` | *Optional<String>* | :heavy_minus_sign: | The color range of the video stream | tv |
|
||||||
|
| `colorSpace` | *Optional<String>* | :heavy_minus_sign: | The color space of the video stream | bt709 |
|
||||||
|
| `colorTrc` | *Optional<String>* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
|
||||||
|
| `bitDepth` | *Optional<Long>* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
|
||||||
|
| `chromaLocation` | *Optional<String>* | :heavy_minus_sign: | The chroma location of the video stream | left |
|
||||||
|
| `streamIdentifier` | *Optional<String>* | :heavy_minus_sign: | The identifier of the video stream | 2 |
|
||||||
|
| `chromaSubsampling` | *Optional<String>* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
|
||||||
|
| `codedHeight` | *Optional<Long>* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
|
||||||
|
| `codedWidth` | *Optional<Long>* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
|
||||||
|
| `frameRate` | *Optional<Double>* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
|
||||||
|
| `hasScalingMatrix` | *Optional<Boolean>* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
|
||||||
|
| `hearingImpaired` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `closedCaptions` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `embeddedInVideo` | *Optional<String>* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `height` | *Optional<Long>* | :heavy_minus_sign: | The height of the video stream | 1080 |
|
||||||
|
| `level` | *Optional<Long>* | :heavy_minus_sign: | The level of the video codec | 40 |
|
||||||
|
| `profile` | *Optional<String>* | :heavy_minus_sign: | The profile of the video codec | main |
|
||||||
|
| `refFrames` | *Optional<Long>* | :heavy_minus_sign: | Number of reference frames | 4 |
|
||||||
|
| `scanType` | *Optional<String>* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
|
||||||
|
| `width` | *Optional<Long>* | :heavy_minus_sign: | The width of the video stream | 1920 |
|
||||||
|
| `displayTitle` | *Optional<String>* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
|
||||||
|
| `extendedDisplayTitle` | *Optional<String>* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
|
||||||
|
| `channels` | *Optional<Long>* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
|
||||||
|
| `language` | *Optional<String>* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
|
||||||
|
| `languageTag` | *Optional<String>* | :heavy_minus_sign: | Language tag of the stream | en |
|
||||||
|
| `languageCode` | *Optional<String>* | :heavy_minus_sign: | Language code of the stream | eng |
|
||||||
|
| `audioChannelLayout` | *Optional<String>* | :heavy_minus_sign: | The audio channel layout | stereo |
|
||||||
|
| `samplingRate` | *Optional<Long>* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
|
||||||
|
| `title` | *Optional<String>* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
|
||||||
|
| `canAutoSync` | *Optional<Boolean>* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |
|
||||||
@@ -1,14 +1,14 @@
|
|||||||
# GetLibraryItemsType
|
# GetLibraryItemsType
|
||||||
|
|
||||||
The type of media content
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
## Values
|
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||||
| Name | Value |
|
| `type` | *String* | :heavy_check_mark: | N/A | show |
|
||||||
| --------- | --------- |
|
| `title` | *String* | :heavy_check_mark: | N/A | TV Shows |
|
||||||
| `Movie` | movie |
|
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||||
| `TvShow` | show |
|
| `filter` | List<[GetLibraryItemsFilter](../../models/operations/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `Season` | season |
|
| `sort` | List<[GetLibraryItemsSort](../../models/operations/GetLibraryItemsSort.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `Episode` | episode |
|
| `field` | List<[GetLibraryItemsField](../../models/operations/GetLibraryItemsField.md)> | :heavy_minus_sign: | N/A | |
|
||||||
11
docs/models/operations/GetLibraryItemsUltraBlurColors.md
Normal file
11
docs/models/operations/GetLibraryItemsUltraBlurColors.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibraryItemsUltraBlurColors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `topLeft` | *String* | :heavy_check_mark: | N/A | 11333b |
|
||||||
|
| `topRight` | *String* | :heavy_check_mark: | N/A | 0a232d |
|
||||||
|
| `bottomRight` | *String* | :heavy_check_mark: | N/A | 73958 |
|
||||||
|
| `bottomLeft` | *String* | :heavy_check_mark: | N/A | 1f5066 |
|
||||||
@@ -4,5 +4,5 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||||
| `xPlexToken` | *String* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
|
| `xPlexToken` | *String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
|
||||||
@@ -4,7 +4,7 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 15 |
|
| `id` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 15 |
|
||||||
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 |
|
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 |
|
||||||
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 141417 |
|
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 141417 |
|
||||||
@@ -15,4 +15,4 @@
|
|||||||
| `has64bitOffsets` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `has64bitOffsets` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
| `optimizedForStreaming` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `optimizedForStreaming` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
| `videoProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | high |
|
| `videoProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | high |
|
||||||
| `stream` | List<[Stream](../../models/operations/Stream.md)> | :heavy_minus_sign: | N/A | |
|
| `stream` | List<[GetMetaDataByRatingKeyStream](../../models/operations/GetMetaDataByRatingKeyStream.md)> | :heavy_minus_sign: | N/A | |
|
||||||
39
docs/models/operations/GetMetaDataByRatingKeyStream.md
Normal file
39
docs/models/operations/GetMetaDataByRatingKeyStream.md
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
# GetMetaDataByRatingKeyStream
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| `id` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 29 |
|
||||||
|
| `streamType` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2 |
|
||||||
|
| `default_` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `codec` | *Optional<String>* | :heavy_minus_sign: | N/A | aac |
|
||||||
|
| `index` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 0 |
|
||||||
|
| `bitrate` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 128 |
|
||||||
|
| `bitDepth` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 8 |
|
||||||
|
| `chromaLocation` | *Optional<String>* | :heavy_minus_sign: | N/A | left |
|
||||||
|
| `chromaSubsampling` | *Optional<String>* | :heavy_minus_sign: | N/A | 14520 |
|
||||||
|
| `codedHeight` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 816 |
|
||||||
|
| `codedWidth` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1920 |
|
||||||
|
| `colorPrimaries` | *Optional<String>* | :heavy_minus_sign: | N/A | bt709 |
|
||||||
|
| `colorRange` | *Optional<String>* | :heavy_minus_sign: | N/A | tv |
|
||||||
|
| `colorSpace` | *Optional<String>* | :heavy_minus_sign: | N/A | bt709 |
|
||||||
|
| `colorTrc` | *Optional<String>* | :heavy_minus_sign: | N/A | bt709 |
|
||||||
|
| `frameRate` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 24 |
|
||||||
|
| `hasScalingMatrix` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `height` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 814 |
|
||||||
|
| `level` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 40 |
|
||||||
|
| `profile` | *Optional<String>* | :heavy_minus_sign: | N/A | lc |
|
||||||
|
| `refFrames` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 4 |
|
||||||
|
| `scanType` | *Optional<String>* | :heavy_minus_sign: | N/A | progressive |
|
||||||
|
| `streamIdentifier` | *Optional<String>* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `width` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1920 |
|
||||||
|
| `displayTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | English (AAC Stereo) |
|
||||||
|
| `extendedDisplayTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | English (AAC Stereo) |
|
||||||
|
| `selected` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `channels` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2 |
|
||||||
|
| `language` | *Optional<String>* | :heavy_minus_sign: | N/A | English |
|
||||||
|
| `languageTag` | *Optional<String>* | :heavy_minus_sign: | N/A | en |
|
||||||
|
| `languageCode` | *Optional<String>* | :heavy_minus_sign: | N/A | eng |
|
||||||
|
| `samplingRate` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 44100 |
|
||||||
@@ -15,7 +15,7 @@
|
|||||||
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Season 2 |
|
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Season 2 |
|
||||||
| `parentKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/30072 |
|
| `parentKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/30072 |
|
||||||
| `parentTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | Reacher |
|
| `parentTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | Reacher |
|
||||||
| `summary` | *Optional<String>* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge. |
|
| `summary` | *Optional<String>* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge. |
|
||||||
| `index` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2 |
|
| `index` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2 |
|
||||||
| `parentIndex` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
| `parentIndex` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `viewCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 11 |
|
| `viewCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 11 |
|
||||||
|
|||||||
@@ -6,7 +6,8 @@
|
|||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `strong` | *Optional<Boolean>* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
|
| `strong` | *Optional<Boolean>* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
|
||||||
| `clientName` | *Optional<String>* | :heavy_minus_sign: | N/A | Plex Web |
|
| `clientID` | *Optional<String>* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||||
| `deviceName` | *Optional<String>* | :heavy_minus_sign: | N/A | Linux |
|
| `clientName` | *Optional<String>* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
|
||||||
| `clientVersion` | *Optional<String>* | :heavy_minus_sign: | N/A | 4.133.0 |
|
| `deviceNickname` | *Optional<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||||
| `clientPlatform` | *Optional<String>* | :heavy_minus_sign: | N/A | Chrome |
|
| `clientVersion` | *Optional<String>* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
|
||||||
|
| `platform` | *Optional<String>* | :heavy_minus_sign: | The platform of the client application. | Roku |
|
||||||
12
docs/models/operations/GetRecentlyAddedActiveDirection.md
Normal file
12
docs/models/operations/GetRecentlyAddedActiveDirection.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetRecentlyAddedActiveDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
12
docs/models/operations/GetRecentlyAddedDefaultDirection.md
Normal file
12
docs/models/operations/GetRecentlyAddedDefaultDirection.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetRecentlyAddedDefaultDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
11
docs/models/operations/GetRecentlyAddedField.md
Normal file
11
docs/models/operations/GetRecentlyAddedField.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetRecentlyAddedField
|
||||||
|
|
||||||
|
|
||||||
|
## 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/GetRecentlyAddedFieldType.md
Normal file
9
docs/models/operations/GetRecentlyAddedFieldType.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetRecentlyAddedFieldType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||||
|
| `type` | *String* | :heavy_check_mark: | N/A | tag |
|
||||||
|
| `operator` | List<[GetRecentlyAddedOperator](../../models/operations/GetRecentlyAddedOperator.md)> | :heavy_check_mark: | N/A | |
|
||||||
12
docs/models/operations/GetRecentlyAddedFilter.md
Normal file
12
docs/models/operations/GetRecentlyAddedFilter.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetRecentlyAddedFilter
|
||||||
|
|
||||||
|
|
||||||
|
## 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 |
|
||||||
11
docs/models/operations/GetRecentlyAddedHubsResponseType.md
Normal file
11
docs/models/operations/GetRecentlyAddedHubsResponseType.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetRecentlyAddedHubsResponseType
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| -------------- | -------------- |
|
||||||
|
| `COVER_POSTER` | coverPoster |
|
||||||
|
| `BACKGROUND` | background |
|
||||||
|
| `SNAPSHOT` | snapshot |
|
||||||
|
| `CLEAR_LOGO` | clearLogo |
|
||||||
14
docs/models/operations/GetRecentlyAddedHubsType.md
Normal file
14
docs/models/operations/GetRecentlyAddedHubsType.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# GetRecentlyAddedHubsType
|
||||||
|
|
||||||
|
The type of media content
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Movie` | movie |
|
||||||
|
| `TvShow` | show |
|
||||||
|
| `Season` | season |
|
||||||
|
| `Episode` | episode |
|
||||||
10
docs/models/operations/GetRecentlyAddedImage.md
Normal file
10
docs/models/operations/GetRecentlyAddedImage.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetRecentlyAddedImage
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||||
|
| `alt` | *String* | :heavy_check_mark: | N/A | Episode 1 |
|
||||||
|
| `type` | [GetRecentlyAddedHubsResponseType](../../models/operations/GetRecentlyAddedHubsResponseType.md) | :heavy_check_mark: | N/A | background |
|
||||||
|
| `url` | *String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||||
8
docs/models/operations/GetRecentlyAddedLibraryCountry.md
Normal file
8
docs/models/operations/GetRecentlyAddedLibraryCountry.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetRecentlyAddedLibraryCountry
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||||
|
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | United States of America |
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# GetRecentlyAddedLibraryDirector
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Peyton Reed |
|
||||||
12
docs/models/operations/GetRecentlyAddedLibraryFilter.md
Normal file
12
docs/models/operations/GetRecentlyAddedLibraryFilter.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetRecentlyAddedLibraryFilter
|
||||||
|
|
||||||
|
|
||||||
|
## 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 |
|
||||||
8
docs/models/operations/GetRecentlyAddedLibraryGenre.md
Normal file
8
docs/models/operations/GetRecentlyAddedLibraryGenre.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetRecentlyAddedLibraryGenre
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Comedy |
|
||||||
23
docs/models/operations/GetRecentlyAddedLibraryMedia.md
Normal file
23
docs/models/operations/GetRecentlyAddedLibraryMedia.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# GetRecentlyAddedLibraryMedia
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *Optional<Double>* | :heavy_minus_sign: | N/A | 120345 |
|
||||||
|
| `duration` | *Optional<Double>* | :heavy_minus_sign: | N/A | 7474422 |
|
||||||
|
| `bitrate` | *Optional<Double>* | :heavy_minus_sign: | N/A | 3623 |
|
||||||
|
| `width` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1920 |
|
||||||
|
| `height` | *Optional<Double>* | :heavy_minus_sign: | N/A | 804 |
|
||||||
|
| `aspectRatio` | *Optional<Double>* | :heavy_minus_sign: | N/A | 2.35 |
|
||||||
|
| `audioChannels` | *Optional<Double>* | :heavy_minus_sign: | N/A | 6 |
|
||||||
|
| `audioCodec` | *Optional<String>* | :heavy_minus_sign: | N/A | ac3 |
|
||||||
|
| `videoCodec` | *Optional<String>* | :heavy_minus_sign: | N/A | h264 |
|
||||||
|
| `videoResolution` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1080 |
|
||||||
|
| `container` | *Optional<String>* | :heavy_minus_sign: | N/A | mp4 |
|
||||||
|
| `videoFrameRate` | *Optional<String>* | :heavy_minus_sign: | N/A | 24p |
|
||||||
|
| `optimizedForStreaming` | *Optional<Double>* | :heavy_minus_sign: | N/A | 0 |
|
||||||
|
| `has64bitOffsets` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `videoProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | high |
|
||||||
|
| `part` | List<[GetRecentlyAddedLibraryPart](../../models/operations/GetRecentlyAddedLibraryPart.md)> | :heavy_minus_sign: | N/A | |
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
# GetRecentlyAddedLibraryMediaContainer
|
||||||
|
|
||||||
|
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||||
|
| `type` | List<[GetRecentlyAddedLibraryType](../../models/operations/GetRecentlyAddedLibraryType.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `fieldType` | List<[FieldType](../../models/operations/FieldType.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `size` | *Optional<Double>* | :heavy_minus_sign: | N/A | 50 |
|
||||||
|
| `allowSync` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `identifier` | *Optional<String>* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||||
|
| `mediaTagPrefix` | *Optional<String>* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||||
|
| `mediaTagVersion` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1680021154 |
|
||||||
|
| `mixedParents` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `metadata` | List<[GetRecentlyAddedLibraryMetadata](../../models/operations/GetRecentlyAddedLibraryMetadata.md)> | :heavy_minus_sign: | N/A | |
|
||||||
39
docs/models/operations/GetRecentlyAddedLibraryMetadata.md
Normal file
39
docs/models/operations/GetRecentlyAddedLibraryMetadata.md
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
# GetRecentlyAddedLibraryMetadata
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `allowSync` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `librarySectionID` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `librarySectionTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | Movies |
|
||||||
|
| `librarySectionUUID` | *Optional<String>* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||||
|
| `ratingKey` | *Optional<Double>* | :heavy_minus_sign: | N/A | 59398 |
|
||||||
|
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/59398 |
|
||||||
|
| `guid` | *Optional<String>* | :heavy_minus_sign: | N/A | plex://movie/5e161a83bea6ac004126e148 |
|
||||||
|
| `studio` | *Optional<String>* | :heavy_minus_sign: | N/A | Marvel Studios |
|
||||||
|
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | movie |
|
||||||
|
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Ant-Man and the Wasp: Quantumania |
|
||||||
|
| `contentRating` | *Optional<String>* | :heavy_minus_sign: | N/A | PG-13 |
|
||||||
|
| `summary` | *Optional<String>* | :heavy_minus_sign: | N/A | Scott Lang and Hope Van Dyne along with Hank Pym and Janet Van Dyne explore the Quantum Realm where they interact with strange creatures and embark on an adventure that goes beyond the limits of what they thought was possible. |
|
||||||
|
| `rating` | *Optional<Double>* | :heavy_minus_sign: | N/A | 4.7 |
|
||||||
|
| `audienceRating` | *Optional<Double>* | :heavy_minus_sign: | N/A | 8.3 |
|
||||||
|
| `year` | *Optional<Double>* | :heavy_minus_sign: | N/A | 2023 |
|
||||||
|
| `tagline` | *Optional<String>* | :heavy_minus_sign: | N/A | Witness the beginning of a new dynasty. |
|
||||||
|
| `thumb` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/59398/thumb/1681888010 |
|
||||||
|
| `art` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/59398/art/1681888010 |
|
||||||
|
| `duration` | *Optional<Double>* | :heavy_minus_sign: | N/A | 7474422 |
|
||||||
|
| `originallyAvailableAt` | [OffsetDateTime](https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html) | :heavy_minus_sign: | N/A | 2023-02-15 00:00:00 +0000 UTC |
|
||||||
|
| `addedAt` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1681803215 |
|
||||||
|
| `updatedAt` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1681888010 |
|
||||||
|
| `audienceRatingImage` | *Optional<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||||
|
| `chapterSource` | *Optional<String>* | :heavy_minus_sign: | N/A | media |
|
||||||
|
| `primaryExtraKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/59399 |
|
||||||
|
| `ratingImage` | *Optional<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.rotten |
|
||||||
|
| `media` | List<[GetRecentlyAddedLibraryMedia](../../models/operations/GetRecentlyAddedLibraryMedia.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `genre` | List<[GetRecentlyAddedLibraryGenre](../../models/operations/GetRecentlyAddedLibraryGenre.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `director` | List<[GetRecentlyAddedLibraryDirector](../../models/operations/GetRecentlyAddedLibraryDirector.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `writer` | List<[GetRecentlyAddedLibraryWriter](../../models/operations/GetRecentlyAddedLibraryWriter.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `country` | List<[GetRecentlyAddedLibraryCountry](../../models/operations/GetRecentlyAddedLibraryCountry.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `role` | List<[GetRecentlyAddedLibraryRole](../../models/operations/GetRecentlyAddedLibraryRole.md)> | :heavy_minus_sign: | N/A | |
|
||||||
17
docs/models/operations/GetRecentlyAddedLibraryPart.md
Normal file
17
docs/models/operations/GetRecentlyAddedLibraryPart.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetRecentlyAddedLibraryPart
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *Optional<Double>* | :heavy_minus_sign: | N/A | 120353 |
|
||||||
|
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/parts/120353/1681803203/file.mp4 |
|
||||||
|
| `duration` | *Optional<Double>* | :heavy_minus_sign: | N/A | 7474422 |
|
||||||
|
| `file` | *Optional<String>* | :heavy_minus_sign: | N/A | /movies/Ant-Man and the Wasp Quantumania (2023)/Ant-Man.and.the.Wasp.Quantumania.2023.1080p.mp4 |
|
||||||
|
| `size` | *Optional<Double>* | :heavy_minus_sign: | N/A | 3395307162 |
|
||||||
|
| `container` | *Optional<String>* | :heavy_minus_sign: | N/A | mp4 |
|
||||||
|
| `has64bitOffsets` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `hasThumbnail` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `optimizedForStreaming` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `videoProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | high |
|
||||||
14
docs/models/operations/GetRecentlyAddedLibraryRequest.md
Normal file
14
docs/models/operations/GetRecentlyAddedLibraryRequest.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# GetRecentlyAddedLibraryRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `contentDirectoryID` | *Optional<Long>* | :heavy_minus_sign: | N/A | 2 |
|
||||||
|
| `pinnedContentDirectoryID` | List<*long*> | :heavy_minus_sign: | N/A | [<br/>3,<br/>5,<br/>7,<br/>13,<br/>12,<br/>1,<br/>6,<br/>14,<br/>2,<br/>10,<br/>16,<br/>17<br/>] |
|
||||||
|
| `sectionID` | *Optional<Long>* | :heavy_minus_sign: | The library section ID for filtering content. | 2 |
|
||||||
|
| `type` | [QueryParamType](../../models/operations/QueryParamType.md) | :heavy_check_mark: | 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 |
|
||||||
|
| `includeMeta` | [Optional<QueryParamIncludeMeta>](../../models/operations/QueryParamIncludeMeta.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 |
|
||||||
|
| `xPlexContainerSize` | *Optional<Integer>* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
||||||
11
docs/models/operations/GetRecentlyAddedLibraryResponse.md
Normal file
11
docs/models/operations/GetRecentlyAddedLibraryResponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetRecentlyAddedLibraryResponse
|
||||||
|
|
||||||
|
|
||||||
|
## 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<GetRecentlyAddedLibraryResponseBody>](../../models/operations/GetRecentlyAddedLibraryResponseBody.md) | :heavy_minus_sign: | The recently added content |
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# GetRecentlyAddedLibraryResponseBody
|
||||||
|
|
||||||
|
The recently added content
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `mediaContainer` | [Optional<GetRecentlyAddedLibraryMediaContainer>](../../models/operations/GetRecentlyAddedLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||||
8
docs/models/operations/GetRecentlyAddedLibraryRole.md
Normal file
8
docs/models/operations/GetRecentlyAddedLibraryRole.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetRecentlyAddedLibraryRole
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Paul Rudd |
|
||||||
14
docs/models/operations/GetRecentlyAddedLibraryType.md
Normal file
14
docs/models/operations/GetRecentlyAddedLibraryType.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# GetRecentlyAddedLibraryType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||||
|
| `type` | *String* | :heavy_check_mark: | N/A | show |
|
||||||
|
| `title` | *String* | :heavy_check_mark: | N/A | TV Shows |
|
||||||
|
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||||
|
| `filter` | List<[GetRecentlyAddedLibraryFilter](../../models/operations/GetRecentlyAddedLibraryFilter.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `sort` | List<[Sort](../../models/operations/Sort.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `field` | List<[Field](../../models/operations/Field.md)> | :heavy_minus_sign: | N/A | |
|
||||||
8
docs/models/operations/GetRecentlyAddedLibraryWriter.md
Normal file
8
docs/models/operations/GetRecentlyAddedLibraryWriter.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetRecentlyAddedLibraryWriter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Jeff Loveness |
|
||||||
@@ -4,11 +4,11 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||||
| `size` | *Optional<Double>* | :heavy_minus_sign: | N/A | 50 |
|
| `size` | *double* | :heavy_check_mark: | N/A | 50 |
|
||||||
| `allowSync` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | |
|
| `offset` | *Optional<Integer>* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `totalSize` | *Optional<Integer>* | :heavy_minus_sign: | N/A | |
|
||||||
| `identifier` | *Optional<String>* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
| `identifier` | *Optional<String>* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||||
| `mediaTagPrefix` | *Optional<String>* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
| `allowSync` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | |
|
||||||
| `mediaTagVersion` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1680021154 |
|
| `meta` | [Optional<Meta>](../../models/operations/Meta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||||
| `mixedParents` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
||||||
| `metadata` | List<[GetRecentlyAddedMetadata](../../models/operations/GetRecentlyAddedMetadata.md)> | :heavy_minus_sign: | N/A | |
|
| `metadata` | List<[GetRecentlyAddedMetadata](../../models/operations/GetRecentlyAddedMetadata.md)> | :heavy_minus_sign: | N/A | |
|
||||||
@@ -4,36 +4,78 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `allowSync` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | |
|
| `ratingKey` | *String* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
|
||||||
| `librarySectionID` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1 |
|
| `key` | *String* | :heavy_check_mark: | N/A | /library/metadata/58683 |
|
||||||
|
| `guid` | *String* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||||
|
| `studio` | *Optional<String>* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||||
|
| `skipChildren` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `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 |
|
||||||
| `librarySectionUUID` | *Optional<String>* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
| `librarySectionKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||||
| `ratingKey` | *Optional<Double>* | :heavy_minus_sign: | N/A | 59398 |
|
| `type` | [GetRecentlyAddedHubsType](../../models/operations/GetRecentlyAddedHubsType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
||||||
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/59398 |
|
| `title` | *String* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||||
| `guid` | *Optional<String>* | :heavy_minus_sign: | N/A | plex://movie/5e161a83bea6ac004126e148 |
|
| `slug` | *Optional<String>* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||||
| `studio` | *Optional<String>* | :heavy_minus_sign: | N/A | Marvel Studios |
|
|
||||||
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | movie |
|
|
||||||
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Ant-Man and the Wasp: Quantumania |
|
|
||||||
| `contentRating` | *Optional<String>* | :heavy_minus_sign: | N/A | PG-13 |
|
| `contentRating` | *Optional<String>* | :heavy_minus_sign: | N/A | PG-13 |
|
||||||
| `summary` | *Optional<String>* | :heavy_minus_sign: | N/A | Scott Lang and Hope Van Dyne along with Hank Pym and Janet Van Dyne explore the Quantum Realm where they interact with strange creatures and embark on an adventure that goes beyond the limits of what they thought was possible. |
|
| `summary` | *String* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
||||||
| `rating` | *Optional<Double>* | :heavy_minus_sign: | N/A | 4.7 |
|
| `rating` | *Optional<Double>* | :heavy_minus_sign: | N/A | 7.6 |
|
||||||
| `audienceRating` | *Optional<Double>* | :heavy_minus_sign: | N/A | 8.3 |
|
| `audienceRating` | *Optional<Double>* | :heavy_minus_sign: | N/A | 9.2 |
|
||||||
| `year` | *Optional<Double>* | :heavy_minus_sign: | N/A | 2023 |
|
| `year` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
||||||
| `tagline` | *Optional<String>* | :heavy_minus_sign: | N/A | Witness the beginning of a new dynasty. |
|
| `seasonCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
||||||
| `thumb` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/59398/thumb/1681888010 |
|
| `tagline` | *Optional<String>* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||||
| `art` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/59398/art/1681888010 |
|
| `flattenSeasons` | [Optional<FlattenSeasons>](../../models/operations/FlattenSeasons.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `duration` | *Optional<Double>* | :heavy_minus_sign: | N/A | 7474422 |
|
| `showOrdering` | [Optional<ShowOrdering>](../../models/operations/ShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
|
||||||
| `originallyAvailableAt` | [OffsetDateTime](https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html) | :heavy_minus_sign: | N/A | 2023-02-15 00:00:00 +0000 UTC |
|
| `thumb` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||||
| `addedAt` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1681803215 |
|
| `art` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||||
| `updatedAt` | *Optional<Double>* | :heavy_minus_sign: | N/A | 1681888010 |
|
| `banner` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||||
|
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
||||||
|
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
||||||
|
| `addedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
|
| `updatedAt` | *Optional<Long>* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `audienceRatingImage` | *Optional<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
| `audienceRatingImage` | *Optional<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||||
| `chapterSource` | *Optional<String>* | :heavy_minus_sign: | N/A | media |
|
| `chapterSource` | *Optional<String>* | :heavy_minus_sign: | N/A | media |
|
||||||
| `primaryExtraKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/59399 |
|
| `primaryExtraKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||||
| `ratingImage` | *Optional<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.rotten |
|
| `ratingImage` | *Optional<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||||
| `media` | List<[Media](../../models/operations/Media.md)> | :heavy_minus_sign: | N/A | |
|
| `grandparentRatingKey` | *Optional<String>* | :heavy_minus_sign: | N/A | 66 |
|
||||||
|
| `grandparentGuid` | *Optional<String>* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
|
| `grandparentKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||||
|
| `grandparentTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | Caprica |
|
||||||
|
| `grandparentThumb` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||||
|
| `parentSlug` | *Optional<String>* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||||
|
| `grandparentSlug` | *Optional<String>* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||||
|
| `grandparentArt` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||||
|
| `grandparentTheme` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||||
|
| `media` | List<[Media](../../models/operations/Media.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
||||||
| `genre` | List<[Genre](../../models/operations/Genre.md)> | :heavy_minus_sign: | N/A | |
|
| `genre` | List<[Genre](../../models/operations/Genre.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `country` | List<[Country](../../models/operations/Country.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `director` | List<[Director](../../models/operations/Director.md)> | :heavy_minus_sign: | N/A | |
|
| `director` | List<[Director](../../models/operations/Director.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `writer` | List<[Writer](../../models/operations/Writer.md)> | :heavy_minus_sign: | N/A | |
|
| `writer` | List<[Writer](../../models/operations/Writer.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `country` | List<[Country](../../models/operations/Country.md)> | :heavy_minus_sign: | N/A | |
|
| `collection` | List<[Collection](../../models/operations/Collection.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `role` | List<[Role](../../models/operations/Role.md)> | :heavy_minus_sign: | N/A | |
|
| `role` | List<[Role](../../models/operations/Role.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `location` | List<[Location](../../models/operations/Location.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `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<UltraBlurColors>](../../models/operations/UltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `metaDataRating` | List<[MetaDataRating](../../models/operations/MetaDataRating.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `image` | List<[GetRecentlyAddedImage](../../models/operations/GetRecentlyAddedImage.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `titleSort` | *Optional<String>* | :heavy_minus_sign: | N/A | Whale |
|
||||||
|
| `viewCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `lastViewedAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||||
|
| `originalTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
||||||
|
| `viewOffset` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 5222500 |
|
||||||
|
| `skipCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `index` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `theme` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
||||||
|
| `leafCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 14 |
|
||||||
|
| `viewedLeafCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 0 |
|
||||||
|
| `childCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `hasPremiumExtras` | *Optional<String>* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `hasPremiumPrimaryExtra` | *Optional<String>* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `parentRatingKey` | *Optional<String>* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
||||||
|
| `parentGuid` | *Optional<String>* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
|
| `parentStudio` | *Optional<String>* | :heavy_minus_sign: | N/A | UCP |
|
||||||
|
| `parentKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||||
|
| `parentTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | Caprica |
|
||||||
|
| `parentIndex` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `parentYear` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2010 |
|
||||||
|
| `parentThumb` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||||
|
| `parentTheme` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||||
9
docs/models/operations/GetRecentlyAddedOperator.md
Normal file
9
docs/models/operations/GetRecentlyAddedOperator.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetRecentlyAddedOperator
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | N/A | = |
|
||||||
|
| `title` | *String* | :heavy_check_mark: | N/A | is |
|
||||||
@@ -5,5 +5,10 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `contentDirectoryID` | *long* | :heavy_check_mark: | The content directory ID. | |
|
||||||
|
| `pinnedContentDirectoryID` | *Optional<String>* | :heavy_minus_sign: | Comma-separated list of pinned content directory IDs. | |
|
||||||
|
| `sectionID` | *Optional<Long>* | :heavy_minus_sign: | The library section ID for filtering content. | 2 |
|
||||||
|
| `type` | [Type](../../models/operations/Type.md) | :heavy_check_mark: | 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 |
|
||||||
|
| `includeMeta` | [Optional<IncludeMeta>](../../models/operations/IncludeMeta.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 |
|
||||||
| `xPlexContainerSize` | *Optional<Integer>* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
| `xPlexContainerSize` | *Optional<Integer>* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
||||||
@@ -8,4 +8,4 @@
|
|||||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code 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 |
|
| `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<GetRecentlyAddedResponseBody>](../../models/operations/GetRecentlyAddedResponseBody.md) | :heavy_minus_sign: | The recently added content |
|
| `object` | [Optional<GetRecentlyAddedResponseBody>](../../models/operations/GetRecentlyAddedResponseBody.md) | :heavy_minus_sign: | A successful response with recently added content. |
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# GetRecentlyAddedResponseBody
|
# GetRecentlyAddedResponseBody
|
||||||
|
|
||||||
The recently added content
|
A successful response with recently added content.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
15
docs/models/operations/GetRecentlyAddedSort.md
Normal file
15
docs/models/operations/GetRecentlyAddedSort.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# GetRecentlyAddedSort
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `default_` | *Optional<String>* | :heavy_minus_sign: | N/A | asc |
|
||||||
|
| `active` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `activeDirection` | [Optional<GetRecentlyAddedActiveDirection>](../../models/operations/GetRecentlyAddedActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||||
|
| `defaultDirection` | [Optional<GetRecentlyAddedDefaultDirection>](../../models/operations/GetRecentlyAddedDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||||
|
| `descKey` | *Optional<String>* | :heavy_minus_sign: | N/A | titleSort:desc |
|
||||||
|
| `firstCharacterKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | N/A | titleSort |
|
||||||
|
| `title` | *String* | :heavy_check_mark: | N/A | Title |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user