mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 20:47:45 +00:00
Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
8100bcbf96 | ||
|
|
10a61122c2 | ||
|
|
fbca010d26 |
File diff suppressed because one or more lines are too long
@@ -12,7 +12,7 @@ generation:
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
java:
|
||||
version: 0.4.1
|
||||
version: 0.6.1
|
||||
additionalDependencies: []
|
||||
additionalPlugins: []
|
||||
artifactID: plexapi
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.401.2
|
||||
speakeasyVersion: 1.404.5
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
@@ -8,8 +8,8 @@ sources:
|
||||
- latest
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:fc6eebe661455e23b1aa352a91c14ef773fa72331330ec4caeddc2c460dc16bb
|
||||
sourceBlobDigest: sha256:2e81e86c83d7f4e8842efca0d43a2db84a4932534c8439e3737e1f65c873f855
|
||||
sourceRevisionDigest: sha256:ed1af8e79d553cc0bf2f8f7975f445d80cb8bd58390bca18d1352577da5ec5ed
|
||||
sourceBlobDigest: sha256:157db2a169209c18fdca786b671c5da8d2b14dc3005574d08c9d667320869093
|
||||
tags:
|
||||
- latest
|
||||
- main
|
||||
@@ -17,10 +17,10 @@ targets:
|
||||
plexjava:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:fc6eebe661455e23b1aa352a91c14ef773fa72331330ec4caeddc2c460dc16bb
|
||||
sourceBlobDigest: sha256:2e81e86c83d7f4e8842efca0d43a2db84a4932534c8439e3737e1f65c873f855
|
||||
sourceRevisionDigest: sha256:ed1af8e79d553cc0bf2f8f7975f445d80cb8bd58390bca18d1352577da5ec5ed
|
||||
sourceBlobDigest: sha256:157db2a169209c18fdca786b671c5da8d2b14dc3005574d08c9d667320869093
|
||||
codeSamplesNamespace: code-samples-java-plexjava
|
||||
codeSamplesRevisionDigest: sha256:0206006395b8e85b824f653a9a582e1949fe4f57636a54ea65105c11c0cc0018
|
||||
codeSamplesRevisionDigest: sha256:e01f78cd36aeb5eb46235c59f38fe7c81fa8b7b0b56fb76cf9c56af914f8e3a5
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
|
||||
34
README.md
34
README.md
@@ -12,6 +12,31 @@
|
||||
## Summary
|
||||
|
||||
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
||||
|
||||
# Plex Media Server OpenAPI Specification
|
||||
|
||||
An Open Source OpenAPI Specification for Plex Media Server
|
||||
|
||||
Automation and SDKs provided by [Speakeasy](https://speakeasyapi.dev/)
|
||||
|
||||
## Documentation
|
||||
|
||||
[API Documentation](https://plexapi.dev)
|
||||
|
||||
## SDKs
|
||||
|
||||
The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the [main specification Repository](https://github.com/LukeHagar/plex-api-spec).
|
||||
|
||||
| Language | Repository | Releases | Other |
|
||||
| --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
|
||||
| Python | [GitHub](https://github.com/LukeHagar/plexpy) | [PyPI](https://pypi.org/project/plex-api-client/) | - |
|
||||
| JavaScript/TypeScript | [GitHub](https://github.com/LukeHagar/plexjs) | [NPM](https://www.npmjs.com/package/@lukehagar/plexjs) \ [JSR](https://jsr.io/@lukehagar/plexjs) | - |
|
||||
| Go | [GitHub](https://github.com/LukeHagar/plexgo) | [Releases](https://github.com/LukeHagar/plexgo/releases) | [GoDoc](https://pkg.go.dev/github.com/LukeHagar/plexgo) |
|
||||
| Ruby | [GitHub](https://github.com/LukeHagar/plexruby) | [Releases](https://github.com/LukeHagar/plexruby/releases) | - |
|
||||
| Swift | [GitHub](https://github.com/LukeHagar/plexswift) | [Releases](https://github.com/LukeHagar/plexswift/releases) | - |
|
||||
| PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - |
|
||||
| Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - |
|
||||
| C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -
|
||||
<!-- End Summary [summary] -->
|
||||
|
||||
<!-- Start Table of Contents [toc] -->
|
||||
@@ -37,7 +62,7 @@ The samples below show how a published SDK artifact is used:
|
||||
|
||||
Gradle:
|
||||
```groovy
|
||||
implementation 'dev.plexapi:plexapi:0.4.1'
|
||||
implementation 'dev.plexapi:plexapi:0.6.1'
|
||||
```
|
||||
|
||||
Maven:
|
||||
@@ -45,7 +70,7 @@ Maven:
|
||||
<dependency>
|
||||
<groupId>dev.plexapi</groupId>
|
||||
<artifactId>plexapi</artifactId>
|
||||
<version>0.4.1</version>
|
||||
<version>0.6.1</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
@@ -131,12 +156,13 @@ public class Application {
|
||||
### [hubs()](docs/sdks/hubs/README.md)
|
||||
|
||||
* [getGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
|
||||
* [getRecentlyAdded](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
|
||||
* [getLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
||||
|
||||
### [library()](docs/sdks/library/README.md)
|
||||
|
||||
* [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||
* [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
|
||||
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||
@@ -457,7 +483,7 @@ public class Application {
|
||||
.build();
|
||||
|
||||
GetCompanionsDataResponse res = sdk.plex().getCompanionsData()
|
||||
.serverURL("https://plex.tv/api/v2/")
|
||||
.serverURL("https://plex.tv/api/v2")
|
||||
.call();
|
||||
|
||||
if (res.responseBodies().isPresent()) {
|
||||
|
||||
30
RELEASES.md
30
RELEASES.md
@@ -89,3 +89,33 @@ Based on:
|
||||
- [java v0.4.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.4.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.4.1 - .
|
||||
|
||||
## 2024-09-26 00:25:07
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.402.14 (2.422.22) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.5.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.5.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.5.0 - .
|
||||
|
||||
## 2024-09-28 00:25:08
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.404.5 (2.426.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.6.0] .
|
||||
### Releases
|
||||
- [Maven Central v0.6.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.6.0 - .
|
||||
|
||||
## 2024-09-29 00:28:35
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.404.5 (2.426.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [java v0.6.1] .
|
||||
### Releases
|
||||
- [Maven Central v0.6.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.6.1 - .
|
||||
@@ -63,7 +63,7 @@ tasks.withType(Javadoc) {
|
||||
}
|
||||
|
||||
group = "dev.plexapi"
|
||||
version = "0.4.1"
|
||||
version = "0.6.1"
|
||||
|
||||
sourcesJar {
|
||||
archiveBaseName = "plexapi"
|
||||
@@ -101,7 +101,7 @@ publishing {
|
||||
maven(MavenPublication) {
|
||||
groupId = 'dev.plexapi'
|
||||
artifactId = 'plexapi'
|
||||
version = '0.4.1'
|
||||
version = '0.6.1'
|
||||
|
||||
from components.java
|
||||
|
||||
@@ -152,6 +152,9 @@ dependencies {
|
||||
implementation 'org.apache.httpcomponents:httpclient:4.5.14'
|
||||
implementation 'org.apache.httpcomponents:httpmime:4.5.14'
|
||||
implementation 'commons-io:commons-io:2.15.1'
|
||||
testImplementation 'org.junit.jupiter:junit-jupiter:5.10.2'
|
||||
testImplementation 'org.mockito:mockito-core:5.12.0'
|
||||
testRuntimeOnly 'org.junit.platform:junit-platform-launcher:1.10.2'
|
||||
}
|
||||
|
||||
|
||||
|
||||
121
codeSamples.yaml
121
codeSamples.yaml
@@ -708,6 +708,52 @@ actions:
|
||||
.onlyTransient(OnlyTransient.ONE)
|
||||
.call();
|
||||
|
||||
if (res.object().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
}
|
||||
- target: $["paths"]["/hubs/home/recentlyAdded"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: java
|
||||
label: added
|
||||
source: |-
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.plexapi.PlexAPI;
|
||||
import dev.plexapi.plexapi.models.operations.GetRecentlyAddedRequest;
|
||||
import dev.plexapi.plexapi.models.operations.GetRecentlyAddedResponse;
|
||||
import dev.plexapi.plexapi.models.operations.IncludeMeta;
|
||||
import dev.plexapi.plexapi.models.operations.Type;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) throws Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
.clientID("gcgzw5rz2xovp84b4vha3a40")
|
||||
.clientName("Plex Web")
|
||||
.clientVersion("4.133.0")
|
||||
.clientPlatform("Chrome")
|
||||
.deviceName("Linux")
|
||||
.build();
|
||||
|
||||
GetRecentlyAddedRequest req = GetRecentlyAddedRequest.builder()
|
||||
.contentDirectoryID(470161L)
|
||||
.type(Type.TvShow)
|
||||
.sectionID(2L)
|
||||
.includeMeta(IncludeMeta.Enable)
|
||||
.xPlexContainerStart(0)
|
||||
.xPlexContainerSize(50)
|
||||
.build();
|
||||
|
||||
GetRecentlyAddedResponse res = sdk.hubs().getRecentlyAdded()
|
||||
.request(req)
|
||||
.call();
|
||||
|
||||
if (res.object().isPresent()) {
|
||||
// handle response
|
||||
}
|
||||
@@ -742,7 +788,7 @@ actions:
|
||||
|
||||
PerformSearchResponse res = sdk.search().performSearch()
|
||||
.query("dylan")
|
||||
.sectionId(5838.67d)
|
||||
.sectionId(9372.69d)
|
||||
.limit(5d)
|
||||
.call();
|
||||
|
||||
@@ -1134,19 +1180,23 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: java
|
||||
label: getRecentlyAdded
|
||||
label: library
|
||||
source: |-
|
||||
package hello.world;
|
||||
|
||||
import dev.plexapi.plexapi.PlexAPI;
|
||||
import dev.plexapi.plexapi.models.errors.GetRecentlyAddedBadRequest;
|
||||
import dev.plexapi.plexapi.models.errors.GetRecentlyAddedUnauthorized;
|
||||
import dev.plexapi.plexapi.models.operations.GetRecentlyAddedResponse;
|
||||
import dev.plexapi.plexapi.models.errors.GetRecentlyAddedLibraryBadRequest;
|
||||
import dev.plexapi.plexapi.models.errors.GetRecentlyAddedLibraryUnauthorized;
|
||||
import dev.plexapi.plexapi.models.operations.GetRecentlyAddedLibraryRequest;
|
||||
import dev.plexapi.plexapi.models.operations.GetRecentlyAddedLibraryResponse;
|
||||
import dev.plexapi.plexapi.models.operations.QueryParamIncludeMeta;
|
||||
import dev.plexapi.plexapi.models.operations.QueryParamType;
|
||||
import java.lang.Exception;
|
||||
import java.util.List;
|
||||
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) throws GetRecentlyAddedBadRequest, GetRecentlyAddedUnauthorized, Exception {
|
||||
public static void main(String[] args) throws GetRecentlyAddedLibraryBadRequest, GetRecentlyAddedLibraryUnauthorized, Exception {
|
||||
|
||||
PlexAPI sdk = PlexAPI.builder()
|
||||
.accessToken("<YOUR_API_KEY_HERE>")
|
||||
@@ -1157,9 +1207,30 @@ actions:
|
||||
.deviceName("Linux")
|
||||
.build();
|
||||
|
||||
GetRecentlyAddedResponse res = sdk.library().getRecentlyAdded()
|
||||
GetRecentlyAddedLibraryRequest req = GetRecentlyAddedLibraryRequest.builder()
|
||||
.type(QueryParamType.TvShow)
|
||||
.contentDirectoryID(2L)
|
||||
.pinnedContentDirectoryID(List.of(
|
||||
3L,
|
||||
5L,
|
||||
7L,
|
||||
13L,
|
||||
12L,
|
||||
1L,
|
||||
6L,
|
||||
14L,
|
||||
2L,
|
||||
10L,
|
||||
16L,
|
||||
17L))
|
||||
.sectionID(2L)
|
||||
.includeMeta(QueryParamIncludeMeta.Enable)
|
||||
.xPlexContainerStart(0)
|
||||
.xPlexContainerSize(50)
|
||||
.build();
|
||||
|
||||
GetRecentlyAddedLibraryResponse res = sdk.library().getRecentlyAddedLibrary()
|
||||
.request(req)
|
||||
.call();
|
||||
|
||||
if (res.object().isPresent()) {
|
||||
@@ -1366,8 +1437,8 @@ actions:
|
||||
import dev.plexapi.plexapi.PlexAPI;
|
||||
import dev.plexapi.plexapi.models.errors.GetSearchLibraryBadRequest;
|
||||
import dev.plexapi.plexapi.models.errors.GetSearchLibraryUnauthorized;
|
||||
import dev.plexapi.plexapi.models.operations.GetSearchLibraryQueryParamType;
|
||||
import dev.plexapi.plexapi.models.operations.GetSearchLibraryResponse;
|
||||
import dev.plexapi.plexapi.models.operations.QueryParamType;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -1385,7 +1456,7 @@ actions:
|
||||
|
||||
GetSearchLibraryResponse res = sdk.library().getSearchLibrary()
|
||||
.sectionKey(9518)
|
||||
.type(QueryParamType.TvShow)
|
||||
.type(GetSearchLibraryQueryParamType.TvShow)
|
||||
.call();
|
||||
|
||||
if (res.object().isPresent()) {
|
||||
@@ -1404,12 +1475,12 @@ actions:
|
||||
import dev.plexapi.plexapi.PlexAPI;
|
||||
import dev.plexapi.plexapi.models.errors.GetLibraryItemsBadRequest;
|
||||
import dev.plexapi.plexapi.models.errors.GetLibraryItemsUnauthorized;
|
||||
import dev.plexapi.plexapi.models.operations.GetLibraryItemsQueryParamIncludeMeta;
|
||||
import dev.plexapi.plexapi.models.operations.GetLibraryItemsQueryParamType;
|
||||
import dev.plexapi.plexapi.models.operations.GetLibraryItemsRequest;
|
||||
import dev.plexapi.plexapi.models.operations.GetLibraryItemsResponse;
|
||||
import dev.plexapi.plexapi.models.operations.IncludeGuids;
|
||||
import dev.plexapi.plexapi.models.operations.IncludeMeta;
|
||||
import dev.plexapi.plexapi.models.operations.Tag;
|
||||
import dev.plexapi.plexapi.models.operations.Type;
|
||||
import java.lang.Exception;
|
||||
|
||||
public class Application {
|
||||
@@ -1429,8 +1500,8 @@ actions:
|
||||
.sectionKey(9518)
|
||||
.tag(Tag.EDITION)
|
||||
.includeGuids(IncludeGuids.Enable)
|
||||
.includeMeta(IncludeMeta.Enable)
|
||||
.type(Type.TvShow)
|
||||
.type(GetLibraryItemsQueryParamType.TvShow)
|
||||
.includeMeta(GetLibraryItemsQueryParamIncludeMeta.Enable)
|
||||
.xPlexContainerStart(0)
|
||||
.xPlexContainerSize(50)
|
||||
.build();
|
||||
@@ -1657,8 +1728,8 @@ actions:
|
||||
.width(110d)
|
||||
.height(165d)
|
||||
.opacity(100L)
|
||||
.blur(0d)
|
||||
.minSize(MinSize.ONE)
|
||||
.blur(20d)
|
||||
.minSize(MinSize.ZERO)
|
||||
.upscale(Upscale.ONE)
|
||||
.url("/library/metadata/49564/thumb/1654258204")
|
||||
.build();
|
||||
@@ -1719,6 +1790,7 @@ actions:
|
||||
import dev.plexapi.plexapi.PlexAPI;
|
||||
import dev.plexapi.plexapi.models.errors.GetTokenByPinIdBadRequest;
|
||||
import dev.plexapi.plexapi.models.errors.GetTokenByPinIdResponseBody;
|
||||
import dev.plexapi.plexapi.models.operations.GetTokenByPinIdRequest;
|
||||
import dev.plexapi.plexapi.models.operations.GetTokenByPinIdResponse;
|
||||
import java.lang.Exception;
|
||||
|
||||
@@ -1734,8 +1806,12 @@ actions:
|
||||
.deviceName("Linux")
|
||||
.build();
|
||||
|
||||
GetTokenByPinIdResponse res = sdk.plex().getTokenByPinId()
|
||||
GetTokenByPinIdRequest req = GetTokenByPinIdRequest.builder()
|
||||
.pinID(408895L)
|
||||
.build();
|
||||
|
||||
GetTokenByPinIdResponse res = sdk.plex().getTokenByPinId()
|
||||
.request(req)
|
||||
.call();
|
||||
|
||||
if (res.authPinContainer().isPresent()) {
|
||||
@@ -2186,7 +2262,7 @@ actions:
|
||||
.build();
|
||||
|
||||
GetSourceConnectionInformationResponse res = sdk.authentication().getSourceConnectionInformation()
|
||||
.source("provider://provider-identifier")
|
||||
.source("server://client-identifier")
|
||||
.call();
|
||||
|
||||
// handle response
|
||||
@@ -2670,6 +2746,7 @@ actions:
|
||||
import dev.plexapi.plexapi.PlexAPI;
|
||||
import dev.plexapi.plexapi.models.errors.PostUsersSignInDataBadRequest;
|
||||
import dev.plexapi.plexapi.models.errors.PostUsersSignInDataUnauthorized;
|
||||
import dev.plexapi.plexapi.models.operations.PostUsersSignInDataRequest;
|
||||
import dev.plexapi.plexapi.models.operations.PostUsersSignInDataRequestBody;
|
||||
import dev.plexapi.plexapi.models.operations.PostUsersSignInDataResponse;
|
||||
import java.lang.Exception;
|
||||
@@ -2686,10 +2763,12 @@ actions:
|
||||
.deviceName("Linux")
|
||||
.build();
|
||||
|
||||
PostUsersSignInDataRequestBody req = PostUsersSignInDataRequestBody.builder()
|
||||
.login("username@email.com")
|
||||
.password("password123")
|
||||
.verificationCode("123456")
|
||||
PostUsersSignInDataRequest req = PostUsersSignInDataRequest.builder()
|
||||
.requestBody(PostUsersSignInDataRequestBody.builder()
|
||||
.login("username@email.com")
|
||||
.password("password123")
|
||||
.verificationCode("123456")
|
||||
.build())
|
||||
.build();
|
||||
|
||||
PostUsersSignInDataResponse res = sdk.authentication().postUsersSignInData()
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetRecentlyAddedErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,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
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## 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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||
10
docs/models/errors/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 |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetRecentlyAddedBadRequest
|
||||
# GetRecentlyAddedLibraryUnauthorized
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List<[GetRecentlyAddedErrors](../../models/errors/GetRecentlyAddedErrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| `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 |
|
||||
@@ -3,12 +3,12 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `protocol` | [Protocol](../../models/operations/Protocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) |
|
||||
| `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 |
|
||||
| `uri` | *String* | :heavy_check_mark: | The full URI of the connection |
|
||||
| `local` | *boolean* | :heavy_check_mark: | If the connection is local address |
|
||||
| `relay` | *boolean* | :heavy_check_mark: | If the connection is relayed through plex.direct |
|
||||
| `iPv6` | *boolean* | :heavy_check_mark: | If the connection is using IPv6 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `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 | |
|
||||
| `port` | *int* | :heavy_check_mark: | The port used for the connection | |
|
||||
| `uri` | *String* | :heavy_check_mark: | The full URI of the connection | |
|
||||
| `local` | *boolean* | :heavy_check_mark: | If the connection is local address | |
|
||||
| `relay` | *boolean* | :heavy_check_mark: | If the connection is relayed through plex.direct | |
|
||||
| `iPv6` | *boolean* | :heavy_check_mark: | If the connection is using IPv6 | |
|
||||
@@ -5,4 +5,4 @@
|
||||
|
||||
| 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 |
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
| 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 |
|
||||
| `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 |
|
||||
@@ -5,5 +5,5 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | resolution |
|
||||
| `operator` | List<[Operator](../../models/operations/Operator.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `type` | *String* | :heavy_check_mark: | N/A | tag |
|
||||
| `operator` | List<[Operator](../../models/operations/Operator.md)> | :heavy_check_mark: | N/A | |
|
||||
@@ -5,4 +5,4 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Comedy |
|
||||
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Adventure |
|
||||
@@ -23,6 +23,6 @@
|
||||
| `scannedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `content` | *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 |
|
||||
| `location` | List<[Location](../../models/operations/Location.md)> | :heavy_check_mark: | N/A | |
|
||||
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 |
|
||||
| `directory` | List<[GetLibraryDetailsDirectory](../../models/operations/GetLibraryDetailsDirectory.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 |
|
||||
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 |
|
||||
| `active` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `filter` | List<[GetLibraryDetailsFilter](../../models/operations/GetLibraryDetailsFilter.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 | |
|
||||
| `sort` | List<[GetLibraryDetailsSort](../../models/operations/GetLibraryDetailsSort.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 |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `alt` | *String* | :heavy_check_mark: | N/A | Episode 1 |
|
||||
| `type` | [GetLibraryItemsLibraryResponseType](../../models/operations/GetLibraryItemsLibraryResponseType.md) | :heavy_check_mark: | N/A | background |
|
||||
| `url` | *String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `alt` | *String* | :heavy_check_mark: | N/A | Episode 1 |
|
||||
| `type` | [GetLibraryItemsLibraryResponse200Type](../../models/operations/GetLibraryItemsLibraryResponse200Type.md) | :heavy_check_mark: | N/A | background |
|
||||
| `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
|
||||
|
||||
|
||||
## Values
|
||||
## Fields
|
||||
|
||||
| Name | Value |
|
||||
| -------------- | -------------- |
|
||||
| `COVER_POSTER` | coverPoster |
|
||||
| `BACKGROUND` | background |
|
||||
| `SNAPSHOT` | snapshot |
|
||||
| `CLEAR_LOGO` | clearLogo |
|
||||
| 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<[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
|
||||
|
||||
The type of media content
|
||||
|
||||
## 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<[GetLibraryItemsFilter](../../models/operations/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | List<[GetLibraryItemsSort](../../models/operations/GetLibraryItemsSort.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `field` | List<[GetLibraryItemsField](../../models/operations/GetLibraryItemsField.md)> | :heavy_minus_sign: | N/A | |
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
@@ -3,21 +3,23 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
|
||||
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `bitrate` | *int* | :heavy_check_mark: | N/A | 25025 |
|
||||
| `width` | *int* | :heavy_check_mark: | N/A | 3840 |
|
||||
| `height` | *int* | :heavy_check_mark: | N/A | 2072 |
|
||||
| `aspectRatio` | *double* | :heavy_check_mark: | N/A | 1.85 |
|
||||
| `audioProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | dts |
|
||||
| `audioChannels` | *int* | :heavy_check_mark: | N/A | 6 |
|
||||
| `audioCodec` | *String* | :heavy_check_mark: | N/A | eac3 |
|
||||
| `videoCodec` | *String* | :heavy_check_mark: | N/A | hevc |
|
||||
| `videoResolution` | *String* | :heavy_check_mark: | N/A | 4k |
|
||||
| `container` | *String* | :heavy_check_mark: | N/A | mkv |
|
||||
| `videoFrameRate` | *String* | :heavy_check_mark: | N/A | 24p |
|
||||
| `videoProfile` | *String* | :heavy_check_mark: | N/A | main 10 |
|
||||
| `hasVoiceActivity` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `part` | List<[GetLibraryItemsPart](../../models/operations/GetLibraryItemsPart.md)> | :heavy_check_mark: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
|
||||
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `bitrate` | *int* | :heavy_check_mark: | N/A | 25025 |
|
||||
| `width` | *int* | :heavy_check_mark: | N/A | 3840 |
|
||||
| `height` | *int* | :heavy_check_mark: | N/A | 2072 |
|
||||
| `aspectRatio` | *double* | :heavy_check_mark: | N/A | 1.85 |
|
||||
| `audioProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | dts |
|
||||
| `audioChannels` | *int* | :heavy_check_mark: | N/A | 6 |
|
||||
| `audioCodec` | *String* | :heavy_check_mark: | N/A | eac3 |
|
||||
| `videoCodec` | *String* | :heavy_check_mark: | N/A | hevc |
|
||||
| `videoResolution` | *String* | :heavy_check_mark: | N/A | 4k |
|
||||
| `container` | *String* | :heavy_check_mark: | N/A | mkv |
|
||||
| `videoFrameRate` | *String* | :heavy_check_mark: | N/A | 24p |
|
||||
| `videoProfile` | *String* | :heavy_check_mark: | N/A | main 10 |
|
||||
| `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 | |
|
||||
@@ -1,10 +1,15 @@
|
||||
# GetLibraryItemsMediaContainer
|
||||
|
||||
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<[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 |
|
||||
| `totalSize` | *int* | :heavy_check_mark: | N/A | 170 |
|
||||
| `offset` | *int* | :heavy_check_mark: | N/A | 0 |
|
||||
@@ -13,7 +18,7 @@
|
||||
| `nocache` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||
| `art` | *String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `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 |
|
||||
| `librarySectionUUID` | *String* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `mediaTagPrefix` | *String* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
||||
@@ -25,4 +30,4 @@
|
||||
| `viewMode` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 65592 |
|
||||
| `mixedParents` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||
| `metadata` | List<[GetLibraryItemsMetadata](../../models/operations/GetLibraryItemsMetadata.md)> | :heavy_check_mark: | 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 |
|
||||
| `studio` | *Optional<String>* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||
| `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 |
|
||||
| `slug` | *Optional<String>* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||
| `contentRating` | *Optional<String>* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
@@ -20,8 +23,8 @@
|
||||
| `year` | *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. |
|
||||
| `flattenSeasons` | [Optional<FlattenSeasons>](../../models/operations/FlattenSeasons.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 |
|
||||
| `flattenSeasons` | [Optional<GetLibraryItemsFlattenSeasons>](../../models/operations/GetLibraryItemsFlattenSeasons.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `showOrdering` | [Optional<GetLibraryItemsShowOrdering>](../../models/operations/GetLibraryItemsShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
@@ -46,10 +50,11 @@
|
||||
| `country` | List<[GetLibraryItemsCountry](../../models/operations/GetLibraryItemsCountry.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 | |
|
||||
| `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 | |
|
||||
| `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 | |
|
||||
| `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 | |
|
||||
| `titleSort` | *Optional<String>* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `viewCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetLibraryItemsOptimizedForStreaming
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
@@ -12,6 +12,9 @@
|
||||
| `size` | *long* | :heavy_check_mark: | N/A | 36158371307 |
|
||||
| `container` | *String* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
||||
| `audioProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | dts |
|
||||
| `has64bitOffsets` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `videoProfile` | *String* | :heavy_check_mark: | N/A | main 10 |
|
||||
| `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 |
|
||||
@@ -8,7 +8,7 @@
|
||||
| `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. | |
|
||||
| `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<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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
@@ -3,6 +3,11 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *Optional<String>* | :heavy_minus_sign: | N/A | Sigourney Weaver |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `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 |
|
||||
@@ -3,13 +3,13 @@
|
||||
|
||||
## 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<ActiveDirection>](../../models/operations/ActiveDirection.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 |
|
||||
| `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 |
|
||||
| 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<GetLibraryItemsActiveDirection>](../../models/operations/GetLibraryItemsActiveDirection.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 |
|
||||
| `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 |
|
||||
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
|
||||
|
||||
The type of media content
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| 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<[GetLibraryItemsFilter](../../models/operations/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | List<[GetLibraryItemsSort](../../models/operations/GetLibraryItemsSort.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `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 |
|
||||
@@ -3,16 +3,16 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
|
||||
| `id` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 15 |
|
||||
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 |
|
||||
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `file` | *Optional<String>* | :heavy_minus_sign: | N/A | /movies/Serenity (2005)/Serenity (2005).mp4 |
|
||||
| `size` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 40271948 |
|
||||
| `audioProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | lc |
|
||||
| `container` | *Optional<String>* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `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 | high |
|
||||
| `stream` | List<[Stream](../../models/operations/Stream.md)> | :heavy_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `id` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 15 |
|
||||
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 |
|
||||
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `file` | *Optional<String>* | :heavy_minus_sign: | N/A | /movies/Serenity (2005)/Serenity (2005).mp4 |
|
||||
| `size` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 40271948 |
|
||||
| `audioProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | lc |
|
||||
| `container` | *Optional<String>* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `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 | high |
|
||||
| `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 |
|
||||
@@ -3,10 +3,11 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| 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/> | |
|
||||
| `clientName` | *Optional<String>* | :heavy_minus_sign: | N/A | Plex Web |
|
||||
| `deviceName` | *Optional<String>* | :heavy_minus_sign: | N/A | Linux |
|
||||
| `clientVersion` | *Optional<String>* | :heavy_minus_sign: | N/A | 4.133.0 |
|
||||
| `clientPlatform` | *Optional<String>* | :heavy_minus_sign: | N/A | Chrome |
|
||||
| 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/> | |
|
||||
| `clientID` | *Optional<String>* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
|
||||
| `clientName` | *Optional<String>* | :heavy_minus_sign: | N/A | Plex Web |
|
||||
| `deviceName` | *Optional<String>* | :heavy_minus_sign: | N/A | Linux |
|
||||
| `clientVersion` | *Optional<String>* | :heavy_minus_sign: | N/A | 4.133.0 |
|
||||
| `clientPlatform` | *Optional<String>* | :heavy_minus_sign: | N/A | Chrome |
|
||||
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 |
|
||||
@@ -3,12 +3,12 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `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<[GetRecentlyAddedMetadata](../../models/operations/GetRecentlyAddedMetadata.md)> | :heavy_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `size` | *double* | :heavy_check_mark: | N/A | 50 |
|
||||
| `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 |
|
||||
| `allowSync` | *Optional<Boolean>* | :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/> | |
|
||||
| `metadata` | List<[GetRecentlyAddedMetadata](../../models/operations/GetRecentlyAddedMetadata.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -3,37 +3,78 @@
|
||||
|
||||
## 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<[Media](../../models/operations/Media.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | List<[Genre](../../models/operations/Genre.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 | |
|
||||
| `country` | List<[Country](../../models/operations/Country.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | List<[Role](../../models/operations/Role.md)> | :heavy_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `librarySectionKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||
| `type` | [GetRecentlyAddedHubsType](../../models/operations/GetRecentlyAddedHubsType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
||||
| `title` | *String* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||
| `slug` | *Optional<String>* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||
| `contentRating` | *Optional<String>* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `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 | 7.6 |
|
||||
| `audienceRating` | *Optional<Double>* | :heavy_minus_sign: | N/A | 9.2 |
|
||||
| `year` | *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. |
|
||||
| `flattenSeasons` | [Optional<FlattenSeasons>](../../models/operations/FlattenSeasons.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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `chapterSource` | *Optional<String>* | :heavy_minus_sign: | N/A | media |
|
||||
| `primaryExtraKey` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||
| `ratingImage` | *Optional<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `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 | |
|
||||
| `country` | List<[Country](../../models/operations/Country.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 | |
|
||||
| `collection` | List<[Collection](../../models/operations/Collection.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | List<[Role](../../models/operations/Role.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 |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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<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
|
||||
|
||||
The recently added content
|
||||
A successful response with recently added content.
|
||||
|
||||
|
||||
## 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 |
|
||||
14
docs/models/operations/GetRecentlyAddedType.md
Normal file
14
docs/models/operations/GetRecentlyAddedType.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# GetRecentlyAddedType
|
||||
|
||||
|
||||
## 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<[GetRecentlyAddedFilter](../../models/operations/GetRecentlyAddedFilter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | List<[GetRecentlyAddedSort](../../models/operations/GetRecentlyAddedSort.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `field` | List<[GetRecentlyAddedField](../../models/operations/GetRecentlyAddedField.md)> | :heavy_minus_sign: | N/A | |
|
||||
19
docs/models/operations/GetSearchLibraryQueryParamType.md
Normal file
19
docs/models/operations/GetSearchLibraryQueryParamType.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# GetSearchLibraryQueryParamType
|
||||
|
||||
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 |
|
||||
@@ -6,4 +6,4 @@
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `type` | [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 |
|
||||
| `type` | [GetSearchLibraryQueryParamType](../../models/operations/GetSearchLibraryQueryParamType.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 |
|
||||
@@ -3,6 +3,11 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
|
||||
| `pinID` | *long* | :heavy_check_mark: | The PinID to retrieve an access token for |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `pinID` | *long* | :heavy_check_mark: | The PinID to retrieve an access token for | |
|
||||
| `clientID` | *Optional<String>* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
|
||||
| `clientName` | *Optional<String>* | :heavy_minus_sign: | N/A | Plex Web |
|
||||
| `deviceName` | *Optional<String>* | :heavy_minus_sign: | N/A | Linux |
|
||||
| `clientVersion` | *Optional<String>* | :heavy_minus_sign: | N/A | 4.133.0 |
|
||||
| `clientPlatform` | *Optional<String>* | :heavy_minus_sign: | N/A | Chrome |
|
||||
@@ -29,7 +29,7 @@ Logged in user details
|
||||
| `joinedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `locale` | *Optional<String>* | :heavy_check_mark: | The account locale | |
|
||||
| `mailingListActive` | *Optional<Boolean>* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
|
||||
| `mailingListStatus` | [MailingListStatus](../../models/operations/MailingListStatus.md) | :heavy_check_mark: | Your current mailing list status | |
|
||||
| `mailingListStatus` | [MailingListStatus](../../models/operations/MailingListStatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active |
|
||||
| `maxHomeSize` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
|
||||
| ~~`pin`~~ | *Optional<String>* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
|
||||
| `profile` | [UserProfile](../../models/operations/UserProfile.md) | :heavy_check_mark: | N/A | |
|
||||
|
||||
@@ -1,2 +0,0 @@
|
||||
# LibrarySectionID
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# MailingListStatus
|
||||
|
||||
Your current mailing list status
|
||||
Your current mailing list status (active or unsubscribed)
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
@@ -3,21 +3,23 @@
|
||||
|
||||
## 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<[Part](../../models/operations/Part.md)> | :heavy_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
|
||||
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `bitrate` | *int* | :heavy_check_mark: | N/A | 25025 |
|
||||
| `width` | *int* | :heavy_check_mark: | N/A | 3840 |
|
||||
| `height` | *int* | :heavy_check_mark: | N/A | 2072 |
|
||||
| `aspectRatio` | *double* | :heavy_check_mark: | N/A | 1.85 |
|
||||
| `audioProfile` | *Optional<String>* | :heavy_minus_sign: | N/A | dts |
|
||||
| `audioChannels` | *int* | :heavy_check_mark: | N/A | 6 |
|
||||
| `audioCodec` | *String* | :heavy_check_mark: | N/A | eac3 |
|
||||
| `videoCodec` | *String* | :heavy_check_mark: | N/A | hevc |
|
||||
| `videoResolution` | *String* | :heavy_check_mark: | N/A | 4k |
|
||||
| `container` | *String* | :heavy_check_mark: | N/A | mkv |
|
||||
| `videoFrameRate` | *String* | :heavy_check_mark: | N/A | 24p |
|
||||
| `videoProfile` | *String* | :heavy_check_mark: | N/A | main 10 |
|
||||
| `hasVoiceActivity` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | [Optional<OptimizedForStreaming>](../../models/operations/OptimizedForStreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `has64bitOffsets` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `part` | List<[Part](../../models/operations/Part.md)> | :heavy_check_mark: | N/A | |
|
||||
@@ -6,7 +6,7 @@ The Meta object is only included in the response if the `includeMeta` parameter
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `type` | List<[GetLibraryItemsLibraryType](../../models/operations/GetLibraryItemsLibraryType.md)> | :heavy_minus_sign: | N/A |
|
||||
| `fieldType` | List<[GetLibraryItemsFieldType](../../models/operations/GetLibraryItemsFieldType.md)> | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `type` | List<[GetRecentlyAddedType](../../models/operations/GetRecentlyAddedType.md)> | :heavy_minus_sign: | N/A |
|
||||
| `fieldType` | List<[GetRecentlyAddedFieldType](../../models/operations/GetRecentlyAddedFieldType.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/MetaDataRating.md
Normal file
10
docs/models/operations/MetaDataRating.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# MetaDataRating
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -5,5 +5,5 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | = |
|
||||
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | is |
|
||||
| `key` | *String* | :heavy_check_mark: | N/A | = |
|
||||
| `title` | *String* | :heavy_check_mark: | N/A | is |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user